AWS.SSO (aws-elixir v0.8.0) View Source

AWS Single Sign-On Portal is a web service that makes it easy for you to assign user access to AWS SSO resources such as the user portal.

Users can get AWS account applications and roles assigned to them and get federated into the application.

For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

This API reference guide describes the AWS SSO 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 AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Link to this section Summary

Functions

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

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

Removes the client- and server-side session that is associated with the user.

Link to this section Functions

Link to this function

get_role_credentials(client, account_id, role_name, access_token, options \\ [])

View Source

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

Link to this function

list_account_roles(client, account_id, max_results \\ nil, next_token \\ nil, access_token, options \\ [])

View Source

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

Link to this function

list_accounts(client, max_results \\ nil, next_token \\ nil, access_token, options \\ [])

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 in the AWS SSO User Guide. This operation returns a paginated response.

Link to this function

logout(client, input, options \\ [])

View Source

Removes the client- and server-side session that is associated with the user.