SessionAuthModel Class

Definition

Model for API authentication with session cookie.

public class SessionAuthModel : Azure.ResourceManager.SecurityInsights.Models.CcpAuthConfig, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.SecurityInsights.Models.SessionAuthModel>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.SecurityInsights.Models.SessionAuthModel>
type SessionAuthModel = class
    inherit CcpAuthConfig
    interface IJsonModel<SessionAuthModel>
    interface IPersistableModel<SessionAuthModel>
Public Class SessionAuthModel
Inherits CcpAuthConfig
Implements IJsonModel(Of SessionAuthModel), IPersistableModel(Of SessionAuthModel)
Inheritance
SessionAuthModel
Implements

Constructors

SessionAuthModel(IDictionary<String,String>, IDictionary<String,String>)

Initializes a new instance of SessionAuthModel.

Properties

Headers

HTTP request headers to session service endpoint.

IsPostPayloadJson

Indicating whether API key is set in HTTP POST payload.

Password

The password attribute name.

QueryParameters

Query parameters to session service endpoint.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

SessionIdName

Session id attribute name from HTTP response header.

SessionLoginRequestUri

HTTP request URL to session service endpoint.

SessionTimeoutInMinutes

Session timeout in minutes.

UserName

The user name attribute key value.

Explicit Interface Implementations

IJsonModel<CcpAuthConfig>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from CcpAuthConfig)
IJsonModel<CcpAuthConfig>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from CcpAuthConfig)
IJsonModel<SessionAuthModel>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SessionAuthModel>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CcpAuthConfig>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from CcpAuthConfig)
IPersistableModel<CcpAuthConfig>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from CcpAuthConfig)
IPersistableModel<CcpAuthConfig>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from CcpAuthConfig)
IPersistableModel<SessionAuthModel>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SessionAuthModel>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SessionAuthModel>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to