identitystore/aws.sdk.kotlin.services.identitystore

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createGroup

inline suspend fun IdentitystoreClient.createGroup(crossinline block: CreateGroupRequest.Builder.() -> Unit): CreateGroupResponse

Creates a group within the specified identity store.

createGroupMembership

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.

createUser

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

Creates a user within the specified identity store.

deleteGroup

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

Delete a group within an identity store given GroupId.

deleteGroupMembership

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

Delete a membership within a group given MembershipId.

deleteUser

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

Deletes a user within an identity store given UserId.

describeGroup

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

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

describeGroupMembership

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

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

describeUser

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

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

getGroupId

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

Retrieves GroupId in an identity store.

getGroupMembershipId

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

Retrieves the MembershipId in an identity store.

getUserId

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

Retrieves the UserId in an identity store.

isMemberInGroups

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.

listGroupMemberships

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.

listGroupMembershipsForMember

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.

listGroups

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.

listUsers

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.

updateGroup

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.

updateUser

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.

withConfig

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.