ssooidc/aws.sdk.kotlin.services.ssooidc

Package-level declarations

Types

IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a native application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with IAM Identity Center.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createToken

inline suspend fun SsoOidcClient.createToken(crossinline block: CreateTokenRequest.Builder.() -> Unit): CreateTokenResponse

Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-term credentials for the assigned AWS accounts or to access application APIs using bearer authentication.

createTokenWithIam

inline suspend fun SsoOidcClient.createTokenWithIam(crossinline block: CreateTokenWithIamRequest.Builder.() -> Unit): CreateTokenWithIamResponse

Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM entities. The access token can be used to fetch short-term credentials for the assigned AWS accounts or to access application APIs using bearer authentication.

registerClient

inline suspend fun SsoOidcClient.registerClient(crossinline block: RegisterClientRequest.Builder.() -> Unit): RegisterClientResponse

Registers a client with IAM Identity Center. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.

startDeviceAuthorization

inline suspend fun SsoOidcClient.startDeviceAuthorization(crossinline block: StartDeviceAuthorizationRequest.Builder.() -> Unit): StartDeviceAuthorizationResponse

Initiates device authorization by requesting a pair of verification codes from the authorization service.

withConfig

fun SsoOidcClient.withConfig(block: SsoOidcClient.Config.Builder.() -> Unit): SsoOidcClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.