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, and1234567890is 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"
}
],
"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"
}
],
"PreferredLanguage": "string",
"ProfileUrl": "string",
"Timezone": "string",
"Title": "string",
"UserId": "string",
"UserName": "string",
"UserType": "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.
- 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
ExternalIdobjects 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
PhoneNumberobjects associated with a user.Type: Array of PhoneNumber objects
Array Members: Fixed number of 1 item.
- 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 ]+ - 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}]+ - 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 ]+
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.
HTTP Status Code: 400
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure with an internal server.
HTTP Status Code: 500
- ResourceNotFoundException
-
Indicates that a requested resource is not found.
HTTP Status Code: 400
- ThrottlingException
-
Indicates that the principal has crossed the throttling limits of the API operations.
HTTP Status Code: 400
- ValidationException
-
The request failed because it contains a syntax error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
