Amazon Cognito · Schema
AdminCreateUserConfigType
The configuration for creating a new user profile.
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC
Properties
| Name | Type | Description |
|---|---|---|
| AllowAdminCreateUserOnly | object | |
| UnusedAccountValidityDays | object | |
| InviteMessageTemplate | object |
JSON Schema
{
"type": "object",
"properties": {
"AllowAdminCreateUserOnly": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanType"
},
{
"description": "Set to <code>True</code> if only the administrator is allowed to create user profiles. Set to <code>False</code> if users can sign themselves up via an app."
}
]
},
"UnusedAccountValidityDays": {
"allOf": [
{
"$ref": "#/components/schemas/AdminCreateUserUnusedAccountValidityDaysType"
},
{
"description": "<p>The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call <code>AdminCreateUser</code> again, specifying <code>\"RESEND\"</code> for the <code>MessageAction</code> parameter. The default value for this parameter is 7. </p> <note> <p>If you set a value for <code>TemporaryPasswordValidityDays</code> in <code>PasswordPolicy</code>, that value will be used, and <code>UnusedAccountValidityDays</code> will be no longer be an available parameter for that user pool.</p> </note>"
}
]
},
"InviteMessageTemplate": {
"allOf": [
{
"$ref": "#/components/schemas/MessageTemplateType"
},
{
"description": "<p>The message template to be used for the welcome message to new users.</p> <p>See also <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization\">Customizing User Invitation Messages</a>.</p>"
}
]
}
},
"description": "The configuration for creating a new user profile.",
"$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-admin-create-user-config-type-schema.json",
"title": "AdminCreateUserConfigType"
}