sso/aws.sdk.kotlin.services.sso/SsoClient

SsoClient

AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to IAM Identity Center resources such as the AWS access portal. Users can get AWS account applications and roles assigned to them and get federated into the application.

Although AWS Single Sign-On was renamed, the sso and identitystore API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see IAM Identity Center rename.

This reference guide describes the IAM Identity Center Portal operations that you can call programatically and includes detailed information on data types and errors.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Types

Builder

class Builder : AbstractSdkClientBuilder<SsoClient.Config, SsoClient.Config.Builder, SsoClient>

Companion

object Companion : AbstractAwsSdkClientFactory<SsoClient.Config, SsoClient.Config.Builder, SsoClient, SsoClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: SsoClient.Config

SsoClient's configuration

Functions

getRoleCredentials

abstract suspend fun getRoleCredentials(input: GetRoleCredentialsRequest): GetRoleCredentialsResponse

Returns the STS short-term credentials for a given role name that is assigned to the user.

listAccountRoles

abstract suspend fun listAccountRoles(input: ListAccountRolesRequest): ListAccountRolesResponse

Lists all roles that are assigned to the user for a given AWS account.

listAccounts

abstract suspend fun listAccounts(input: ListAccountsRequest): ListAccountsResponse

Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see Assign User Access in the IAM Identity Center User Guide. This operation returns a paginated response.

logout

abstract suspend fun logout(input: LogoutRequest): LogoutResponse

Removes the locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.

Inherited functions

expect abstract fun close()

getRoleCredentials

inline suspend fun SsoClient.getRoleCredentials(crossinline block: GetRoleCredentialsRequest.Builder.() -> Unit): GetRoleCredentialsResponse

Returns the STS short-term credentials for a given role name that is assigned to the user.

listAccountRoles

inline suspend fun SsoClient.listAccountRoles(crossinline block: ListAccountRolesRequest.Builder.() -> Unit): ListAccountRolesResponse

Lists all roles that are assigned to the user for a given AWS account.

listAccountRolesPaginated

fun SsoClient.listAccountRolesPaginated(initialRequest: ListAccountRolesRequest): Flow<ListAccountRolesResponse>

fun SsoClient.listAccountRolesPaginated(block: ListAccountRolesRequest.Builder.() -> Unit): Flow<ListAccountRolesResponse>

Paginate over ListAccountRolesResponse results.

listAccounts

inline suspend fun SsoClient.listAccounts(crossinline block: ListAccountsRequest.Builder.() -> Unit): ListAccountsResponse

listAccountsPaginated

fun SsoClient.listAccountsPaginated(initialRequest: ListAccountsRequest): Flow<ListAccountsResponse>

fun SsoClient.listAccountsPaginated(block: ListAccountsRequest.Builder.() -> Unit): Flow<ListAccountsResponse>

Paginate over ListAccountsResponse results.

logout

inline suspend fun SsoClient.logout(crossinline block: LogoutRequest.Builder.() -> Unit): LogoutResponse

withConfig

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

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.