Share via


JwtAuthModel Class

Definition

Model for API authentication with JWT. Simple exchange between user name + password to access token.

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

Constructors

JwtAuthModel(String, IDictionary<String,String>, IDictionary<String,String>)

Initializes a new instance of JwtAuthModel.

Properties

Headers

The custom headers we want to add once we send request to token endpoint.

IsCredentialsInHeaders

Flag indicating whether we want to send the user name and password to token endpoint in the headers.

IsJsonRequest

Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).

Password

The password.

QueryParameters

The custom query parameter we want to add once we send request to token endpoint.

RequestTimeoutInSeconds

Request timeout in seconds.

TokenEndpoint

Token endpoint to request JWT.

UserName

The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and 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<JwtAuthModel>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<JwtAuthModel>.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<JwtAuthModel>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<JwtAuthModel>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<JwtAuthModel>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to