(constructor)

[configuration]

Constructs a new instance of the <code>IdentitystoreClient</code> class

config

The resolved configuration of IdentitystoreClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-identitystore!IdentitystoreClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

IdentitystoreClient

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 <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User Guide</a>. This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors. <note> IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. </note>

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

profile

Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

CreateGroupCommand

Creates a group within the specified identity store.

CreateGroupMembershipCommand

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

CreateUserCommand

Creates a user within the specified identity store.

DeleteGroupCommand

Delete a group within an identity store given <code>GroupId</code>.

DeleteGroupMembershipCommand

Delete a membership within a group given <code>MembershipId</code>.

DeleteUserCommand

Deletes a user within an identity store given <code>UserId</code>.

DescribeGroupCommand

Retrieves the group metadata and attributes from <code>GroupId</code> in an identity store. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

DescribeGroupMembershipCommand

Retrieves membership metadata and attributes from <code>MembershipId</code> in an identity store. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

DescribeUserCommand

Retrieves the user metadata and attributes from the <code>UserId</code> in an identity store. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

GetGroupIdCommand

Retrieves <code>GroupId</code> in an identity store. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

GetGroupMembershipIdCommand

Retrieves the <code>MembershipId</code> in an identity store. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

GetUserIdCommand

Retrieves the <code>UserId</code> in an identity store. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

IsMemberInGroupsCommand

Checks the user's membership in all requested groups and returns if the member exists in all queried groups. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

ListGroupMembershipsCommand

For the specified group in the specified identity store, returns the list of all <code>GroupMembership</code> objects and returns results in paginated form. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

ListGroupMembershipsForMemberCommand

For the specified member in the specified identity store, returns the list of all <code>GroupMembership</code> objects and returns results in paginated form. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

ListGroupsCommand

Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects. Filtering for a <code>Group</code> by the <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

ListUsersCommand

Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects. Filtering for a <code>User</code> by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action. <note> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the Organizations User Guide. </note>

UpdateGroupCommand

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

UpdateUserCommand

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