ApiKeyAuthModelResponse

data class ApiKeyAuthModelResponse(val apiKey: String, val apiKeyIdentifier: String? = null, val apiKeyName: String, val isApiKeyInPostPayload: Boolean? = null, val type: String)

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: String, apiKeyIdentifier: String? = null, apiKeyName: String, isApiKeyInPostPayload: Boolean? = null, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

API Key for the user secret key credential

Link copied to clipboard

API Key Identifier

Link copied to clipboard

API Key name

Link copied to clipboard

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

Link copied to clipboard

Type of paging Expected value is 'APIKey'.