aws-elixir

View Source AWS.SSOAdmin (aws-elixir 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.

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.

Link to this section Summary

Functions

attach_customer_managed_policy_reference_to_permission_set(client, input, options \\ [])

Attaches the specified customer managed policy to the specified PermissionSet.

attach_managed_policy_to_permission_set(client, input, options \\ [])

Attaches an Amazon Web Services managed policy ARN to a permission set.

create_account_assignment(client, input, options \\ [])

Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.

create_application(client, input, options \\ [])

Creates an application in IAM Identity Center for the given application provider.

create_application_assignment(client, input, options \\ [])

Grant application access to a user or group.

create_instance(client, input, options \\ [])

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.

create_instance_access_control_attribute_configuration(client, input, options \\ [])

Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance.

create_permission_set(client, input, options \\ [])

Creates a permission set within a specified IAM Identity Center instance.

create_trusted_token_issuer(client, input, options \\ [])

Creates a connection to a trusted token issuer in an instance of IAM Identity Center.

delete_account_assignment(client, input, options \\ [])

Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.

delete_application(client, input, options \\ [])

Deletes the association with the application.

delete_application_access_scope(client, input, options \\ [])

Deletes an IAM Identity Center access scope from an application.

delete_application_assignment(client, input, options \\ [])

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

delete_application_authentication_method(client, input, options \\ [])

Deletes an authentication method from an application.

delete_application_grant(client, input, options \\ [])

Deletes a grant from an application.

delete_inline_policy_from_permission_set(client, input, options \\ [])

Deletes the inline policy from a specified permission set.

delete_instance(client, input, options \\ [])

Deletes the instance of IAM Identity Center.

delete_instance_access_control_attribute_configuration(client, input, options \\ [])

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.

delete_permission_set(client, input, options \\ [])

Deletes the specified permission set.

delete_permissions_boundary_from_permission_set(client, input, options \\ [])

Deletes the permissions boundary from a specified PermissionSet.

delete_trusted_token_issuer(client, input, options \\ [])

Deletes a trusted token issuer configuration from an instance of IAM Identity Center.

describe_account_assignment_creation_status(client, input, options \\ [])

Describes the status of the assignment creation request.

describe_account_assignment_deletion_status(client, input, options \\ [])

Describes the status of the assignment deletion request.

describe_application(client, input, options \\ [])

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

describe_application_assignment(client, input, options \\ [])

Retrieves a direct assignment of a user or group to an application.

describe_application_provider(client, input, options \\ [])

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(client, input, options \\ [])

Returns the details of an instance of IAM Identity Center.

describe_instance_access_control_attribute_configuration(client, input, options \\ [])

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.

describe_permission_set(client, input, options \\ [])

Gets the details of the permission set.

describe_permission_set_provisioning_status(client, input, options \\ [])

Describes the status for the given permission set provisioning request.

describe_trusted_token_issuer(client, input, options \\ [])

Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center.

detach_customer_managed_policy_reference_from_permission_set(client, input, options \\ [])

Detaches the specified customer managed policy from the specified PermissionSet.

detach_managed_policy_from_permission_set(client, input, options \\ [])

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

get_application_access_scope(client, input, options \\ [])

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

get_application_assignment_configuration(client, input, options \\ [])

Retrieves the configuration of PutApplicationAssignmentConfiguration.

get_application_authentication_method(client, input, options \\ [])

Retrieves details about an authentication method used by an application.

get_application_grant(client, input, options \\ [])

Retrieves details about an application grant.

get_inline_policy_for_permission_set(client, input, options \\ [])

Obtains the inline policy assigned to the permission set.

get_permissions_boundary_for_permission_set(client, input, options \\ [])

Obtains the permissions boundary for a specified PermissionSet.

list_account_assignment_creation_status(client, input, options \\ [])

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

list_account_assignment_deletion_status(client, input, options \\ [])

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

list_account_assignments(client, input, options \\ [])

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

list_account_assignments_for_principal(client, input, options \\ [])

Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.

list_accounts_for_provisioned_permission_set(client, input, options \\ [])

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

list_application_access_scopes(client, input, options \\ [])

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

list_application_assignments(client, input, options \\ [])

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

list_application_assignments_for_principal(client, input, options \\ [])

Lists the applications to which a specified principal is assigned.

list_application_authentication_methods(client, input, options \\ [])

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

list_application_grants(client, input, options \\ [])

List the grants associated with an application.

list_application_providers(client, input, options \\ [])

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

list_applications(client, input, options \\ [])

Lists all applications associated with the instance of IAM Identity Center.

list_customer_managed_policy_references_in_permission_set(client, input, options \\ [])

Lists all customer managed policies attached to a specified PermissionSet.

list_instances(client, input, options \\ [])

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(client, input, options \\ [])

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

list_permission_set_provisioning_status(client, input, options \\ [])

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

list_permission_sets(client, input, options \\ [])

Lists the PermissionSets in an IAM Identity Center instance.

list_permission_sets_provisioned_to_account(client, input, options \\ [])

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

list_tags_for_resource(client, input, options \\ [])

Lists the tags that are attached to a specified resource.

list_trusted_token_issuers(client, input, options \\ [])

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

metadata()
provision_permission_set(client, input, options \\ [])

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

put_application_access_scope(client, input, options \\ [])

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

put_application_assignment_configuration(client, input, options \\ [])

Configure how users gain access to an application.

put_application_authentication_method(client, input, options \\ [])

Adds or updates an authentication method for an application.

put_application_grant(client, input, options \\ [])

Adds a grant to an application.

put_inline_policy_to_permission_set(client, input, options \\ [])

Attaches an inline policy to a permission set.

put_permissions_boundary_to_permission_set(client, input, options \\ [])

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

tag_resource(client, input, options \\ [])

Associates a set of tags with a specified resource.

untag_resource(client, input, options \\ [])

Disassociates a set of tags from a specified resource.

update_application(client, input, options \\ [])

Updates application properties.

update_instance(client, input, options \\ [])

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(client, input, options \\ [])

Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC).

update_permission_set(client, input, options \\ [])

Updates an existing permission set.

update_trusted_token_issuer(client, input, options \\ [])

Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.

Link to this section Functions

Link to this function

attach_customer_managed_policy_reference_to_permission_set(client, input, options \\ [])

View Source

Attaches the specified customer managed policy to the specified PermissionSet.

Link to this function

attach_managed_policy_to_permission_set(client, input, options \\ [])

View Source

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.

Link to this function

create_account_assignment(client, input, options \\ [])

View Source

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.

Link to this function

create_application(client, input, options \\ [])

View Source

Creates an application in IAM Identity Center for the given application provider.

Link to this function

create_application_assignment(client, input, options \\ [])

View Source

Grant application access to a user or group.

Link to this function

create_instance(client, input, options \\ [])

View Source

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.

Link to this function

create_instance_access_control_attribute_configuration(client, input, options \\ [])

View Source

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.

Link to this function

create_permission_set(client, input, options \\ [])

View Source

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`

.

Link to this function

create_trusted_token_issuer(client, input, options \\ [])

View Source

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.

Link to this function

delete_account_assignment(client, input, options \\ [])

View Source

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.

Link to this function

delete_application(client, input, options \\ [])

View Source

Deletes the association with the application.

The connected service resource still exists.

Link to this function

delete_application_access_scope(client, input, options \\ [])

View Source

Deletes an IAM Identity Center access scope from an application.

Link to this function

delete_application_assignment(client, input, options \\ [])

View Source

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

Link to this function

delete_application_authentication_method(client, input, options \\ [])

View Source

Deletes an authentication method from an application.

Link to this function

delete_application_grant(client, input, options \\ [])

View Source

Deletes a grant from an application.

Link to this function

delete_inline_policy_from_permission_set(client, input, options \\ [])

View Source

Deletes the inline policy from a specified permission set.

Link to this function

delete_instance(client, input, options \\ [])

View Source

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.

Link to this function

delete_instance_access_control_attribute_configuration(client, input, options \\ [])

View Source

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.

Link to this function

delete_permission_set(client, input, options \\ [])

View Source

Deletes the specified permission set.

Link to this function

delete_permissions_boundary_from_permission_set(client, input, options \\ [])

View Source

Deletes the permissions boundary from a specified PermissionSet.

Link to this function

delete_trusted_token_issuer(client, input, options \\ [])

View Source

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.

Link to this function

describe_account_assignment_creation_status(client, input, options \\ [])

View Source

Describes the status of the assignment creation request.

Link to this function

describe_account_assignment_deletion_status(client, input, options \\ [])

View Source

Describes the status of the assignment deletion request.

Link to this function

describe_application(client, input, options \\ [])

View Source

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

Link to this function

describe_application_assignment(client, input, options \\ [])

View Source

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.

Link to this function

describe_application_provider(client, input, options \\ [])

View Source

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.

Link to this function

describe_instance(client, input, options \\ [])

View Source

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.

Link to this function

describe_instance_access_control_attribute_configuration(client, input, options \\ [])

View Source

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.

Link to this function

describe_permission_set(client, input, options \\ [])

View Source

Gets the details of the permission set.

Link to this function

describe_permission_set_provisioning_status(client, input, options \\ [])

View Source

Describes the status for the given permission set provisioning request.

Link to this function

describe_trusted_token_issuer(client, input, options \\ [])

View Source

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.

Link to this function

detach_customer_managed_policy_reference_from_permission_set(client, input, options \\ [])

View Source

Detaches the specified customer managed policy from the specified PermissionSet.

Link to this function

detach_managed_policy_from_permission_set(client, input, options \\ [])

View Source

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

Link to this function

get_application_access_scope(client, input, options \\ [])

View Source

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

Link to this function

get_application_assignment_configuration(client, input, options \\ [])

View Source

Retrieves the configuration of PutApplicationAssignmentConfiguration.

Link to this function

get_application_authentication_method(client, input, options \\ [])

View Source

Retrieves details about an authentication method used by an application.

Link to this function

get_application_grant(client, input, options \\ [])

View Source

Retrieves details about an application grant.

Link to this function

get_inline_policy_for_permission_set(client, input, options \\ [])

View Source

Obtains the inline policy assigned to the permission set.

Link to this function

get_permissions_boundary_for_permission_set(client, input, options \\ [])

View Source

Obtains the permissions boundary for a specified PermissionSet.

Link to this function

list_account_assignment_creation_status(client, input, options \\ [])

View Source

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

Link to this function

list_account_assignment_deletion_status(client, input, options \\ [])

View Source

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

Link to this function

list_account_assignments(client, input, options \\ [])

View Source

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

Link to this function

list_account_assignments_for_principal(client, input, options \\ [])

View Source

Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.

Link to this function

list_accounts_for_provisioned_permission_set(client, input, options \\ [])

View Source

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

Link to this function

list_application_access_scopes(client, input, options \\ [])

View Source

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

Link to this function

list_application_assignments(client, input, options \\ [])

View Source

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

Link to this function

list_application_assignments_for_principal(client, input, options \\ [])

View Source

Lists the applications to which a specified principal is assigned.

Link to this function

list_application_authentication_methods(client, input, options \\ [])

View Source

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

Link to this function

list_application_grants(client, input, options \\ [])

View Source

List the grants associated with an application.

Link to this function

list_application_providers(client, input, options \\ [])

View Source

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

Link to this function

list_applications(client, input, options \\ [])

View Source

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.

Link to this function

list_customer_managed_policy_references_in_permission_set(client, input, options \\ [])

View Source

Lists all customer managed policies attached to a specified PermissionSet.

Link to this function

list_instances(client, input, options \\ [])

View Source

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.

Link to this function

list_managed_policies_in_permission_set(client, input, options \\ [])

View Source

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

Link to this function

list_permission_set_provisioning_status(client, input, options \\ [])

View Source

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

Link to this function

list_permission_sets(client, input, options \\ [])

View Source

Lists the PermissionSets in an IAM Identity Center instance.

Link to this function

list_permission_sets_provisioned_to_account(client, input, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists the tags that are attached to a specified resource.

Link to this function

list_trusted_token_issuers(client, input, options \\ [])

View Source

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

Link to this function

metadata()

View Source
Link to this function

provision_permission_set(client, input, options \\ [])

View Source

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

Link to this function

put_application_access_scope(client, input, options \\ [])

View Source

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

Link to this function

put_application_assignment_configuration(client, input, options \\ [])

View Source

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.

Link to this function

put_application_authentication_method(client, input, options \\ [])

View Source

Adds or updates an authentication method for an application.

Link to this function

put_application_grant(client, input, options \\ [])

View Source

Adds a grant to an application.

Link to this function

put_inline_policy_to_permission_set(client, input, options \\ [])

View Source

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.

Link to this function

put_permissions_boundary_to_permission_set(client, input, options \\ [])

View Source

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

Link to this function

tag_resource(client, input, options \\ [])

View Source

Associates a set of tags with a specified resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Disassociates a set of tags from a specified resource.

Link to this function

update_application(client, input, options \\ [])

View Source

Updates application properties.

Link to this function

update_instance(client, input, options \\ [])

View Source

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

Link to this function

update_instance_access_control_attribute_configuration(client, input, options \\ [])

View Source

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.

Link to this function

update_permission_set(client, input, options \\ [])

View Source

Updates an existing permission set.

Link to this function

update_trusted_token_issuer(client, input, options \\ [])

View Source

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.