ApiKeyAuthModelArgs

data class ApiKeyAuthModelArgs(val apiKey: Output<String>, val apiKeyIdentifier: Output<String>? = null, val apiKeyName: Output<String>, val isApiKeyInPostPayload: Output<Boolean>? = null, val type: Output<String>) : ConvertibleToJava<ApiKeyAuthModelArgs>

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.

Constructors

Link copied to clipboard
constructor(apiKey: Output<String>, apiKeyIdentifier: Output<String>? = null, apiKeyName: Output<String>, isApiKeyInPostPayload: Output<Boolean>? = null, type: Output<String>)

Properties

Link copied to clipboard
val apiKey: Output<String>

API Key for the user secret key credential

Link copied to clipboard
val apiKeyIdentifier: Output<String>? = null

API Key Identifier

Link copied to clipboard
val apiKeyName: Output<String>

API Key name

Link copied to clipboard
val isApiKeyInPostPayload: Output<Boolean>? = null

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

Link copied to clipboard
val type: Output<String>

Type of paging Expected value is 'APIKey'.

Functions

Link copied to clipboard
open override fun toJava(): ApiKeyAuthModelArgs