ApiKeyAuthModel Class
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.
Constructor
ApiKeyAuthModel(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
api_key
|
API Key for the user secret key credential. Required. |
|
api_key_name
|
API Key name. Required. |
|
api_key_identifier
|
API Key Identifier. |
|
is_api_key_in_post_payload
|
Flag to indicate if API key is set in HTTP POST payload. |
|
type
|
str or
<xref:azure.mgmt.securityinsight.models.API_KEY>
The auth type. Required. APIKey. |
Attributes
api_key
API Key for the user secret key credential. Required.
api_key: str
api_key_identifier
API Key Identifier.
api_key_identifier: str | None
api_key_name
API Key name. Required.
api_key_name: str
is_api_key_in_post_payload
Flag to indicate if API key is set in HTTP POST payload.
is_api_key_in_post_payload: bool | None
type
The auth type. Required. APIKey.
type: API_KEY: 'APIKey'>]