Amazon Cognito · Schema
UserType
A user profile in a Amazon Cognito user pool.
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC
Properties
| Name | Type | Description |
|---|---|---|
| Username | object | |
| Attributes | object | |
| UserCreateDate | object | |
| UserLastModifiedDate | object | |
| Enabled | object | |
| UserStatus | object | |
| MFAOptions | object |
JSON Schema
{
"type": "object",
"properties": {
"Username": {
"allOf": [
{
"$ref": "#/components/schemas/UsernameType"
},
{
"description": "The user name of the user you want to describe."
}
]
},
"Attributes": {
"allOf": [
{
"$ref": "#/components/schemas/AttributeListType"
},
{
"description": "A container with information about the user type attributes."
}
]
},
"UserCreateDate": {
"allOf": [
{
"$ref": "#/components/schemas/DateType"
},
{
"description": "The creation date of the user."
}
]
},
"UserLastModifiedDate": {
"allOf": [
{
"$ref": "#/components/schemas/DateType"
},
{
"description": "The last modified date of the user."
}
]
},
"Enabled": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanType"
},
{
"description": "Specifies whether the user is enabled."
}
]
},
"UserStatus": {
"allOf": [
{
"$ref": "#/components/schemas/UserStatusType"
},
{
"description": "<p>The user status. This can be one of the following:</p> <ul> <li> <p>UNCONFIRMED - User has been created but not confirmed.</p> </li> <li> <p>CONFIRMED - User has been confirmed.</p> </li> <li> <p>EXTERNAL_PROVIDER - User signed in with a third-party IdP.</p> </li> <li> <p>ARCHIVED - User is no longer active.</p> </li> <li> <p>UNKNOWN - User status isn't known.</p> </li> <li> <p>RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.</p> </li> <li> <p>FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else. </p> </li> </ul>"
}
]
},
"MFAOptions": {
"allOf": [
{
"$ref": "#/components/schemas/MFAOptionListType"
},
{
"description": "The MFA options for the user."
}
]
}
},
"description": "A user profile in a Amazon Cognito user pool.",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-schema/cognito-idp-user-type-schema.json",
"title": "UserType"
}