View Source aws_sso (aws v1.0.4)

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: https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed.

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: http://aws.amazon.com/tools/.

Summary

Functions

Link to this function

get_role_credentials(Client, AccountId, RoleName, AccessToken)

View Source
Returns the STS short-term credentials for a given role name that is assigned to the user.
Link to this function

get_role_credentials(Client, AccountId, RoleName, AccessToken, QueryMap, HeadersMap)

View Source
Link to this function

get_role_credentials(Client, AccountId, RoleName, AccessToken, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_account_roles(Client, AccountId, AccessToken)

View Source
Lists all roles that are assigned to the user for a given AWS account.
Link to this function

list_account_roles(Client, AccountId, AccessToken, QueryMap, HeadersMap)

View Source
Link to this function

list_account_roles(Client, AccountId, AccessToken, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_accounts(Client, AccessToken)

View Source

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: https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers in the IAM Identity Center User Guide. This operation returns a paginated response.
Link to this function

list_accounts(Client, AccessToken, QueryMap, HeadersMap)

View Source
Link to this function

list_accounts(Client, AccessToken, QueryMap, HeadersMap, Options0)

View Source

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.

If a user uses IAM Identity Center to access the AWS CLI, the user’s IAM Identity Center sign in session is used to obtain an IAM session, as specified in the corresponding IAM Identity Center permission set. More specifically, IAM Identity Center assumes an IAM role in the target account on behalf of the user, and the corresponding temporary AWS credentials are returned to the client.

After user logout, any existing IAM role sessions that were created by using IAM Identity Center permission sets continue based on the duration configured in the permission set. For more information, see User authentications: https://docs.aws.amazon.com/singlesignon/latest/userguide/authconcept.html in the IAM Identity Center User Guide.
Link to this function

logout(Client, Input0, Options0)

View Source