Edit on GitHub

Sso

This page documents function available when using the Sso module, created with @service Sso.

Index

Documentation

Main.Sso.get_role_credentials — Method
get_role_credentials(account_id, role_name, x-amz-sso_bearer_token)
get_role_credentials(account_id, role_name, x-amz-sso_bearer_token, params::Dict{String,<:Any})

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

Arguments

  • account_id: The identifier for the AWS account that is assigned to the user.
  • role_name: The friendly name of the role that is assigned to the user.
  • x-amz-sso_bearer_token: The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.
source
Main.Sso.list_account_roles — Method
list_account_roles(account_id, x-amz-sso_bearer_token)
list_account_roles(account_id, x-amz-sso_bearer_token, params::Dict{String,<:Any})

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

Arguments

  • account_id: The identifier for the AWS account that is assigned to the user.
  • x-amz-sso_bearer_token: The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max_result": The number of items that clients can request per page.
  • "next_token": The page token from the previous response output when you request subsequent pages.
source
Main.Sso.list_accounts — Method
list_accounts(x-amz-sso_bearer_token)
list_accounts(x-amz-sso_bearer_token, params::Dict{String,<:Any})

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.

Arguments

  • x-amz-sso_bearer_token: The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max_result": This is the number of items clients can request per page.
  • "next_token": (Optional) When requesting subsequent pages, this is the page token from the previous response output.
source
Main.Sso.logout — Method
logout(x-amz-sso_bearer_token)
logout(x-amz-sso_bearer_token, params::Dict{String,<:Any})

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

Arguments

  • x-amz-sso_bearer_token: The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.
source