CodelessConnectorPollingAuthProperties interface

Package:

@azure/arm-securityinsight

Describe the authentication properties needed to successfully authenticate with the server

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
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
tokenEndpointQueryParameters	The query parameters used in token request, used in Oauth 2.0 flow

Property Details

apiKeyIdentifier

A prefix send in the header before the actual token

apiKeyIdentifier?: string

Property Value

string

apiKeyName

The header name which the token is sent with

apiKeyName?: string

Property Value

string

authorizationEndpoint

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

authorizationEndpoint?: string

Property Value

string

authorizationEndpointQueryParameters

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

authorizationEndpointQueryParameters?: Record<string, unknown>

Property Value

Record<string, unknown>

authType

The authentication type

authType: string

Property Value

string

flowName

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

flowName?: string

Property Value

string

isApiKeyInPostPayload

Marks if the key should sent in header

isApiKeyInPostPayload?: string

Property Value

string

isClientSecretInHeader

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

isClientSecretInHeader?: boolean

Property Value

boolean

redirectionEndpoint

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

redirectionEndpoint?: string

Property Value

string

scope

The OAuth token scope

scope?: string

Property Value

string

tokenEndpoint

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

tokenEndpoint?: string

Property Value

string

tokenEndpointHeaders

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

tokenEndpointHeaders?: Record<string, unknown>

Property Value

Record<string, unknown>

tokenEndpointQueryParameters

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

tokenEndpointQueryParameters?: Record<string, unknown>

Property Value

Record<string, unknown>