View Source AWS.Identitystore (aws-elixir 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.
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.
Link to this section 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.
Link to this section Functions
Creates a group within the specified identity store.
Creates a relationship between a member and a group.
The following identifiers must be specified: GroupId, IdentityStoreId, and
MemberId.
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.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
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 in the Organizations User Guide.
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 in the Organizations User Guide.
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 in the Organizations User Guide.
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 in the Organizations User Guide.
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 in the Organizations User Guide.
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 in the Organizations User Guide.
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 in the Organizations User Guide.
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 in the Organizations User Guide.
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 in the Organizations User Guide.
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 in the Organizations User Guide.
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.