DescribeUser
Retrieves the user metadata and attributes from UserId
in an identity store.
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, and1234567890
is a randomly generated string that contains number 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 12.
Pattern:
^d-[0-9a-f]{10}$
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
{
"UserId": "string",
"UserName": "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.
- 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
-
Contains the user’s user name value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters
<>;:%
are excluded. 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}]+
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: