View Source AWS.SSOAdmin (aws-elixir v0.13.3)
AWS IAM Identity Center (successor to AWS Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across AWS accounts and applications.
IAM Identity Center is the recommended approach for workforce authentication and authorization in AWS, for organizations of any size and type.
Although AWS Single Sign-On was renamed, the sso and identitystore API
namespaces will continue to retain their original name for backward
compatibility purposes. For more information, see IAM Identity Center rename.
This reference guide provides information on single sign-on operations which could be used for access management of AWS 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.
AWS 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 AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
Link to this section Summary
Functions
Attaches the specified customer managed policy to the specified PermissionSet.
Attaches an AWS managed policy ARN to a permission set.
Assigns access to a principal for a specified AWS account using a specified permission set.
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.
Deletes a principal's access from a specified AWS account using a specified permission set.
Deletes the inline policy from a specified permission set.
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.
Deletes the specified permission set.
Deletes the permissions boundary from a specified PermissionSet.
Describes the status of the assignment creation request.
Describes the status of the assignment deletion request.
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.
Gets the details of the permission set.
Describes the status for the given permission set provisioning request.
Detaches the specified customer managed policy from the specified
PermissionSet.
Detaches the attached AWS managed policy ARN from the specified permission set.
Obtains the inline policy assigned to the permission set.
Obtains the permissions boundary for a specified PermissionSet.
Lists the status of the AWS account assignment creation requests for a specified IAM Identity Center instance.
Lists the status of the AWS account assignment deletion requests for a specified IAM Identity Center instance.
Lists the assignee of the specified AWS account with the specified permission set.
Lists all the AWS accounts where the specified permission set is provisioned.
Lists all customer managed policies attached to a specified PermissionSet.
Lists the IAM Identity Center instances that the caller has access to.
Lists the AWS 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 AWS account.
Lists the tags that are attached to a specified resource.
The process by which a specified permission set is provisioned to the specified target.
Attaches an inline policy to a permission set.
Attaches an AWS 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 the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC).
Updates an existing permission set.
Link to this section Functions
attach_customer_managed_policy_reference_to_permission_set(client, input, options \\ [])
View SourceAttaches the specified customer managed policy to the specified PermissionSet.
attach_managed_policy_to_permission_set(client, input, options \\ [])
View SourceAttaches an AWS 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 AWS 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.
create_instance_access_control_attribute_configuration(client, input, options \\ [])
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 in the IAM Identity Center User Guide.
After a successful response, call
DescribeInstanceAccessControlAttributeConfiguration to validate that
InstanceAccessControlAttributeConfiguration was created.
Creates a permission set within a specified IAM Identity Center instance.
To grant users and groups access to AWS account resources, use CreateAccountAssignment.
Deletes a principal's access from a specified AWS account using a specified permission set.
After a successful response, call DescribeAccountAssignmentCreationStatus to
describe the status of an assignment deletion request.
delete_inline_policy_from_permission_set(client, input, options \\ [])
View SourceDeletes the inline policy from a specified permission set.
delete_instance_access_control_attribute_configuration(client, input, options \\ [])
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 in the IAM Identity Center User Guide.
Deletes the specified permission set.
delete_permissions_boundary_from_permission_set(client, input, options \\ [])
View SourceDeletes the permissions boundary from a specified PermissionSet.
describe_account_assignment_creation_status(client, input, options \\ [])
View SourceDescribes the status of the assignment creation request.
describe_account_assignment_deletion_status(client, input, options \\ [])
View SourceDescribes the status of the assignment deletion request.
describe_instance_access_control_attribute_configuration(client, input, options \\ [])
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 in the IAM Identity Center User Guide.
Gets the details of the permission set.
describe_permission_set_provisioning_status(client, input, options \\ [])
View SourceDescribes the status for the given permission set provisioning request.
detach_customer_managed_policy_reference_from_permission_set(client, input, options \\ [])
View SourceDetaches the specified customer managed policy from the specified
PermissionSet.
detach_managed_policy_from_permission_set(client, input, options \\ [])
View SourceDetaches the attached AWS managed policy ARN from the specified permission set.
get_inline_policy_for_permission_set(client, input, options \\ [])
View SourceObtains the inline policy assigned to the permission set.
get_permissions_boundary_for_permission_set(client, input, options \\ [])
View SourceObtains the permissions boundary for a specified PermissionSet.
list_account_assignment_creation_status(client, input, options \\ [])
View SourceLists the status of the AWS account assignment creation requests for a specified IAM Identity Center instance.
list_account_assignment_deletion_status(client, input, options \\ [])
View SourceLists the status of the AWS account assignment deletion requests for a specified IAM Identity Center instance.
Lists the assignee of the specified AWS account with the specified permission set.
list_accounts_for_provisioned_permission_set(client, input, options \\ [])
View SourceLists all the AWS accounts where the specified permission set is provisioned.
list_customer_managed_policy_references_in_permission_set(client, input, options \\ [])
View SourceLists all customer managed policies attached to a specified PermissionSet.
Lists the IAM Identity Center instances that the caller has access to.
list_managed_policies_in_permission_set(client, input, options \\ [])
View SourceLists the AWS managed policy that is attached to a specified permission set.
list_permission_set_provisioning_status(client, input, options \\ [])
View SourceLists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
Lists the PermissionSets in an IAM Identity Center instance.
list_permission_sets_provisioned_to_account(client, input, options \\ [])
View SourceLists all the permission sets that are provisioned to a specified AWS account.
Lists the tags that are attached to a specified resource.
The process by which a specified permission set is provisioned to the specified target.
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(client, input, options \\ [])
View SourceAttaches an AWS 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.
update_instance_access_control_attribute_configuration(client, input, options \\ [])
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 in the IAM Identity Center User Guide.
Updates an existing permission set.