ssoadmin/aws.sdk.kotlin.services.ssoadmin.model/Grant

Grant

sealed class Grant

The Grant union represents the set of possible configuration options for the selected grant type. Exactly one member of the union must be specified, and must match the grant type selected.

Inheritors

Types

AuthorizationCode

data class AuthorizationCode(val value: AuthorizationCodeGrant) : Grant

Configuration options for the authorization_code grant type.

JwtBearer

data class JwtBearer(val value: JwtBearerGrant) : Grant

Configuration options for the urn:ietf:params:oauth:grant-type:jwt-bearer grant type.

RefreshToken

data class RefreshToken(val value: RefreshTokenGrant) : Grant

Configuration options for the refresh_token grant type.

SdkUnknown

object SdkUnknown : Grant

TokenExchange

data class TokenExchange(val value: TokenExchangeGrant) : Grant

Configuration options for the urn:ietf:params:oauth:grant-type:token-exchange grant type.

Functions

asAuthorizationCode

fun asAuthorizationCode(): AuthorizationCodeGrant

Casts this Grant as a AuthorizationCode and retrieves its aws.sdk.kotlin.services.ssoadmin.model.AuthorizationCodeGrant value. Throws an exception if the Grant is not a AuthorizationCode.

asAuthorizationCodeOrNull

fun asAuthorizationCodeOrNull(): AuthorizationCodeGrant?

Casts this Grant as a AuthorizationCode and retrieves its aws.sdk.kotlin.services.ssoadmin.model.AuthorizationCodeGrant value. Returns null if the Grant is not a AuthorizationCode.

asJwtBearer

fun asJwtBearer(): JwtBearerGrant

Casts this Grant as a JwtBearer and retrieves its aws.sdk.kotlin.services.ssoadmin.model.JwtBearerGrant value. Throws an exception if the Grant is not a JwtBearer.

asJwtBearerOrNull

fun asJwtBearerOrNull(): JwtBearerGrant?

Casts this Grant as a JwtBearer and retrieves its aws.sdk.kotlin.services.ssoadmin.model.JwtBearerGrant value. Returns null if the Grant is not a JwtBearer.

asRefreshToken

fun asRefreshToken(): RefreshTokenGrant

Casts this Grant as a RefreshToken and retrieves its aws.sdk.kotlin.services.ssoadmin.model.RefreshTokenGrant value. Throws an exception if the Grant is not a RefreshToken.

asRefreshTokenOrNull

fun asRefreshTokenOrNull(): RefreshTokenGrant?

Casts this Grant as a RefreshToken and retrieves its aws.sdk.kotlin.services.ssoadmin.model.RefreshTokenGrant value. Returns null if the Grant is not a RefreshToken.

asTokenExchange

fun asTokenExchange(): TokenExchangeGrant

Casts this Grant as a TokenExchange and retrieves its aws.sdk.kotlin.services.ssoadmin.model.TokenExchangeGrant value. Throws an exception if the Grant is not a TokenExchange.

asTokenExchangeOrNull

fun asTokenExchangeOrNull(): TokenExchangeGrant?

Casts this Grant as a TokenExchange and retrieves its aws.sdk.kotlin.services.ssoadmin.model.TokenExchangeGrant value. Returns null if the Grant is not a TokenExchange.