identitystore/aws.sdk.kotlin.services.identitystore/IdentitystoreClient

IdentitystoreClient

interface IdentitystoreClient : SdkClient

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.

Properties

Link copied to clipboard
abstract override val config: IdentitystoreClient.Config

IdentitystoreClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createGroup(input: CreateGroupRequest): CreateGroupResponse

Creates a group within the specified identity store.

Link copied to clipboard
abstract suspend fun createGroupMembership(input: CreateGroupMembershipRequest): CreateGroupMembershipResponse

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

Link copied to clipboard
abstract suspend fun createUser(input: CreateUserRequest): CreateUserResponse

Creates a user within the specified identity store.

Link copied to clipboard
abstract suspend fun deleteGroup(input: DeleteGroupRequest): DeleteGroupResponse

Delete a group within an identity store given GroupId.

Link copied to clipboard
abstract suspend fun deleteGroupMembership(input: DeleteGroupMembershipRequest): DeleteGroupMembershipResponse

Delete a membership within a group given MembershipId.

Link copied to clipboard
abstract suspend fun deleteUser(input: DeleteUserRequest): DeleteUserResponse

Deletes a user within an identity store given UserId.

Link copied to clipboard
abstract suspend fun describeGroup(input: DescribeGroupRequest): DescribeGroupResponse

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

Link copied to clipboard
abstract suspend fun describeGroupMembership(input: DescribeGroupMembershipRequest): DescribeGroupMembershipResponse

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

Link copied to clipboard
abstract suspend fun describeUser(input: DescribeUserRequest): DescribeUserResponse

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

Link copied to clipboard
abstract suspend fun getGroupId(input: GetGroupIdRequest): GetGroupIdResponse

Retrieves GroupId in an identity store.

Link copied to clipboard
abstract suspend fun getGroupMembershipId(input: GetGroupMembershipIdRequest): GetGroupMembershipIdResponse

Retrieves the MembershipId in an identity store.

Link copied to clipboard
abstract suspend fun getUserId(input: GetUserIdRequest): GetUserIdResponse

Retrieves the UserId in an identity store.

Link copied to clipboard
abstract suspend fun isMemberInGroups(input: IsMemberInGroupsRequest): IsMemberInGroupsResponse

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

Link copied to clipboard
abstract suspend fun listGroupMemberships(input: ListGroupMembershipsRequest): ListGroupMembershipsResponse

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

Link copied to clipboard
abstract suspend fun listGroupMembershipsForMember(input: ListGroupMembershipsForMemberRequest): ListGroupMembershipsForMemberResponse

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

Link copied to clipboard
abstract suspend fun listGroups(input: ListGroupsRequest): ListGroupsResponse

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.

Link copied to clipboard
abstract suspend fun listUsers(input: ListUsersRequest): ListUsersResponse

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.

Link copied to clipboard
abstract suspend fun updateGroup(input: UpdateGroupRequest): UpdateGroupResponse

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

Link copied to clipboard
abstract suspend fun updateUser(input: UpdateUserRequest): UpdateUserResponse

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

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun IdentitystoreClient.createGroup(crossinline block: CreateGroupRequest.Builder.() -> Unit): CreateGroupResponse

Creates a group within the specified identity store.

Link copied to clipboard
inline suspend fun IdentitystoreClient.createGroupMembership(crossinline block: CreateGroupMembershipRequest.Builder.() -> Unit): CreateGroupMembershipResponse

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

Link copied to clipboard
inline suspend fun IdentitystoreClient.createUser(crossinline block: CreateUserRequest.Builder.() -> Unit): CreateUserResponse

Creates a user within the specified identity store.

Link copied to clipboard
inline suspend fun IdentitystoreClient.deleteGroup(crossinline block: DeleteGroupRequest.Builder.() -> Unit): DeleteGroupResponse

Delete a group within an identity store given GroupId.

Link copied to clipboard
inline suspend fun IdentitystoreClient.deleteGroupMembership(crossinline block: DeleteGroupMembershipRequest.Builder.() -> Unit): DeleteGroupMembershipResponse

Delete a membership within a group given MembershipId.

Link copied to clipboard
inline suspend fun IdentitystoreClient.deleteUser(crossinline block: DeleteUserRequest.Builder.() -> Unit): DeleteUserResponse

Deletes a user within an identity store given UserId.

Link copied to clipboard
inline suspend fun IdentitystoreClient.describeGroup(crossinline block: DescribeGroupRequest.Builder.() -> Unit): DescribeGroupResponse

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

Link copied to clipboard
inline suspend fun IdentitystoreClient.describeGroupMembership(crossinline block: DescribeGroupMembershipRequest.Builder.() -> Unit): DescribeGroupMembershipResponse

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

Link copied to clipboard
inline suspend fun IdentitystoreClient.describeUser(crossinline block: DescribeUserRequest.Builder.() -> Unit): DescribeUserResponse

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

Link copied to clipboard
inline suspend fun IdentitystoreClient.getGroupId(crossinline block: GetGroupIdRequest.Builder.() -> Unit): GetGroupIdResponse

Retrieves GroupId in an identity store.

Link copied to clipboard
inline suspend fun IdentitystoreClient.getGroupMembershipId(crossinline block: GetGroupMembershipIdRequest.Builder.() -> Unit): GetGroupMembershipIdResponse

Retrieves the MembershipId in an identity store.

Link copied to clipboard
inline suspend fun IdentitystoreClient.getUserId(crossinline block: GetUserIdRequest.Builder.() -> Unit): GetUserIdResponse

Retrieves the UserId in an identity store.

Link copied to clipboard
inline suspend fun IdentitystoreClient.isMemberInGroups(crossinline block: IsMemberInGroupsRequest.Builder.() -> Unit): IsMemberInGroupsResponse

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

Link copied to clipboard
inline suspend fun IdentitystoreClient.listGroupMemberships(crossinline block: ListGroupMembershipsRequest.Builder.() -> Unit): ListGroupMembershipsResponse

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

Link copied to clipboard
inline suspend fun IdentitystoreClient.listGroupMembershipsForMember(crossinline block: ListGroupMembershipsForMemberRequest.Builder.() -> Unit): ListGroupMembershipsForMemberResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun IdentitystoreClient.listGroups(crossinline block: ListGroupsRequest.Builder.() -> Unit): ListGroupsResponse

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.

Link copied to clipboard
inline suspend fun IdentitystoreClient.listUsers(crossinline block: ListUsersRequest.Builder.() -> Unit): ListUsersResponse

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.

Link copied to clipboard
inline suspend fun IdentitystoreClient.updateGroup(crossinline block: UpdateGroupRequest.Builder.() -> Unit): UpdateGroupResponse

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

Link copied to clipboard
inline suspend fun IdentitystoreClient.updateUser(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse

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

Link copied to clipboard
fun IdentitystoreClient.withConfig(block: IdentitystoreClient.Config.Builder.() -> Unit): IdentitystoreClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.