View Source aws_sso_admin (aws v1.0.4)
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: https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html.
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: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html.
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: http://aws.amazon.com/tools/.Summary
Functions
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 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.
Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance.
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.
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
Deletes the association with the application.
Deletes the instance of IAM Identity Center.
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.
PermissionSet
.Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
Retrieves a direct assignment of a user or group to an application.
Returns the details of an instance of IAM Identity Center.
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.
Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center.
PermissionSet
.PutApplicationAssignmentConfiguration
.PermissionSet
.Lists all applications associated with the instance of IAM Identity Center.
PermissionSet
.PermissionSet
s in an IAM Identity Center instance.Configure how users gain access to an application.
Attaches an inline policy to a permission set.
PermissionSet
as a permissions boundary.Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC).
Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
Functions
attach_customer_managed_policy_reference_to_permission_set(Client, Input)
View SourcePermissionSet
.
attach_customer_managed_policy_reference_to_permission_set(Client, Input, Options)
View SourceAttaches 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.
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.
DescribeAccountAssignmentCreationStatus
to describe the status of an assignment creation request.
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.
create_instance_access_control_attribute_configuration(Client, Input)
View SourceEnables 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: /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.
After a successful response, callDescribeInstanceAccessControlAttributeConfiguration
to validate that InstanceAccessControlAttributeConfiguration
was created.
create_instance_access_control_attribute_configuration(Client, Input, Options)
View SourceCreates a permission set within a specified IAM Identity Center instance.
To grant users and groups access to Amazon Web Services account resources, use`CreateAccountAssignment
'.
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.Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
After a successful response, callDescribeAccountAssignmentDeletionStatus
to describe the status of an assignment deletion request.
Deletes the association with the application.
The connected service resource still exists.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(Client, Input)
View SourceDisables 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: /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.delete_instance_access_control_attribute_configuration(Client, Input, Options)
View SourcePermissionSet
.
delete_permissions_boundary_from_permission_set(Client, Input, Options)
View SourceDeletes 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(Client, Input, Options)
View Sourcedescribe_account_assignment_deletion_status(Client, Input, Options)
View SourceRetrieves 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 useListApplicationAssignmentsForPrincipal
.
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 ofACTIVE
. While the instance is in theCREATE_IN_PROGRESS
state, you can call only DescribeInstance and DeleteInstance operations.DELETE_IN_PROGRESS
- The instance is being deleted. ReturnsAccessDeniedException
after the delete operation completes.ACTIVE
- The instance is active.
describe_instance_access_control_attribute_configuration(Client, Input)
View SourceReturns 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: /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.describe_instance_access_control_attribute_configuration(Client, Input, Options)
View Sourcedescribe_permission_set_provisioning_status(Client, Input, Options)
View SourceRetrieves 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(Client, Input)
View SourcePermissionSet
.
detach_customer_managed_policy_reference_from_permission_set(Client, Input, Options)
View SourcePutApplicationAssignmentConfiguration
.
PermissionSet
.
get_permissions_boundary_for_permission_set(Client, Input, Options)
View Sourcelist_accounts_for_provisioned_permission_set(Client, Input, Options)
View Sourcelist_application_assignments_for_principal(Client, Input, Options)
View SourceLists all applications associated with the instance of IAM Identity Center.
When listing applications for an instance in the management account, member accounts must use theapplicationAccount
parameter to filter the list to only applications created from that account.
list_customer_managed_policy_references_in_permission_set(Client, Input)
View SourcePermissionSet
.
list_customer_managed_policy_references_in_permission_set(Client, Input, Options)
View SourcePermissionSet
s in an IAM Identity Center instance.
list_permission_sets_provisioned_to_account(Client, Input, Options)
View SourceConfigure how users gain access to an application.
IfAssignmentsRequired
is true
(default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html. If false
, all users have access to the application. If an assignment is created using CreateApplicationAssignment: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html., the user retains access if AssignmentsRequired
is set to true
.
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.
PermissionSet
as a permissions boundary.
put_permissions_boundary_to_permission_set(Client, Input, Options)
View Sourceupdate_instance_access_control_attribute_configuration(Client, Input)
View SourceUpdates 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: /singlesignon/latest/userguide/abac.html in the IAM Identity Center User Guide.update_instance_access_control_attribute_configuration(Client, Input, Options)
View SourceUpdates 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.