Class: AWS.IdentityStore

var params = {
  GroupId: 'STRING_VALUE', /* required */
  IdentityStoreId: 'STRING_VALUE', /* required */
  MemberId: { /* required */
    UserId: 'STRING_VALUE'
  }
};
identitystore.createGroupMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • GroupId — (String)

    The identifier for a group in the identity store.

  • MemberId — (map)

    An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

    • UserId — (String)

      An object containing the identifiers of resources that can be members.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MembershipId — (String)

      The identifier for a newly created GroupMembership in an identity store.

    • IdentityStoreId — (String)

      The globally unique identifier for the identity store.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IdentityStoreId: 'STRING_VALUE', /* required */
  Addresses: [
    {
      Country: 'STRING_VALUE',
      Formatted: 'STRING_VALUE',
      Locality: 'STRING_VALUE',
      PostalCode: 'STRING_VALUE',
      Primary: true || false,
      Region: 'STRING_VALUE',
      StreetAddress: 'STRING_VALUE',
      Type: 'STRING_VALUE'
    },
    /* more items */
  ],
  DisplayName: 'STRING_VALUE',
  Emails: [
    {
      Primary: true || false,
      Type: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  Locale: 'STRING_VALUE',
  Name: {
    FamilyName: 'STRING_VALUE',
    Formatted: 'STRING_VALUE',
    GivenName: 'STRING_VALUE',
    HonorificPrefix: 'STRING_VALUE',
    HonorificSuffix: 'STRING_VALUE',
    MiddleName: 'STRING_VALUE'
  },
  NickName: 'STRING_VALUE',
  PhoneNumbers: [
    {
      Primary: true || false,
      Type: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  PreferredLanguage: 'STRING_VALUE',
  ProfileUrl: 'STRING_VALUE',
  Timezone: 'STRING_VALUE',
  Title: 'STRING_VALUE',
  UserName: 'STRING_VALUE',
  UserType: 'STRING_VALUE'
};
identitystore.createUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • UserName — (String)

    A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.

  • Name — (map)

    An object containing the name of the user.

    • Formatted — (String)

      A string containing a formatted version of the name for display.

    • FamilyName — (String)

      The family name of the user.

    • GivenName — (String)

      The given name of the user.

    • MiddleName — (String)

      The middle name of the user.

    • HonorificPrefix — (String)

      The honorific prefix of the user. For example, "Dr."

    • HonorificSuffix — (String)

      The honorific suffix of the user. For example, "M.D."

  • DisplayName — (String)

    A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe."

  • NickName — (String)

    A string containing an alternate name for the user.

  • ProfileUrl — (String)

    A string containing a URL that might be associated with the user.

  • Emails — (Array<map>)

    A list of Email objects containing email addresses associated with the user.

    • Value — (String)

      A string containing an email address. For example, "johndoe@amazon.com."

    • Type — (String)

      A string representing the type of address. For example, "Work."

    • Primary — (Boolean)

      A Boolean value representing whether this is the primary email address for the associated resource.

  • Addresses — (Array<map>)

    A list of Address objects containing addresses associated with the user.

    • StreetAddress — (String)

      The street of the address.

    • Locality — (String)

      A string of the address locality.

    • Region — (String)

      The region of the address.

    • PostalCode — (String)

      The postal code of the address.

    • Country — (String)

      The country of the address.

    • Formatted — (String)

      A string containing a formatted version of the address for display.

    • Type — (String)

      A string representing the type of address. For example, "Home."

    • Primary — (Boolean)

      A Boolean value representing whether this is the primary address for the associated resource.

  • PhoneNumbers — (Array<map>)

    A list of PhoneNumber objects containing phone numbers associated with the user.

    • Value — (String)

      A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".

    • Type — (String)

      A string representing the type of a phone number. For example, "Mobile."

    • Primary — (Boolean)

      A Boolean value representing whether this is the primary phone number for the associated resource.

  • UserType — (String)

    A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

  • Title — (String)

    A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

  • PreferredLanguage — (String)

    A string containing the preferred language of the user. For example, "American English" or "en-us."

  • Locale — (String)

    A string containing the geographical region or location of the user.

  • Timezone — (String)

    A string containing the time zone of the user.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UserId — (String)

      The identifier of the newly created user in the identity store.

    • IdentityStoreId — (String)

      The globally unique identifier for the identity store.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupId: 'STRING_VALUE', /* required */
  IdentityStoreId: 'STRING_VALUE' /* required */
};
identitystore.deleteGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • GroupId — (String)

    The identifier for a group in the identity store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IdentityStoreId: 'STRING_VALUE', /* required */
  MembershipId: 'STRING_VALUE' /* required */
};
identitystore.deleteGroupMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • MembershipId — (String)

    The identifier for a GroupMembership in an identity store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IdentityStoreId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
identitystore.deleteUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • UserId — (String)

    The identifier for a user in the identity store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupId: 'STRING_VALUE', /* required */
  IdentityStoreId: 'STRING_VALUE' /* required */
};
identitystore.describeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

  • GroupId — (String)

    The identifier for a group in the identity store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GroupId — (String)

      The identifier for a group in the identity store.

    • DisplayName — (String)

      The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.

    • ExternalIds — (Array<map>)

      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

      • Issuer — required — (String)

        The issuer for an external identifier.

      • Id — required — (String)

        The identifier issued to this resource by an external identity provider.

    • Description — (String)

      A string containing a description of the group.

    • IdentityStoreId — (String)

      The globally unique identifier for the identity store.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IdentityStoreId: 'STRING_VALUE', /* required */
  MembershipId: 'STRING_VALUE' /* required */
};
identitystore.describeGroupMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • MembershipId — (String)

    The identifier for a GroupMembership in an identity store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • IdentityStoreId — (String)

      The globally unique identifier for the identity store.

    • MembershipId — (String)

      The identifier for a GroupMembership in an identity store.

    • GroupId — (String)

      The identifier for a group in the identity store.

    • MemberId — (map)

      An object containing the identifier of a group member.

      • UserId — (String)

        An object containing the identifiers of resources that can be members.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IdentityStoreId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
identitystore.describeUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

  • UserId — (String)

    The identifier for a user in the identity store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UserName — (String)

      A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

    • UserId — (String)

      The identifier for a user in the identity store.

    • ExternalIds — (Array<map>)

      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

      • Issuer — required — (String)

        The issuer for an external identifier.

      • Id — required — (String)

        The identifier issued to this resource by an external identity provider.

    • Name — (map)

      The name of the user.

      • Formatted — (String)

        A string containing a formatted version of the name for display.

      • FamilyName — (String)

        The family name of the user.

      • GivenName — (String)

        The given name of the user.

      • MiddleName — (String)

        The middle name of the user.

      • HonorificPrefix — (String)

        The honorific prefix of the user. For example, "Dr."

      • HonorificSuffix — (String)

        The honorific suffix of the user. For example, "M.D."

    • DisplayName — (String)

      The display name of the user.

    • NickName — (String)

      An alternative descriptive name for the user.

    • ProfileUrl — (String)

      A URL link for the user's profile.

    • Emails — (Array<map>)

      The email address of the user.

      • Value — (String)

        A string containing an email address. For example, "johndoe@amazon.com."

      • Type — (String)

        A string representing the type of address. For example, "Work."

      • Primary — (Boolean)

        A Boolean value representing whether this is the primary email address for the associated resource.

    • Addresses — (Array<map>)

      The physical address of the user.

      • StreetAddress — (String)

        The street of the address.

      • Locality — (String)

        A string of the address locality.

      • Region — (String)

        The region of the address.

      • PostalCode — (String)

        The postal code of the address.

      • Country — (String)

        The country of the address.

      • Formatted — (String)

        A string containing a formatted version of the address for display.

      • Type — (String)

        A string representing the type of address. For example, "Home."

      • Primary — (Boolean)

        A Boolean value representing whether this is the primary address for the associated resource.

    • PhoneNumbers — (Array<map>)

      A list of PhoneNumber objects associated with a user.

      • Value — (String)

        A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".

      • Type — (String)

        A string representing the type of a phone number. For example, "Mobile."

      • Primary — (Boolean)

        A Boolean value representing whether this is the primary phone number for the associated resource.

    • UserType — (String)

      A string indicating the type of user.

    • Title — (String)

      A string containing the title of the user.

    • PreferredLanguage — (String)

      The preferred language of the user.

    • Locale — (String)

      A string containing the geographical region or location of the user.

    • Timezone — (String)

      The time zone for a user.

    • IdentityStoreId — (String)

      The globally unique identifier for the identity store.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AlternateIdentifier: { /* required */
    ExternalId: {
      Id: 'STRING_VALUE', /* required */
      Issuer: 'STRING_VALUE' /* required */
    },
    UniqueAttribute: {
      AttributePath: 'STRING_VALUE', /* required */
      AttributeValue: { /* required */
      }
    }
  },
  IdentityStoreId: 'STRING_VALUE' /* required */
};
identitystore.getGroupId(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • AlternateIdentifier — (map)

    A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is displayName.

    • ExternalId — (map)

      The identifier issued to this resource by an external identity provider.

      • Issuer — required — (String)

        The issuer for an external identifier.

      • Id — required — (String)

        The identifier issued to this resource by an external identity provider.

    • UniqueAttribute — (map)

      An entity attribute that's unique to a specific entity.

      • AttributePath — required — (String)

        A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

      • AttributeValue — required — (map)

        The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GroupId — (String)

      The identifier for a group in the identity store.

    • IdentityStoreId — (String)

      The globally unique identifier for the identity store.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupId: 'STRING_VALUE', /* required */
  IdentityStoreId: 'STRING_VALUE', /* required */
  MemberId: { /* required */
    UserId: 'STRING_VALUE'
  }
};
identitystore.getGroupMembershipId(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • GroupId — (String)

    The identifier for a group in the identity store.

  • MemberId — (map)

    An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

    • UserId — (String)

      An object containing the identifiers of resources that can be members.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MembershipId — (String)

      The identifier for a GroupMembership in an identity store.

    • IdentityStoreId — (String)

      The globally unique identifier for the identity store.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AlternateIdentifier: { /* required */
    ExternalId: {
      Id: 'STRING_VALUE', /* required */
      Issuer: 'STRING_VALUE' /* required */
    },
    UniqueAttribute: {
      AttributePath: 'STRING_VALUE', /* required */
      AttributeValue: { /* required */
      }
    }
  },
  IdentityStoreId: 'STRING_VALUE' /* required */
};
identitystore.getUserId(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • AlternateIdentifier — (map)

    A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid paths are userName and emails.value.

    • ExternalId — (map)

      The identifier issued to this resource by an external identity provider.

      • Issuer — required — (String)

        The issuer for an external identifier.

      • Id — required — (String)

        The identifier issued to this resource by an external identity provider.

    • UniqueAttribute — (map)

      An entity attribute that's unique to a specific entity.

      • AttributePath — required — (String)

        A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

      • AttributeValue — required — (map)

        The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UserId — (String)

      The identifier for a user in the identity store.

    • IdentityStoreId — (String)

      The globally unique identifier for the identity store.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  IdentityStoreId: 'STRING_VALUE', /* required */
  MemberId: { /* required */
    UserId: 'STRING_VALUE'
  }
};
identitystore.isMemberInGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • MemberId — (map)

    An object containing the identifier of a group member.

    • UserId — (String)

      An object containing the identifiers of resources that can be members.

  • GroupIds — (Array<String>)

    A list of identifiers for groups in the identity store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Results — (Array<map>)

      A list containing the results of membership existence checks.

      • GroupId — (String)

        The identifier for a group in the identity store.

      • MemberId — (map)

        An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

        • UserId — (String)

          An object containing the identifiers of resources that can be members.

      • MembershipExists — (Boolean)

        Indicates whether a membership relation exists or not.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupId: 'STRING_VALUE', /* required */
  IdentityStoreId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
identitystore.listGroupMemberships(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • GroupId — (String)

    The identifier for a group in the identity store.

  • MaxResults — (Integer)

    The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.

  • NextToken — (String)

    The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GroupMemberships — (Array<map>)

      A list of GroupMembership objects in the group.

      • IdentityStoreId — required — (String)

        The globally unique identifier for the identity store.

      • MembershipId — (String)

        The identifier for a GroupMembership object in an identity store.

      • GroupId — (String)

        The identifier for a group in the identity store.

      • MemberId — (map)

        An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

        • UserId — (String)

          An object containing the identifiers of resources that can be members.

    • NextToken — (String)

      The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IdentityStoreId: 'STRING_VALUE', /* required */
  MemberId: { /* required */
    UserId: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
identitystore.listGroupMembershipsForMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • MemberId — (map)

    An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

    • UserId — (String)

      An object containing the identifiers of resources that can be members.

  • MaxResults — (Integer)

    The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

  • NextToken — (String)

    The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GroupMemberships — (Array<map>)

      A list of GroupMembership objects in the group for a specified member.

      • IdentityStoreId — required — (String)

        The globally unique identifier for the identity store.

      • MembershipId — (String)

        The identifier for a GroupMembership object in an identity store.

      • GroupId — (String)

        The identifier for a group in the identity store.

      • MemberId — (map)

        An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

        • UserId — (String)

          An object containing the identifiers of resources that can be members.

    • NextToken — (String)

      The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IdentityStoreId: 'STRING_VALUE', /* required */
  Filters: [
    {
      AttributePath: 'STRING_VALUE', /* required */
      AttributeValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
identitystore.listGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

  • MaxResults — (Integer)

    The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

  • NextToken — (String)

    The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

  • Filters — (Array<map>)

    A list of Filter objects, which is used in the ListUsers and ListGroups requests.

    • AttributePath — required — (String)

      The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

    • AttributeValue — required — (String)

      Represents the data for an attribute. Each attribute value is described as a name-value pair.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Groups — (Array<map>)

      A list of Group objects in the identity store.

      • GroupId — required — (String)

        The identifier for a group in the identity store.

      • DisplayName — (String)

        The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

      • ExternalIds — (Array<map>)

        A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

        • Issuer — required — (String)

          The issuer for an external identifier.

        • Id — required — (String)

          The identifier issued to this resource by an external identity provider.

      • Description — (String)

        A string containing a description of the specified group.

      • IdentityStoreId — required — (String)

        The globally unique identifier for the identity store.

    • NextToken — (String)

      The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IdentityStoreId: 'STRING_VALUE', /* required */
  Filters: [
    {
      AttributePath: 'STRING_VALUE', /* required */
      AttributeValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
identitystore.listUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

  • MaxResults — (Integer)

    The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

  • NextToken — (String)

    The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

  • Filters — (Array<map>)

    A list of Filter objects, which is used in the ListUsers and ListGroups requests.

    • AttributePath — required — (String)

      The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

    • AttributeValue — required — (String)

      Represents the data for an attribute. Each attribute value is described as a name-value pair.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Users — (Array<map>)

      A list of User objects in the identity store.

      • UserName — (String)

        A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

      • UserId — required — (String)

        The identifier for a user in the identity store.

      • ExternalIds — (Array<map>)

        A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

        • Issuer — required — (String)

          The issuer for an external identifier.

        • Id — required — (String)

          The identifier issued to this resource by an external identity provider.

      • Name — (map)

        An object containing the name of the user.

        • Formatted — (String)

          A string containing a formatted version of the name for display.

        • FamilyName — (String)

          The family name of the user.

        • GivenName — (String)

          The given name of the user.

        • MiddleName — (String)

          The middle name of the user.

        • HonorificPrefix — (String)

          The honorific prefix of the user. For example, "Dr."

        • HonorificSuffix — (String)

          The honorific suffix of the user. For example, "M.D."

      • DisplayName — (String)

        A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

      • NickName — (String)

        A string containing an alternate name for the user.

      • ProfileUrl — (String)

        A string containing a URL that might be associated with the user.

      • Emails — (Array<map>)

        A list of Email objects containing email addresses associated with the user.

        • Value — (String)

          A string containing an email address. For example, "johndoe@amazon.com."

        • Type — (String)

          A string representing the type of address. For example, "Work."

        • Primary — (Boolean)

          A Boolean value representing whether this is the primary email address for the associated resource.

      • Addresses — (Array<map>)

        A list of Address objects containing addresses associated with the user.

        • StreetAddress — (String)

          The street of the address.

        • Locality — (String)

          A string of the address locality.

        • Region — (String)

          The region of the address.

        • PostalCode — (String)

          The postal code of the address.

        • Country — (String)

          The country of the address.

        • Formatted — (String)

          A string containing a formatted version of the address for display.

        • Type — (String)

          A string representing the type of address. For example, "Home."

        • Primary — (Boolean)

          A Boolean value representing whether this is the primary address for the associated resource.

      • PhoneNumbers — (Array<map>)

        A list of PhoneNumber objects containing phone numbers associated with the user.

        • Value — (String)

          A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".

        • Type — (String)

          A string representing the type of a phone number. For example, "Mobile."

        • Primary — (Boolean)

          A Boolean value representing whether this is the primary phone number for the associated resource.

      • UserType — (String)

        A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

      • Title — (String)

        A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

      • PreferredLanguage — (String)

        A string containing the preferred language of the user. For example, "American English" or "en-us."

      • Locale — (String)

        A string containing the geographical region or location of the user.

      • Timezone — (String)

        A string containing the time zone of the user.

      • IdentityStoreId — required — (String)

        The globally unique identifier for the identity store.

    • NextToken — (String)

      The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupId: 'STRING_VALUE', /* required */
  IdentityStoreId: 'STRING_VALUE', /* required */
  Operations: [ /* required */
    {
      AttributePath: 'STRING_VALUE', /* required */
      AttributeValue: {
      }
    },
    /* more items */
  ]
};
identitystore.updateGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • GroupId — (String)

    The identifier for a group in the identity store.

  • Operations — (Array<map>)

    A list of AttributeOperation objects to apply to the requested group. These operations might add, replace, or remove an attribute.

    • AttributePath — required — (String)

      A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

    • AttributeValue — (map)

      The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IdentityStoreId: 'STRING_VALUE', /* required */
  Operations: [ /* required */
    {
      AttributePath: 'STRING_VALUE', /* required */
      AttributeValue: {
      }
    },
    /* more items */
  ],
  UserId: 'STRING_VALUE' /* required */
};
identitystore.updateUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IdentityStoreId — (String)

    The globally unique identifier for the identity store.

  • UserId — (String)

    The identifier for a user in the identity store.

  • Operations — (Array<map>)

    A list of AttributeOperation objects to apply to the requested user. These operations might add, replace, or remove an attribute.

    • AttributePath — required — (String)

      A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

    • AttributeValue — (map)

      The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.