OAuthModelResponse

data class OAuthModelResponse(val accessTokenPrepend: String? = null, val authorizationCode: String? = null, val authorizationEndpoint: String? = null, val authorizationEndpointHeaders: Map<String, String>? = null, val authorizationEndpointQueryParameters: Map<String, String>? = null, val clientId: String, val clientSecret: String, val grantType: String, val isCredentialsInHeaders: Boolean? = null, val isJwtBearerFlow: Boolean? = null, val redirectUri: String? = null, val scope: String? = null, val tokenEndpoint: String, val tokenEndpointHeaders: Map<String, String>? = null, val tokenEndpointQueryParameters: Map<String, String>? = null, val type: String)

Model for API authentication with OAuth2.

Constructors

Link copied to clipboard
constructor(accessTokenPrepend: String? = null, authorizationCode: String? = null, authorizationEndpoint: String? = null, authorizationEndpointHeaders: Map<String, String>? = null, authorizationEndpointQueryParameters: Map<String, String>? = null, clientId: String, clientSecret: String, grantType: String, isCredentialsInHeaders: Boolean? = null, isJwtBearerFlow: Boolean? = null, redirectUri: String? = null, scope: String? = null, tokenEndpoint: String, tokenEndpointHeaders: Map<String, String>? = null, tokenEndpointQueryParameters: Map<String, String>? = null, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Access token prepend. Default is 'Bearer'.

Link copied to clipboard

The user's authorization code.

Link copied to clipboard

The authorization endpoint.

Link copied to clipboard

The authorization endpoint headers.

Link copied to clipboard

The authorization endpoint query parameters.

Link copied to clipboard

The Application (client) ID that the OAuth provider assigned to your app.

Link copied to clipboard

The Application (client) secret that the OAuth provider assigned to your app.

Link copied to clipboard

The grant type, usually will be 'authorization code'.

Link copied to clipboard

Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.

Link copied to clipboard

A value indicating whether it's a JWT flow.

Link copied to clipboard
val redirectUri: String? = null

The Application redirect url that the user config in the OAuth provider.

Link copied to clipboard
val scope: String? = null

The Application (client) Scope that the OAuth provider assigned to your app.

Link copied to clipboard

The token endpoint. Defines the OAuth2 refresh token.

Link copied to clipboard

The token endpoint headers.

Link copied to clipboard

The token endpoint query parameters.

Link copied to clipboard

Type of paging Expected value is 'OAuth2'.