View Source aws_identitystore (aws v1.0.4)

The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups).

For more information, see the IAM Identity Center User Guide: https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html.

This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.

IAM Identity Center uses the sso and identitystore API namespaces.

Summary

Functions

Creates a group within the specified identity store.

Creates a relationship between a member and a group.

Creates a user within the specified identity store.
Delete a group within an identity store given GroupId.
Delete a membership within a group given MembershipId.
Deletes a user within an identity store given UserId.

Retrieves the group metadata and attributes from GroupId in an identity store.

Retrieves membership metadata and attributes from MembershipId in an identity store.

Retrieves the user metadata and attributes from the UserId in an identity store.

Retrieves GroupId in an identity store.

Retrieves the MembershipId in an identity store.

Retrieves the UserId in an identity store.

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

Lists all groups in the identity store.

Lists all users in the identity store.

For the specified group in the specified identity store, updates the group metadata and attributes.
For the specified user in the specified identity store, updates the user metadata and attributes.

Functions

Link to this function

create_group(Client, Input)

View Source
Creates a group within the specified identity store.
Link to this function

create_group(Client, Input, Options)

View Source
Link to this function

create_group_membership(Client, Input)

View Source

Creates a relationship between a member and a group.

The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.
Link to this function

create_group_membership(Client, Input, Options)

View Source
Link to this function

create_user(Client, Input)

View Source
Creates a user within the specified identity store.
Link to this function

create_user(Client, Input, Options)

View Source
Link to this function

delete_group(Client, Input)

View Source
Delete a group within an identity store given GroupId.
Link to this function

delete_group(Client, Input, Options)

View Source
Link to this function

delete_group_membership(Client, Input)

View Source
Delete a membership within a group given MembershipId.
Link to this function

delete_group_membership(Client, Input, Options)

View Source
Link to this function

delete_user(Client, Input)

View Source
Deletes a user within an identity store given UserId.
Link to this function

delete_user(Client, Input, Options)

View Source
Link to this function

describe_group(Client, Input)

View Source

Retrieves the group metadata and attributes from GroupId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

describe_group(Client, Input, Options)

View Source
Link to this function

describe_group_membership(Client, Input)

View Source

Retrieves membership metadata and attributes from MembershipId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

describe_group_membership(Client, Input, Options)

View Source
Link to this function

describe_user(Client, Input)

View Source

Retrieves the user metadata and attributes from the UserId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

describe_user(Client, Input, Options)

View Source
Link to this function

get_group_id(Client, Input)

View Source

Retrieves GroupId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

get_group_id(Client, Input, Options)

View Source
Link to this function

get_group_membership_id(Client, Input)

View Source

Retrieves the MembershipId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

get_group_membership_id(Client, Input, Options)

View Source
Link to this function

get_user_id(Client, Input)

View Source

Retrieves the UserId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

get_user_id(Client, Input, Options)

View Source
Link to this function

is_member_in_groups(Client, Input)

View Source

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

is_member_in_groups(Client, Input, Options)

View Source
Link to this function

list_group_memberships(Client, Input)

View Source

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

list_group_memberships(Client, Input, Options)

View Source
Link to this function

list_group_memberships_for_member(Client, Input)

View Source

For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

list_group_memberships_for_member(Client, Input, Options)

View Source
Link to this function

list_groups(Client, Input)

View Source

Lists all groups in the identity store.

Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

list_groups(Client, Input, Options)

View Source
Link to this function

list_users(Client, Input)

View Source

Lists all users in the identity store.

Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html in the Organizations User Guide.
Link to this function

list_users(Client, Input, Options)

View Source
Link to this function

update_group(Client, Input)

View Source
For the specified group in the specified identity store, updates the group metadata and attributes.
Link to this function

update_group(Client, Input, Options)

View Source
Link to this function

update_user(Client, Input)

View Source
For the specified user in the specified identity store, updates the user metadata and attributes.
Link to this function

update_user(Client, Input, Options)

View Source