AWS Fundamentals Logo
AWS Fundamentals
aws sso-admin

AWS AWS SSO Admin CLI Commands

79 CLI commands available for AWS SSO Admin.

CommandSample
add-region

Adds a Region to an IAM Identity Center instance. This operation initiates an asynchronous workflow to replicate the IAM Identity Center instance to the target Region. The Region status is set to ADDING at first and changes to ACTIVE when the workflow completes. To use this operation, your IAM Ident

attach-customer-managed-policy-reference-to-permission-set

Attaches the specified customer managed policy to the specified PermissionSet.

attach-managed-policy-to-permission-set

Attaches an Amazon Web Services managed policy ARN to a permission set. If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this operation. Calling ProvisionPermissionSet applies the corresponding IAM policy updates to

create-account-assignment

Assigns access to a principal for a specified Amazon Web Services account using a specified permission set. The term principal here refers to a user or group that is defined in IAM Identity Center. As part of a successful CreateAccountAssignment call, the specified permission set will automatical

create-application

Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider. This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see

create-application-assignment

Grant application access to a user or group.

create-instance

Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not managed by Organizations or a member Amazon Web Services account in an organization. You can create only one instance per account and across all Amazon Web Services Regions. The CreateInstance request

create-instance-access-control-attribute-configuration

Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center

create-permission-set

Creates a permission set within a specified IAM Identity Center instance. To grant users and groups access to Amazon Web Services account resources, use CreateAccountAssignment .

create-trusted-token-issuer

Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of Amazon Web Services. This trusted token issuer describes an external identity provider (IdP) tha

delete-account-assignment

Deletes a principal's access from a specified Amazon Web Services account using a specified permission set. After a successful response, call DescribeAccountAssignmentDeletionStatus to describe the status of an assignment deletion request.

delete-application

Deletes the association with the application. The connected service resource still exists.

delete-application-access-scope

Deletes an IAM Identity Center access scope from an application.

delete-application-assignment

Revoke application access to an application by deleting application assignments for a user or group.

delete-application-authentication-method

Deletes an authentication method from an application.

delete-application-grant

Deletes a grant from an application.

delete-inline-policy-from-permission-set

Deletes the inline policy from a specified permission set.

delete-instance

Deletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance.

delete-instance-access-control-attribute-configuration

Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configu

delete-permission-set

Deletes the specified permission set.

delete-permissions-boundary-from-permission-set

Deletes the permissions boundary from a specified PermissionSet.

delete-trusted-token-issuer

Deletes a trusted token issuer configuration from an instance of IAM Identity Center. Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.

describe-account-assignment-creation-status

Describes the status of the assignment creation request.

describe-account-assignment-deletion-status

Describes the status of the assignment deletion request.

describe-application

Retrieves the details of an application associated with an instance of IAM Identity Center.

describe-application-assignment

Retrieves a direct assignment of a user or group to an application. If the user doesn’t have a direct assignment to the application, the user may still have access to the application through a group. Therefore, don’t use this API to test access to an application for a user. Instead use ListApplicati

describe-application-provider

Retrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.

describe-instance

Returns the details of an instance of IAM Identity Center. The status can be one of the following: CREATE_IN_PROGRESS - The instance is in the process of being created. When the instance is ready for use, DescribeInstance returns the status of ACTIVE. While the instance is in the CREATE_IN_PROGRE

describe-instance-access-control-attribute-configuration

Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information a

describe-permission-set

Gets the details of the permission set.

describe-permission-set-provisioning-status

Describes the status for the given permission set provisioning request.

describe-region

Retrieves details about a specific Region enabled in an IAM Identity Center instance. Details include the Region name, current status (ACTIVE, ADDING, or REMOVING), the date when the Region was added, and whether it is the primary Region. The request must be made from one of the enabled Regions of t

describe-trusted-token-issuer

Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration.

detach-customer-managed-policy-reference-from-permission-set

Detaches the specified customer managed policy from the specified PermissionSet.

detach-managed-policy-from-permission-set

Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.

get-application-access-scope

Retrieves the authorized targets for an IAM Identity Center access scope for an application.

get-application-assignment-configuration

Retrieves the configuration of PutApplicationAssignmentConfiguration.

get-application-authentication-method

Retrieves details about an authentication method used by an application.

get-application-grant

Retrieves details about an application grant.

get-application-session-configuration

Retrieves the session configuration for an application in IAM Identity Center. The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services

get-inline-policy-for-permission-set

Obtains the inline policy assigned to the permission set.

get-permissions-boundary-for-permission-set

Obtains the permissions boundary for a specified PermissionSet.

list-account-assignment-creation-status

Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.

list-account-assignment-deletion-status

Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.

list-account-assignments

Lists the assignee of the specified Amazon Web Services account with the specified permission set.

list-account-assignments-for-principal

Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Ce

list-accounts-for-provisioned-permission-set

Lists all the Amazon Web Services accounts where the specified permission set is provisioned.

list-application-access-scopes

Lists the access scopes and authorized targets associated with an application.

list-application-assignments

Lists Amazon Web Services account users that are assigned to an application.

list-application-assignments-for-principal

Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of

list-application-authentication-methods

Lists all of the authentication methods supported by the specified application.

list-application-grants

List the grants associated with an application.

list-application-providers

Lists the application providers configured in the IAM Identity Center identity store.

list-applications

Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account. When listing appl

list-customer-managed-policy-references-in-permission-set

Lists all customer managed policies attached to a specified PermissionSet.

list-instances

Lists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.

list-managed-policies-in-permission-set

Lists the Amazon Web Services managed policy that is attached to a specified permission set.

list-permission-set-provisioning-status

Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.

list-permission-sets

Lists the PermissionSets in an IAM Identity Center instance.

list-permission-sets-provisioned-to-account

Lists all the permission sets that are provisioned to a specified Amazon Web Services account.

list-regions

Lists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed. This operation returns Regions with ACTIVE, ADDING, or REMOVING status. The following actions are related to ListRegions: AddRegion RemoveRegion DescribeRegion

list-tags-for-resource

Lists the tags that are attached to a specified resource.

list-trusted-token-issuers

Lists all the trusted token issuers configured in an instance of IAM Identity Center.

provision-permission-set

The process by which a specified permission set is provisioned to the specified target.

put-application-access-scope

Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.

put-application-assignment-configuration

Configure how users gain access to an application. If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application. If an assignment is created usi

put-application-authentication-method

Adds or updates an authentication method for an application.

put-application-grant

Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Iden

put-application-session-configuration

Updates the session configuration for an application in IAM Identity Center. The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services ma

put-inline-policy-to-permission-set

Attaches an inline policy to a permission set. If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts.

put-permissions-boundary-to-permission-set

Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.

remove-region

Removes an additional Region from an IAM Identity Center instance. This operation initiates an asynchronous workflow to clean up IAM Identity Center resources in the specified additional Region. The Region status is set to REMOVING and the Region record is deleted when the workflow completes. The re

tag-resource

Associates a set of tags with a specified resource.

untag-resource

Disassociates a set of tags from a specified resource.

update-application

Updates application properties.

update-instance

Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.

update-instance-access-control-attribute-configuration

Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configu

update-permission-set

Updates an existing permission set.

update-trusted-token-issuer

Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration. Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issue

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Stats

Total Commands79
ServiceSSO Admin