ApiKeyAuthModel interface

Package:

@azure/arm-securityinsight

Model for authentication with the API Key. Will result in additional header on the request (default behavior) to the remote server: 'ApiKeyName: ApiKeyIdentifier ApiKey'. If 'IsApiKeyInPostPayload' is true it will send it in the body of the request and not the header.

Extends

CcpAuthConfig

Properties

apiKey	API Key for the user secret key credential
apiKeyIdentifier	API Key Identifier
apiKeyName	API Key name
isApiKeyInPostPayload	Flag to indicate if API key is set in HTTP POST payload
type	The auth type

Property Details

apiKey

API Key for the user secret key credential

apiKey: string

Property Value

string

apiKeyIdentifier

API Key Identifier

apiKeyIdentifier?: string

Property Value

string

apiKeyName

API Key name

apiKeyName: string

Property Value

string

isApiKeyInPostPayload

Flag to indicate if API key is set in HTTP POST payload

isApiKeyInPostPayload?: boolean

Property Value

boolean

type

The auth type

type: "APIKey"

Property Value

"APIKey"