JwtAuthModelResponse

data class JwtAuthModelResponse(val headers: Map<String, String>? = null, val isCredentialsInHeaders: Boolean? = null, val isJsonRequest: Boolean? = null, val password: Map<String, String>, val queryParameters: Map<String, String>? = null, val requestTimeoutInSeconds: Int? = null, val tokenEndpoint: String, val type: String, val userName: Map<String, String>)

Model for API authentication with JWT. Simple exchange between user name + password to access token.

Constructors

Link copied to clipboard
constructor(headers: Map<String, String>? = null, isCredentialsInHeaders: Boolean? = null, isJsonRequest: Boolean? = null, password: Map<String, String>, queryParameters: Map<String, String>? = null, requestTimeoutInSeconds: Int? = null, tokenEndpoint: String, type: String, userName: Map<String, String>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val headers: Map<String, String>? = null

The custom headers we want to add once we send request to token endpoint.

Link copied to clipboard

Flag indicating whether we want to send the user name and password to token endpoint in the headers.

Link copied to clipboard
val isJsonRequest: Boolean? = null

Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).

Link copied to clipboard

The password

Link copied to clipboard

The custom query parameter we want to add once we send request to token endpoint.

Link copied to clipboard

Request timeout in seconds.

Link copied to clipboard

Token endpoint to request JWT

Link copied to clipboard

Type of paging Expected value is 'JwtToken'.

Link copied to clipboard

The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.