View Source AWS.Identitystore (aws-elixir v0.13.1)
The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of your identities (users and groups).
For more information, see the IAM Identity Center User Guide.
Although AWS Single Sign-On was renamed, the
ssoand
identitystoreAPI namespaces will continue to retain their original name for backward compatibility purposes. For more information, see [IAM Identity Center rename](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed). This reference guide describes the identity store operations that you can call programatically and includes detailed information on data types and errors.
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 new 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 the attribute name and value of the group that you specified in the search.
Lists the attribute name and value of the user that you specified in the search.
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 new 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 the attribute name and value of the group that you specified in the search.
We only support DisplayName
as a valid filter attribute path currently, and
filter is required. This API returns minimum attributes, including GroupId
and
group DisplayName
in the response.
Lists the attribute name and value of the user that you specified in the search.
We only support UserName
as a valid filter attribute path currently, and
filter is required. This API returns minimum attributes, including UserId
and
UserName
in the response.
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.