OAuthModelArgs

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

Model for API authentication with OAuth2.

Constructors

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

Properties

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

Access token prepend. Default is 'Bearer'.

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

The user's authorization code.

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

The authorization endpoint.

Link copied to clipboard

The authorization endpoint headers.

Link copied to clipboard

The authorization endpoint query parameters.

Link copied to clipboard
val clientId: Output<String>

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

Link copied to clipboard
val clientSecret: Output<String>

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

Link copied to clipboard
val grantType: Output<String>

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

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

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

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

A value indicating whether it's a JWT flow.

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

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

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

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

Link copied to clipboard
val tokenEndpoint: Output<String>

The token endpoint. Defines the OAuth2 refresh token.

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

The token endpoint headers.

Link copied to clipboard

The token endpoint query parameters.

Link copied to clipboard
val type: Output<String>

Type of paging Expected value is 'OAuth2'.

Functions

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