Navigation Guide
You are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.

SSOAdminClient

IAM Identity Center (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size and type.

IAM Identity Center uses the sso and identitystore API namespaces.

This reference guide provides information on single sign-on operations which could be used for access management of Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide .

Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference .

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

Installation

NPM

npm install @aws-sdk/client-sso-admin

Yarn

yarn add @aws-sdk/client-sso-admin

pnpm

pnpm add @aws-sdk/client-sso-admin

SSOAdminClient Operations

Command	Summary
AttachCustomerManagedPolicyReferenceToPermissionSetCommand	Attaches the specified customer managed policy to the specified PermissionSet.
AttachManagedPolicyToPermissionSetCommand	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 all assigned accounts.
CreateAccountAssignmentCommand	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 automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call `ProvisionPermissionSet` to make these updates. After a successful response, call `DescribeAccountAssignmentCreationStatus` to describe the status of an assignment creation request.
CreateApplicationAssignmentCommand	Grant application access to a user or group.
CreateApplicationCommand	Creates an application in IAM Identity Center for the given application provider.
CreateInstanceAccessControlAttributeConfigurationCommand	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 User Guide. After a successful response, call `DescribeInstanceAccessControlAttributeConfiguration` to validate that `InstanceAccessControlAttributeConfiguration` was created.
CreateInstanceCommand	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 is rejected if the following apply: The instance is created within the organization management account. An instance already exists in the same account.
CreatePermissionSetCommand	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` .
CreateTrustedTokenIssuerCommand	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) that can generate claims or assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center can use these tokens for authentication.
DeleteAccountAssignmentCommand	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.
DeleteApplicationAccessScopeCommand	Deletes an IAM Identity Center access scope from an application.
DeleteApplicationAssignmentCommand	Revoke application access to an application by deleting application assignments for a user or group.
DeleteApplicationAuthenticationMethodCommand	Deletes an authentication method from an application.
DeleteApplicationCommand	Deletes the association with the application. The connected service resource still exists.
DeleteApplicationGrantCommand	Deletes a grant from an application.
DeleteInlinePolicyFromPermissionSetCommand	Deletes the inline policy from a specified permission set.
DeleteInstanceAccessControlAttributeConfigurationCommand	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 configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
DeleteInstanceCommand	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.
DeletePermissionSetCommand	Deletes the specified permission set.
DeletePermissionsBoundaryFromPermissionSetCommand	Deletes the permissions boundary from a specified PermissionSet.
DeleteTrustedTokenIssuerCommand	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.
DescribeAccountAssignmentCreationStatusCommand	Describes the status of the assignment creation request.
DescribeAccountAssignmentDeletionStatusCommand	Describes the status of the assignment deletion request.
DescribeApplicationAssignmentCommand	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 ListApplicationAssignmentsForPrincipal.
DescribeApplicationCommand	Retrieves the details of an application associated with an instance of IAM Identity Center.
DescribeApplicationProviderCommand	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.
DescribeInstanceAccessControlAttributeConfigurationCommand	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 about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
DescribeInstanceCommand	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_PROGRESS` state, you can call only DescribeInstance and DeleteInstance operations. `DELETE_IN_PROGRESS` - The instance is being deleted. Returns `AccessDeniedException` after the delete operation completes. `ACTIVE` - The instance is active.
DescribePermissionSetCommand	Gets the details of the permission set.
DescribePermissionSetProvisioningStatusCommand	Describes the status for the given permission set provisioning request.
DescribeTrustedTokenIssuerCommand	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.
DetachCustomerManagedPolicyReferenceFromPermissionSetCommand	Detaches the specified customer managed policy from the specified PermissionSet.
DetachManagedPolicyFromPermissionSetCommand	Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
GetApplicationAccessScopeCommand	Retrieves the authorized targets for an IAM Identity Center access scope for an application.
GetApplicationAssignmentConfigurationCommand	Retrieves the configuration of PutApplicationAssignmentConfiguration.
GetApplicationAuthenticationMethodCommand	Retrieves details about an authentication method used by an application.
GetApplicationGrantCommand	Retrieves details about an application grant.
GetInlinePolicyForPermissionSetCommand	Obtains the inline policy assigned to the permission set.
GetPermissionsBoundaryForPermissionSetCommand	Obtains the permissions boundary for a specified PermissionSet.
ListAccountAssignmentCreationStatusCommand	Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
ListAccountAssignmentDeletionStatusCommand	Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
ListAccountAssignmentsCommand	Lists the assignee of the specified Amazon Web Services account with the specified permission set.
ListAccountAssignmentsForPrincipalCommand	Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
ListAccountsForProvisionedPermissionSetCommand	Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
ListApplicationAccessScopesCommand	Lists the access scopes and authorized targets associated with an application.
ListApplicationAssignmentsCommand	Lists Amazon Web Services account users that are assigned to an application.
ListApplicationAssignmentsForPrincipalCommand	Lists the applications to which a specified principal is assigned.
ListApplicationAuthenticationMethodsCommand	Lists all of the authentication methods supported by the specified application.
ListApplicationGrantsCommand	List the grants associated with an application.
ListApplicationProvidersCommand	Lists the application providers configured in the IAM Identity Center identity store.
ListApplicationsCommand	Lists all applications associated with the instance of IAM Identity Center. When listing applications for an instance in the management account, member accounts must use the `applicationAccount` parameter to filter the list to only applications created from that account.
ListCustomerManagedPolicyReferencesInPermissionSetCommand	Lists all customer managed policies attached to a specified PermissionSet.
ListInstancesCommand	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.
ListManagedPoliciesInPermissionSetCommand	Lists the Amazon Web Services managed policy that is attached to a specified permission set.
ListPermissionSetProvisioningStatusCommand	Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
ListPermissionSetsCommand	Lists the PermissionSets in an IAM Identity Center instance.
ListPermissionSetsProvisionedToAccountCommand	Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
ListTagsForResourceCommand	Lists the tags that are attached to a specified resource.
ListTrustedTokenIssuersCommand	Lists all the trusted token issuers configured in an instance of IAM Identity Center.
ProvisionPermissionSetCommand	The process by which a specified permission set is provisioned to the specified target.
PutApplicationAccessScopeCommand	Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
PutApplicationAssignmentConfigurationCommand	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 using CreateApplicationAssignment ., the user retains access if `AssignmentsRequired` is set to `true`.
PutApplicationAuthenticationMethodCommand	Adds or updates an authentication method for an application.
PutApplicationGrantCommand	Adds a grant to an application.
PutInlinePolicyToPermissionSetCommand	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.
PutPermissionsBoundaryToPermissionSetCommand	Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
TagResourceCommand	Associates a set of tags with a specified resource.
UntagResourceCommand	Disassociates a set of tags from a specified resource.
UpdateApplicationCommand	Updates application properties.
UpdateInstanceAccessControlAttributeConfigurationCommand	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 configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
UpdateInstanceCommand	Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
UpdatePermissionSetCommand	Updates an existing permission set.
UpdateTrustedTokenIssuerCommand	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 issuer.

SSOAdminClient Configuration

Parameter	Type	Description
`defaultsMode` Optional	`DefaultsMode \| Provider<DefaultsMode>`	The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
`disableHostPrefix` Optional	`boolean`	Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
`extensions` Optional	`RuntimeExtension[]`	Optional extensions
`logger` Optional	`Logger`	Optional logger for logging debug/info/warn/error.
`maxAttempts` Optional	`number \| Provider<number>`	Value for how many times a request will be made at most in case of retry.
`profile` Optional	`string`	Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
`region` Optional	`string \| Provider<string>`	The AWS region to which this client will send requests
`requestHandler` Optional	`__HttpHandlerUserInput`	The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
`retryMode` Optional	`string \| Provider<string>`	Specifies which retry algorithm to use.
`useDualstackEndpoint` Optional	`boolean \| Provider<boolean>`	Enables IPv6/IPv4 dualstack endpoint.
`useFipsEndpoint` Optional	`boolean \| Provider<boolean>`	Enables FIPS compatible endpoints.

Additional config fields are described in the full configuration type: SSOAdminClientConfig