SsoAdminClient
IAM Identity Center is the Amazon Web Services solution for connecting your workforce users to Amazon Web Services managed applications and other Amazon Web Services resources. You can connect your existing identity provider and synchronize users and groups from your directory, or create and manage your users directly in IAM Identity Center. You can then use IAM Identity Center for either or both of the following:
User access to applications
User access to Amazon Web Services accounts
This guide provides information about single sign-on operations that you can use for access to applications and Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
IAM Identity Center uses the sso and identitystore API namespaces.
Many API operations for IAM Identity Center 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.
Functions
Attaches the specified customer managed policy to the specified PermissionSet.
Attaches an Amazon Web Services managed policy ARN to a permission set.
Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
Grant application access to a user or group.
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.
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 /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.
Creates a permission set within a specified IAM Identity Center instance.
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.
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
Deletes the association with the application. The connected service resource still exists.
Deletes an IAM Identity Center access scope from an application.
Revoke application access to an application by deleting application assignments for a user or group.
Deletes an authentication method from an application.
Deletes a grant from an application.
Deletes the inline policy from a specified permission set.
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.
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 /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.
Deletes the permissions boundary from a specified PermissionSet.
Deletes the specified permission set.
Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
Describes the status of the assignment creation request.
Describes the status of the assignment deletion request.
Retrieves the details of an application associated with an instance of IAM Identity Center.
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.
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.
Returns the details of an instance of IAM Identity Center. The status can be one of the following:
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 /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.
Gets the details of the permission set.
Describes the status for the given permission set provisioning request.
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.
Detaches the specified customer managed policy from the specified PermissionSet.
Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
Retrieves the configuration of PutApplicationAssignmentConfiguration.
Retrieves details about an authentication method used by an application.
Retrieves details about an application grant.
Obtains the inline policy assigned to the permission set.
Obtains the permissions boundary for a specified PermissionSet.
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
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 Center.
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
Lists the access scopes and authorized targets associated with an application.
Lists Amazon Web Services account users that are assigned to an application.
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 IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.
Lists all of the authentication methods supported by the specified application.
List the grants associated with an application.
Lists the application providers configured in the IAM Identity Center identity store.
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 applications for an account instance in the same member account, a filter is not required.
Lists all customer managed policies attached to a specified PermissionSet.
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.
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
Lists the PermissionSets in an IAM Identity Center instance.
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
Lists the tags that are attached to a specified resource.
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
The process by which a specified permission set is provisioned to the specified target.
Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
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.
Adds or updates an authentication method for an application.
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 Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0.
Attaches an inline policy to a permission set.
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
Associates a set of tags with a specified resource.
Disassociates a set of tags from a specified resource.
Updates application properties.
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
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 /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.
Updates an existing permission set.
Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
Inherited functions
Attaches the specified customer managed policy to the specified PermissionSet.
Attaches an Amazon Web Services managed policy ARN to a permission set.
Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
Grant application access to a user or group.
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.
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 /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.
Creates a permission set within a specified IAM Identity Center instance.
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.
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
Deletes the association with the application. The connected service resource still exists.
Deletes an IAM Identity Center access scope from an application.
Revoke application access to an application by deleting application assignments for a user or group.
Deletes an authentication method from an application.
Deletes a grant from an application.
Deletes the inline policy from a specified permission set.
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.
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 /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.
Deletes the permissions boundary from a specified PermissionSet.
Deletes the specified permission set.
Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
Describes the status of the assignment creation request.
Describes the status of the assignment deletion request.
Retrieves the details of an application associated with an instance of IAM Identity Center.
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.
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.
Returns the details of an instance of IAM Identity Center. The status can be one of the following:
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 /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.
Gets the details of the permission set.
Describes the status for the given permission set provisioning request.
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.
Detaches the specified customer managed policy from the specified PermissionSet.
Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
Retrieves the configuration of PutApplicationAssignmentConfiguration.
Retrieves details about an authentication method used by an application.
Retrieves details about an application grant.
Obtains the inline policy assigned to the permission set.
Obtains the permissions boundary for a specified PermissionSet.
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
Paginate over ListAccountAssignmentCreationStatusResponse results.
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
Paginate over ListAccountAssignmentDeletionStatusResponse results.
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
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 Center.
Paginate over ListAccountAssignmentsForPrincipalResponse results.
Paginate over ListAccountAssignmentsResponse results.
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
Paginate over ListAccountsForProvisionedPermissionSetResponse results.
Lists the access scopes and authorized targets associated with an application.
Paginate over ListApplicationAccessScopesResponse results.
Lists Amazon Web Services account users that are assigned to an application.
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 IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.
Paginate over ListApplicationAssignmentsForPrincipalResponse results.
Paginate over ListApplicationAssignmentsResponse results.
Lists all of the authentication methods supported by the specified application.
Paginate over ListApplicationAuthenticationMethodsResponse results.
List the grants associated with an application.
Paginate over ListApplicationGrantsResponse results.
Lists the application providers configured in the IAM Identity Center identity store.
Paginate over ListApplicationProvidersResponse results.
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 applications for an account instance in the same member account, a filter is not required.
Paginate over ListApplicationsResponse results.
Lists all customer managed policies attached to a specified PermissionSet.
Paginate over ListCustomerManagedPolicyReferencesInPermissionSetResponse results.
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.
Paginate over ListInstancesResponse results.
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
Paginate over ListManagedPoliciesInPermissionSetResponse results.
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
Paginate over ListPermissionSetProvisioningStatusResponse results.
Lists the PermissionSets in an IAM Identity Center instance.
Paginate over ListPermissionSetsResponse results.
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
Paginate over ListPermissionSetsProvisionedToAccountResponse results.
Lists the tags that are attached to a specified resource.
Paginate over ListTagsForResourceResponse results.
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
Paginate over ListTrustedTokenIssuersResponse results.
The process by which a specified permission set is provisioned to the specified target.
Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
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.
Adds or updates an authentication method for an application.
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 Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0.
Attaches an inline policy to a permission set.
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
Associates a set of tags with a specified resource.
Disassociates a set of tags from a specified resource.
Updates application properties.
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
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 /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.
Updates an existing permission set.
Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.