Share via


CodelessConnectorPollingAuthProperties Class

Definition

Describe the authentication properties needed to successfully authenticate with the server.

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

Constructors

CodelessConnectorPollingAuthProperties(String)

Initializes a new instance of CodelessConnectorPollingAuthProperties.

Properties

ApiKeyIdentifier

A prefix send in the header before the actual token.

ApiKeyName

The header name which the token is sent with.

AuthorizationEndpoint

The endpoint used to authorize the user, used in Oauth 2.0 flow.

AuthorizationEndpointQueryParameters

The query parameters used in authorization request, used in Oauth 2.0 flow

To assign an object to 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" }.

AuthType

The authentication type.

FlowName

Describes the flow name, for example 'AuthCode' for Oauth 2.0.

IsApiKeyInPostPayload

Marks if the key should sent in header.

IsClientSecretInHeader

Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow.

RedirectionEndpoint

The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow.

Scope

The OAuth token scope.

TokenEndpoint

The endpoint used to issue a token, used in Oauth 2.0 flow.

TokenEndpointHeaders

The query headers used in token request, used in Oauth 2.0 flow

To assign an object to 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" }.

TokenEndpointQueryParameters

The query parameters used in token request, used in Oauth 2.0 flow

To assign an object to 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" }.

Explicit Interface Implementations

IJsonModel<CodelessConnectorPollingAuthProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<CodelessConnectorPollingAuthProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CodelessConnectorPollingAuthProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CodelessConnectorPollingAuthProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<CodelessConnectorPollingAuthProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to