We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
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.

Class: AWS.IdentityStore

Inherits:
AWS.Service show all
Identifier:
identitystore
API Version:
2020-06-15
Defined in:
(unknown)

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();

Version:

  • 2020-06-15

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a IdentityStore object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.IdentityStore.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.IdentityStore.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.IdentityStore.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    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.

Service Reference:

Examples:

Calling the createGroup operation

var params = {
  IdentityStoreId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE'
};
identitystore.createGroup(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.

    • DisplayName — (String)

      A string containing the name of the group. This value is commonly displayed when the group is referenced. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.

    • Description — (String)

      A string containing the description of the group.

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 of the newly created 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.

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

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

Service Reference:

Examples:

Calling the createGroupMembership operation

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.

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

Creates a user within the specified identity store.

Service Reference:

Examples:

Calling the createUser operation

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.

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

Delete a group within an identity store given GroupId.

Service Reference:

Examples:

Calling the deleteGroup operation

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.

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

Delete a membership within a group given MembershipId.

Service Reference:

Examples:

Calling the deleteGroupMembership operation

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.

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

Deletes a user within an identity store given UserId.

Service Reference:

Examples:

Calling the deleteUser operation

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.

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.

Service Reference:

Examples:

Calling the describeGroup operation

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.

        • Issuerrequired — (String)

          The issuer for an external identifier.

        • Idrequired — (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.

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.

Service Reference:

Examples:

Calling the describeGroupMembership operation

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.

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.

Service Reference:

Examples:

Calling the describeUser operation

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.

        • Issuerrequired — (String)

          The issuer for an external identifier.

        • Idrequired — (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.

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.

Service Reference:

Examples:

Calling the getGroupId operation

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.

        • Issuerrequired — (String)

          The issuer for an external identifier.

        • Idrequired — (String)

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

      • UniqueAttribute — (map)

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

        • AttributePathrequired — (String)

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

        • AttributeValuerequired — (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.

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.

Service Reference:

Examples:

Calling the getGroupMembershipId operation

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.

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.

Service Reference:

Examples:

Calling the getUserId operation

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.

        • Issuerrequired — (String)

          The issuer for an external identifier.

        • Idrequired — (String)

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

      • UniqueAttribute — (map)

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

        • AttributePathrequired — (String)

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

        • AttributeValuerequired — (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.

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.

Service Reference:

Examples:

Calling the isMemberInGroups operation

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.

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.

Service Reference:

Examples:

Calling the listGroupMemberships operation

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.

        • IdentityStoreIdrequired — (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.

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.

Service Reference:

Examples:

Calling the listGroupMembershipsForMember operation

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.

        • IdentityStoreIdrequired — (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.

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.

Service Reference:

Examples:

Calling the listGroups operation

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.

      • AttributePathrequired — (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.

      • AttributeValuerequired — (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.

        • GroupIdrequired — (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.

          • Issuerrequired — (String)

            The issuer for an external identifier.

          • Idrequired — (String)

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

        • Description — (String)

          A string containing a description of the specified group.

        • IdentityStoreIdrequired — (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.

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.

Service Reference:

Examples:

Calling the listUsers operation

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.

      • AttributePathrequired — (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.

      • AttributeValuerequired — (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.

        • UserIdrequired — (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.

          • Issuerrequired — (String)

            The issuer for an external identifier.

          • Idrequired — (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.

        • IdentityStoreIdrequired — (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.

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

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

Service Reference:

Examples:

Calling the updateGroup operation

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.

      • AttributePathrequired — (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.

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

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

Service Reference:

Examples:

Calling the updateUser operation

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.

      • AttributePathrequired — (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.