AWS.IdentityStore — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Note: IAM Identity Center uses the sso and identitystore API namespaces.

Sending a Request Using IdentityStore

var identitystore = new AWS.IdentityStore();
identitystore.createGroup(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the IdentityStore object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var identitystore = new AWS.IdentityStore({apiVersion: '2020-06-15'});

You can also set the API version globally in AWS.config.apiVersions using the identitystore service identifier:

AWS.config.apiVersions = {
  identitystore: '2020-06-15',
  // other service API versions
};

var identitystore = new AWS.IdentityStore();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.IdentityStore(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createGroup(params = {}, callback) ⇒ AWS.Request

Creates a group within the specified identity store.

createGroupMembership(params = {}, callback) ⇒ AWS.Request

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

createUser(params = {}, callback) ⇒ AWS.Request

Creates a user within the specified identity store.

deleteGroup(params = {}, callback) ⇒ AWS.Request

Delete a group within an identity store given GroupId.

deleteGroupMembership(params = {}, callback) ⇒ AWS.Request

Delete a membership within a group given MembershipId.

deleteUser(params = {}, callback) ⇒ AWS.Request

Deletes a user within an identity store given UserId.

describeGroup(params = {}, callback) ⇒ AWS.Request

Retrieves the group metadata and attributes from GroupId 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 member accounts in the Organizations User Guide.

describeGroupMembership(params = {}, callback) ⇒ AWS.Request

Retrieves membership metadata and attributes from MembershipId 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 member accounts in the Organizations User Guide.

describeUser(params = {}, callback) ⇒ AWS.Request

Retrieves the user metadata and attributes from the UserId 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 member accounts in the Organizations User Guide.

getGroupId(params = {}, callback) ⇒ AWS.Request

Retrieves GroupId 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 member accounts in the Organizations User Guide.

getGroupMembershipId(params = {}, callback) ⇒ AWS.Request

Retrieves the MembershipId 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 member accounts in the Organizations User Guide.

getUserId(params = {}, callback) ⇒ AWS.Request

Retrieves the UserId 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 member accounts in the Organizations User Guide.

isMemberInGroups(params = {}, callback) ⇒ AWS.Request

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 member accounts in the Organizations User Guide.

listGroupMemberships(params = {}, callback) ⇒ AWS.Request

For the specified group in the specified identity store, returns the list of all GroupMembership 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 member accounts in the Organizations User Guide.

listGroupMembershipsForMember(params = {}, callback) ⇒ AWS.Request

For the specified member in the specified identity store, returns the list of all GroupMembership 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 member accounts in the Organizations User Guide.

listGroups(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

listUsers(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

updateGroup(params = {}, callback) ⇒ AWS.Request

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

updateUser(params = {}, callback) ⇒ AWS.Request

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