Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeUser

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

Note

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the AWS IAM Identity Center User Guide.

Request Syntax


{
   "IdentityStoreId": "string",
   "UserId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

IdentityStoreId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

UserId

The identifier for a user in the identity store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 47.

Pattern: ([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}

Required: Yes

Response Syntax


{
   "Addresses": [ 
      { 
         "Country": "string",
         "Formatted": "string",
         "Locality": "string",
         "PostalCode": "string",
         "Primary": boolean,
         "Region": "string",
         "StreetAddress": "string",
         "Type": "string"
      }
   ],
   "Birthdate": "string",
   "CreatedAt": number,
   "CreatedBy": "string",
   "DisplayName": "string",
   "Emails": [ 
      { 
         "Primary": boolean,
         "Type": "string",
         "Value": "string"
      }
   ],
   "ExternalIds": [ 
      { 
         "Id": "string",
         "Issuer": "string"
      }
   ],
   "IdentityStoreId": "string",
   "Locale": "string",
   "Name": { 
      "FamilyName": "string",
      "Formatted": "string",
      "GivenName": "string",
      "HonorificPrefix": "string",
      "HonorificSuffix": "string",
      "MiddleName": "string"
   },
   "NickName": "string",
   "PhoneNumbers": [ 
      { 
         "Primary": boolean,
         "Type": "string",
         "Value": "string"
      }
   ],
   "Photos": [ 
      { 
         "Display": "string",
         "Primary": boolean,
         "Type": "string",
         "Value": "string"
      }
   ],
   "PreferredLanguage": "string",
   "ProfileUrl": "string",
   "Timezone": "string",
   "Title": "string",
   "UpdatedAt": number,
   "UpdatedBy": "string",
   "UserId": "string",
   "UserName": "string",
   "UserStatus": "string",
   "UserType": "string",
   "Website": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Addresses

The physical address of the user.

Type: Array of Address objects

Array Members: Fixed number of 1 item.

Birthdate

The user's birthdate in YYYY-MM-DD format. This field returns the stored birthdate information for the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

CreatedAt

The date and time the user was created.

Type: Timestamp

CreatedBy

The identifier of the user or system that created the user.

Type: String

DisplayName

The display name of the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Emails

The email address of the user.

Type: Array of Email objects

Array Members: Fixed number of 1 item.

ExternalIds

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

Type: Array of ExternalId objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

IdentityStoreId

The globally unique identifier for the identity store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Locale

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Name

The name of the user.

Type: Name object

NickName

An alternative descriptive name for the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

PhoneNumbers

A list of PhoneNumber objects associated with a user.

Type: Array of PhoneNumber objects

Array Members: Fixed number of 1 item.

Photos

A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.

Type: Array of Photo objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

PreferredLanguage

The preferred language of the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

ProfileUrl

A URL link for the user's profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Timezone

The time zone for a user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Title

A string containing the title of the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

UpdatedAt

The date and time the user was last updated.

Type: Timestamp

UpdatedBy

The identifier of the user or system that last updated the user.

Type: String

UserId

The identifier for a user in the identity store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 47.

Pattern: ([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}

UserName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

UserStatus

The current status of the user account.

Type: String

Valid Values: ENABLED | DISABLED

UserType

A string indicating the type of user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Website

The user's personal website or blog URL. Returns the stored website information for the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

Reason: Indicates the reason for an access denial when returned by KMS while accessing a Customer Managed KMS key. For non-KMS access-denied errors, this field is not included.
RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure with an internal server.

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
RetryAfterSeconds: The number of seconds to wait before retrying the next request.

HTTP Status Code: 500

ResourceNotFoundException

Indicates that a requested resource is not found.

Reason: Indicates the reason for a resource not found error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
ResourceId: The identifier for a resource in the identity store that can be used as UserId or GroupId. The format for ResourceId is either UUID or 1234567890-UUID, where UUID is a randomly generated value for each resource when it is created and 1234567890 represents the IdentityStoreId string value. In the case that the identity store is migrated from a legacy SSO identity store, the ResourceId for that identity store will be in the format of UUID. Otherwise, it will be in the 1234567890-UUID format.
ResourceType: An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.

HTTP Status Code: 400

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

Reason: Indicates the reason for the throttling error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
RetryAfterSeconds: The number of seconds to wait before retrying the next request.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

Reason: Indicates the reason for the validation error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

HTTP Status Code: 400

Examples

Example

This example retrieves information about a user called John Doe.

Sample Request


{
    "IdentityStoreId": "d-1234567890",
    "UserId": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p"
}

Sample Response


 {
    "UserName": "johndoe",
    "UserId": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
    "Name": {
        "Formatted": "John Doe",
        "FamilyName": "Doe",
        "GivenName": "John",
    },
    "DisplayName": "John Doe",
    "Emails": [
        {
            "Value": "johndoe@example.com",
            "Type": "work",
            "Primary": true
        }
    ],
    "Addresses": [
        {
            "StreetAddress": "123 Main St",
            "Locality": "Any Town",
            "Region": "ST",
            "PostalCode": "12345",
            "Country": "USA",
            "Formatted": "123 Main St, Anytown, ST 12345, USA",
            "Type": "home"
        }
    ],
    "PhoneNumbers": [
        {
            "Value": "+1 (832) 555-0100",
            "Type": "work",
            "Primary": true
        }
    ],
    "IdentityStoreId": "d-1234567890"
}