Boolean allowAdminCreateUserOnly
Set to True if only the administrator is allowed to create user profiles. Set to False
if users can sign themselves up via an app.
Integer unusedAccountValidityDays
The user account expiration limit, in days, after which the account is no longer usable. To reset the account
after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the
MessageAction parameter. The default value for this parameter is 7.
MessageTemplateType inviteMessageTemplate
The message template to be used for the welcome message to new users.
String userPoolId
The user pool ID for the user pool where the user will be created.
String username
The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
List<E> userAttributes
An array of name-value pairs that contain user attributes and attribute values to be set for the user to be
created. You can create a user without specifying any attributes other than Username. However, any
attributes that you specify as required (in CreateUserPool or in the
Attributes tab of the console) must be supplied either by you (in your call to
AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
For custom attributes, you must prepend the custom: prefix to the attribute name.
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to
True, and you can set the phone_number_verified attribute to True. (You
can also do this by calling AdminUpdateUserAttributes.)
email: The email address of the user to whom the message that contains the code and username will be sent.
Required if the email_verified attribute is set to True, or if "EMAIL" is
specified in the DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message that contains the code and username will be
sent. Required if the phone_number_verified attribute is set to True, or if
"SMS" is specified in the DesiredDeliveryMediums parameter.
List<E> validationData
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
String temporaryPassword
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you
created the user pool. To reset the account after that time limit, you must call AdminCreateUser
again, specifying "RESEND" for the MessageAction parameter.
Boolean forceAliasCreation
This parameter is only used if the phone_number_verified or email_verified attribute is
set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the
UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias
from the previous user to the newly created user. The previous user will no longer be able to log in using that
alias.
If this parameter is set to False, the API throws an AliasExistsException error if the
alias already exists. The default value is False.
String messageAction
Set to "RESEND" to resend the invitation message to a user that already exists and reset the
expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one
value can be specified.
List<E> desiredDeliveryMediums
Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the
phone number will be used. The default value is "SMS". More than one value can be specified.
UserType user
The newly created user.
String userPoolId
The user pool ID for the user pool where you want to delete user attributes.
String username
The user name of the user from which you would like to delete attributes.
List<E> userAttributeNames
An array of strings representing the user attribute names you wish to delete.
For custom attributes, you must prepend the custom: prefix to the attribute name.
String userPoolId
The user pool ID for the user pool.
ProviderUserIdentifierType user
The user to be disabled.
DeviceType device
The device.
String username
The user name of the user about whom you are receiving information.
List<E> userAttributes
An array of name-value pairs representing user attributes.
Date userCreateDate
The date the user was created.
Date userLastModifiedDate
The date the user was last modified.
Boolean enabled
Indicates that the status is enabled.
String userStatus
The user status. Can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
ARCHIVED - User is no longer active.
COMPROMISED - User is disabled due to a potential security threat.
UNKNOWN - User status is not known.
List<E> mFAOptions
Specifies the options for MFA (e.g., email or phone number).
String userPoolId
The ID of the Amazon Cognito user pool.
String clientId
The app client ID.
String authFlow
The authentication flow for this call to execute. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables
to be used for next challenge execution.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token
and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly
if the flow is enabled for calling the app client.
Map<K,V> authParameters
The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking.
The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required),
SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: USERNAME (required), SECRET_HASH
(required if the app client is configured with a client secret), REFRESH_TOKEN (required),
DEVICE_KEY
For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is
configured with client secret), PASSWORD (required), DEVICE_KEY
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is
configured with client secret), DEVICE_KEY
Map<K,V> clientMetadata
This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.
String challengeName
The name of the challenge which you are responding to with this call. This is returned to you in the
AdminInitiateAuth response if you need to pass another challenge.
SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE,
PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user
should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were
passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
ADMIN_NO_SRP_AUTH: This is returned if you need to authenticate with USERNAME and
PASSWORD directly. An app client must be enabled to use this flow.
NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
String session
The session which should be passed both ways in challenge-response calls to the service. If
AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller
needs to go through another challenge, they return a session with other challenge parameters. This session should
be passed as it is to the next AdminRespondToAuthChallenge API call.
Map<K,V> challengeParameters
The challenge parameters. These are returned to you in the AdminInitiateAuth response if you need to
pass another challenge. The responses in this parameter should be used to compute inputs to the next call (
AdminRespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
The value of the USER_IF_FOR_SRP attribute will be the user's actual username, not an alias (such as
email address or phone number), even if you specified an alias in your call to AdminInitiateAuth.
This is because, in the AdminRespondToAuthChallenge API ChallengeResponses, the
USERNAME attribute cannot be an alias.
AuthenticationResultType authenticationResult
The result of the authentication response. This is only returned if the caller does not need to pass another
challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName,
ChallengeParameters, and Session are returned.
String userPoolId
The user pool ID for the user pool.
ProviderUserIdentifierType destinationUser
The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in.
The ProviderAttributeValue for the DestinationUser must match the username for the user
in the user pool. The ProviderAttributeName will always be ignored.
ProviderUserIdentifierType sourceUser
An external identity provider account for a user who does not currently exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.
If the SourceUser is a federated social identity provider user (Facebook, Google, or Login with
Amazon), you must set the ProviderAttributeName to Cognito_Subject. For social identity
providers, the ProviderName will be Facebook, Google, or
LoginWithAmazon, and Cognito will automatically parse the Facebook, Google, and Login with Amazon
tokens for id, sub, and user_id, respectively. The
ProviderAttributeValue for the user must be the same value as the id, sub,
or user_id value found in the social identity provider token.
For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If
you wish to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim
through the SAML identity provider and submit that claim name as the ProviderAttributeName. If you
set ProviderAttributeName to Cognito_Subject, Cognito will automatically parse the
default unique identifier found in the subject from the SAML token.
String username
The username for the user.
String userPoolId
The user pool ID for the user pool.
Integer limit
The limit of the request to list groups.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String userPoolId
The ID of the Amazon Cognito user pool.
String clientId
The app client ID.
String challengeName
The challenge name. For more information, see AdminInitiateAuth.
Map<K,V> challengeResponses
The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client
is configured with client secret).
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK,
TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client
secret).
ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app
client is configured with client secret).
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes,
USERNAME, SECRET_HASH (if app client is configured with client secret).
The value of the USERNAME attribute must be the user's actual username, not an alias (such as email
address or phone number). To make this easier, the AdminInitiateAuth response includes the actual
username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call
to AdminInitiateAuth.
String session
The session which should be passed both ways in challenge-response calls to the service. If
InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go
through another challenge, they return a session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge API call.
String challengeName
The name of the challenge. For more information, see AdminInitiateAuth.
String session
The session which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go
through another challenge, they return a session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge API call.
Map<K,V> challengeParameters
The challenge parameters. For more information, see AdminInitiateAuth.
AuthenticationResultType authenticationResult
The result returned by the server in response to the authentication request.
String userPoolId
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
String username
The user name of the user for whom you wish to set user settings.
List<E> mFAOptions
Specifies the options for MFA (e.g., email or phone number).
String userPoolId
The user pool ID for the user pool where you want to update user attributes.
String username
The user name of the user for whom you want to update user attributes.
List<E> userAttributes
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
String accessToken
The access token of the authentication result.
Integer expiresIn
The expiration period of the authentication result.
String tokenType
The token type of the authentication result.
String refreshToken
The refresh token of the authentication result.
String idToken
The ID token of the authentication result.
NewDeviceMetadataType newDeviceMetadata
The new device metadata from an authentication result.
String accessToken
The access token.
String deviceKey
The device key.
DeviceSecretVerifierConfigType deviceSecretVerifierConfig
The configuration of the device secret verifier.
String deviceName
The device name.
Boolean userConfirmationNecessary
Indicates whether the user confirmation is necessary to confirm the device response.
String clientId
The app client ID of the app associated with the user pool.
String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
String username
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
String confirmationCode
The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword
String password
The password sent by a user's request to retrieve a forgotten password.
String clientId
The ID of the app client associated with the user pool.
String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
String username
The user name of the user whose registration you wish to confirm.
String confirmationCode
The confirmation code sent by a user's request to confirm registration.
Boolean forceAliasCreation
Boolean to be specified to force user confirmation irrespective of existing alias. By default set to
False. If this parameter is set to True and the phone number/email used for sign up
confirmation already exists as an alias with a different user, the API call will migrate the alias from the
previous user to the newly created user being confirmed. If set to False, the API will throw an
AliasExistsException error.
String groupName
The name of the group. Must be unique.
String userPoolId
The user pool ID for the user pool.
String description
A string containing the description of the group.
String roleArn
The role ARN for the group.
Integer precedence
A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user
can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence
values take precedence over groups with higher or null Precedence values. If a user belongs to two
or more groups, it is the group with the lowest precedence value whose role ARN will be used in the
cognito:roles and cognito:preferred_role claims in the user's tokens.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over
the other. If two groups with the same Precedence have the same role ARN, that role is used in the
cognito:preferred_role claim in tokens for users in each group. If the two groups have different
role ARNs, the cognito:preferred_role claim is not set in users' tokens.
The default Precedence value is null.
GroupType group
The group object for the group.
String userPoolId
The user pool ID.
String providerName
The identity provider name.
String providerType
The identity provider type.
Map<K,V> providerDetails
The identity provider details, such as MetadataURL and MetadataFile.
Map<K,V> attributeMapping
A mapping of identity provider attributes to standard and custom user pool attributes.
List<E> idpIdentifiers
A list of identity provider identifiers.
IdentityProviderType identityProvider
The newly created identity provider object.
String userPoolId
The user pool ID for the user pool.
String identifier
A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource
server is located. For example, https://my-weather-api.example.com.
String name
A friendly name for the resource server.
List<E> scopes
A list of scopes. Each scope is map, where the keys are name and description.
ResourceServerType resourceServer
The newly created resource server.
UserImportJobType userImportJob
The job object that represents the user import job.
String userPoolId
The user pool ID for the user pool where you want to create a user pool client.
String clientName
The client name for the user pool client you would like to create.
Boolean generateSecret
Boolean to specify whether you want to generate a secret for the user pool client being created.
Integer refreshTokenValidity
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
List<E> readAttributes
The read attributes.
List<E> writeAttributes
The write attributes.
List<E> explicitAuthFlows
The explicit authentication flows.
List<E> supportedIdentityProviders
A list of provider names for the identity providers that are supported on this client.
List<E> callbackURLs
A list of allowed callback URLs for the identity providers.
List<E> logoutURLs
A list of allowed logout URLs for the identity providers.
String defaultRedirectURI
The default redirect URI. Must be in the CallbackURLs list.
List<E> allowedOAuthFlows
Set to code to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to token to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
List<E> allowedOAuthScopes
A list of allowed OAuth scopes. Currently supported values are "phone",
"email", "openid", and "Cognito".
Boolean allowedOAuthFlowsUserPoolClient
Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools.
UserPoolClientType userPoolClient
The user pool client that was just created.
String poolName
A string used to name the user pool.
UserPoolPolicyType policies
The policies associated with the new user pool.
LambdaConfigType lambdaConfig
The Lambda trigger configuration information for the new user pool.
List<E> autoVerifiedAttributes
The attributes to be auto-verified. Possible values: email, phone_number.
List<E> aliasAttributes
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
List<E> usernameAttributes
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
String smsVerificationMessage
A string representing the SMS verification message.
String emailVerificationMessage
A string representing the email verification message.
String emailVerificationSubject
A string representing the email verification subject.
VerificationMessageTemplateType verificationMessageTemplate
The template for the verification message that the user sees when the app requests permission to access the user's information.
String smsAuthenticationMessage
A string representing the SMS authentication message.
String mfaConfiguration
Specifies MFA configuration details.
DeviceConfigurationType deviceConfiguration
The device configuration.
EmailConfigurationType emailConfiguration
The email configuration.
SmsConfigurationType smsConfiguration
The SMS configuration.
Map<K,V> userPoolTags
The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
AdminCreateUserConfigType adminCreateUserConfig
The configuration for AdminCreateUser requests.
List<E> schema
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
UserPoolType userPool
A container for the user pool details.
List<E> userAttributeNames
An array of strings representing the user attribute names you wish to delete.
For custom attributes, you must prepend the custom: prefix to the attribute name.
String accessToken
The access token used in the request to delete user attributes.
String userPoolId
The user pool ID for the user pool you want to delete.
String accessToken
The access token from a request to delete a user.
IdentityProviderType identityProvider
The identity provider that was deleted.
ResourceServerType resourceServer
The resource server.
UserImportJobType userImportJob
The job object that represents the user import job.
UserPoolClientType userPoolClient
The user pool client from a server response to describe the user pool client.
String domain
The domain string.
DomainDescriptionType domainDescription
A domain description object containing information about the domain.
String userPoolId
The user pool ID for the user pool you want to describe.
UserPoolType userPool
The container of metadata returned by the server to describe the pool.
String deviceKey
The device key.
List<E> deviceAttributes
The device attributes.
Date deviceCreateDate
The creation date of the device.
Date deviceLastModifiedDate
The last modified date of the device.
Date deviceLastAuthenticatedDate
The date in which the device was last authenticated.
String userPoolId
The user pool ID.
String aWSAccountId
The AWS account ID for the user pool owner.
String domain
The domain string.
String s3Bucket
The S3 bucket where the static files for this domain are stored.
String cloudFrontDistribution
The ARN of the CloudFront distribution.
String version
The app version.
String status
The domain status.
String clientId
The ID of the client associated with the user pool.
String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
String username
The user name of the user for whom you want to enter a code to reset a forgotten password.
CodeDeliveryDetailsType codeDeliveryDetails
The code delivery details returned by the server in response to the request to reset a password.
String userPoolId
The user pool ID for the user pool that the users are to be imported into.
DeviceType device
The device.
GroupType group
The group object for the group.
IdentityProviderType identityProvider
The identity provider object.
UICustomizationType uICustomization
The UI customization information.
CodeDeliveryDetailsType codeDeliveryDetails
The code delivery details returned by the server in response to the request to get the user attribute verification code.
String accessToken
The access token returned by the server response to get information about the user.
String username
The user name of the user you wish to retrieve from the get user request.
List<E> userAttributes
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
List<E> mFAOptions
Specifies the options for MFA (e.g., email or phone number).
String accessToken
The access token.
String groupName
The name of the group.
String userPoolId
The user pool ID for the user pool.
String description
A string containing the description of the group.
String roleArn
The role ARN for the group.
Integer precedence
A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user
can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest
precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role
claims in the user's tokens. Groups with higher Precedence values take precedence over groups with
lower Precedence values or with null Precedence values.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over
the other. If two groups with the same Precedence have the same role ARN, that role is used in the
cognito:preferred_role claim in tokens for users in each group. If the two groups have different
role ARNs, the cognito:preferred_role claim is not set in users' tokens.
The default Precedence value is null.
Date lastModifiedDate
The date the group was last modified.
Date creationDate
The date the group was created.
String userPoolId
The user pool ID.
String providerName
The identity provider name.
String providerType
The identity provider type.
Map<K,V> providerDetails
The identity provider details, such as MetadataURL and MetadataFile.
Map<K,V> attributeMapping
A mapping of identity provider attributes to standard and custom user pool attributes.
List<E> idpIdentifiers
A list of identity provider identifiers.
Date lastModifiedDate
The date the identity provider was last modified.
Date creationDate
The date the identity provider was created.
String authFlow
The authentication flow for this call to execute. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables
to be used for next challenge execution.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token
and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
ADMIN_NO_SRP_AUTH is not a valid value.
Map<K,V> authParameters
The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking.
The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required),
SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: USERNAME (required), SECRET_HASH
(required if the app client is configured with a client secret), REFRESH_TOKEN (required),
DEVICE_KEY
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is
configured with client secret), DEVICE_KEY
Map<K,V> clientMetadata
This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.
String clientId
The app client ID.
String challengeName
The name of the challenge which you are responding to with this call. This is returned to you in the
AdminInitiateAuth response if you need to pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE,
PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user
should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were
passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
String session
The session which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go
through another challenge, they return a session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge API call.
Map<K,V> challengeParameters
The challenge parameters. These are returned to you in the InitiateAuth response if you need to pass
another challenge. The responses in this parameter should be used to compute inputs to the next call (
RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
AuthenticationResultType authenticationResult
The result of the authentication response. This is only returned if the caller does not need to pass another
challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName,
ChallengeParameters, and Session are returned.
String preSignUp
A pre-registration AWS Lambda trigger.
String customMessage
A custom Message AWS Lambda trigger.
String postConfirmation
A post-confirmation AWS Lambda trigger.
String preAuthentication
A pre-authentication AWS Lambda trigger.
String postAuthentication
A post-authentication AWS Lambda trigger.
String defineAuthChallenge
Defines the authentication challenge.
String createAuthChallenge
Creates an authentication challenge.
String verifyAuthChallengeResponse
Verifies the authentication challenge response.
String userPoolId
The user pool ID for the user pool that the users are being imported into.
Integer maxResults
The maximum number of import jobs you want the request to return.
String paginationToken
An identifier that was returned from the previous call to ListUserImportJobs, which can be used to
return the next set of import jobs in the list.
String userPoolId
The user pool ID for the user pool where you want to list user pool clients.
Integer maxResults
The maximum number of results you want the request to return when listing the user pool clients.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String userPoolId
The user pool ID for the user pool.
String groupName
The name of the group.
Integer limit
The limit of the request to list users.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String userPoolId
The user pool ID for the user pool on which the search should be performed.
List<E> attributesToGet
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is empty, all attributes are returned.
Integer limit
Maximum number of users to be returned.
String paginationToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String filter
A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks
within the filter string must be escaped using the backslash (\) character. For example, "
family_name = \"Reddy\"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix
("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers returns all users in the user pool.
You can only search for the following standard attributes:
username (case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status (called Enabled in the Console) (case-sensitive)
status (case-insensitive)
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
Integer minimumLength
The minimum length of the password policy that you have set. Cannot be less than 6.
Boolean requireUppercase
In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
Boolean requireLowercase
In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
Boolean requireNumbers
In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
Boolean requireSymbols
In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
String providerName
The name of the provider, for example, Facebook, Google, or Login with Amazon.
String providerAttributeName
The name of the provider attribute to link to, for example, NameID.
String providerAttributeValue
The value of the provider attribute to link to, for example, xxxxx_account.
String clientId
The ID of the client associated with the user pool.
String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
String username
The user name of the user to whom you wish to resend a confirmation code.
CodeDeliveryDetailsType codeDeliveryDetails
The code delivery details returned by the server in response to the request to resend the confirmation code.
String clientId
The app client ID.
String challengeName
The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH is not a valid value.
String session
The session which should be passed both ways in challenge-response calls to the service. If
InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go
through another challenge, they return a session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge API call.
Map<K,V> challengeResponses
The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client
is configured with client secret).
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK,
TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client
secret).
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes,
USERNAME, SECRET_HASH (if app client is configured with client secret).
String challengeName
The challenge name. For more information, see InitiateAuth.
String session
The session which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go
through another challenge, they return a session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge API call.
Map<K,V> challengeParameters
The challenge parameters. For more information, see InitiateAuth.
AuthenticationResultType authenticationResult
The result returned by the server in response to the request to respond to the authentication challenge.
String name
A schema attribute of the name type.
String attributeDataType
The attribute data type.
Boolean developerOnlyAttribute
Specifies whether the attribute type is developer only.
Boolean mutable
Specifies whether the attribute can be changed once it has been created.
Boolean required
Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.
NumberAttributeConstraintsType numberAttributeConstraints
Specifies the constraints for an attribute of the number type.
StringAttributeConstraintsType stringAttributeConstraints
Specifies the constraints for an attribute of the string type.
String userPoolId
The user pool ID for the user pool.
String clientId
The client ID for the client app.
String cSS
The CSS values in the UI customization.
ByteBuffer imageFile
The uploaded logo image for the UI customization.
UICustomizationType uICustomization
The UI customization information.
String clientId
The ID of the client associated with the user pool.
String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
String username
The user name of the user you wish to register.
String password
The password of the user you wish to register.
List<E> userAttributes
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
List<E> validationData
The validation data in the request to register a user.
Boolean userConfirmed
A response from the server indicating that a user registration has been confirmed.
CodeDeliveryDetailsType codeDeliveryDetails
The code delivery details returned by the server response to the user registration request.
String userSub
The UUID of the authenticated user. This is not the same as username.
UserImportJobType userImportJob
The job object that represents the user import job.
UserImportJobType userImportJob
The job object that represents the user import job.
String userPoolId
The user pool ID for the user pool.
String clientId
The client ID for the client app.
String imageUrl
The logo image for the UI customization.
String cSS
The CSS values in the UI customization.
String cSSVersion
The CSS version number.
Date lastModifiedDate
The last-modified date for the UI customization.
Date creationDate
The creation date for the UI customization.
String groupName
The name of the group.
String userPoolId
The user pool ID for the user pool.
String description
A string containing the new description of the group.
String roleArn
The new role ARN for the group. This is used for setting the cognito:roles and
cognito:preferred_role claims in the token.
Integer precedence
The new precedence value for the group. For more information about this parameter, see CreateGroup.
GroupType group
The group object for the group.
String userPoolId
The user pool ID.
String providerName
The identity provider name.
Map<K,V> providerDetails
The identity provider details to be updated, such as MetadataURL and MetadataFile.
Map<K,V> attributeMapping
The identity provider attribute mapping to be changed.
List<E> idpIdentifiers
A list of identity provider identifiers.
IdentityProviderType identityProvider
The identity provider object.
ResourceServerType resourceServer
The resource server.
String userPoolId
The user pool ID for the user pool where you want to update the user pool client.
String clientId
The ID of the client associated with the user pool.
String clientName
The client name from the update user pool client request.
Integer refreshTokenValidity
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
List<E> readAttributes
The read-only attributes of the user pool.
List<E> writeAttributes
The writeable attributes of the user pool.
List<E> explicitAuthFlows
Explicit authentication flows.
List<E> supportedIdentityProviders
A list of provider names for the identity providers that are supported on this client.
List<E> callbackURLs
A list of allowed callback URLs for the identity providers.
List<E> logoutURLs
A list of allowed logout URLs for the identity providers.
String defaultRedirectURI
The default redirect URI. Must be in the CallbackURLs list.
List<E> allowedOAuthFlows
Set to code to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to token to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
List<E> allowedOAuthScopes
A list of allowed OAuth scopes. Currently supported values are "phone",
"email", "openid", and "Cognito".
Boolean allowedOAuthFlowsUserPoolClient
Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
UserPoolClientType userPoolClient
The user pool client value from the response from the server when an update user pool client request is made.
String userPoolId
The user pool ID for the user pool you want to update.
UserPoolPolicyType policies
A container with the policies you wish to update in a user pool.
LambdaConfigType lambdaConfig
The AWS Lambda configuration information from the request to update the user pool.
List<E> autoVerifiedAttributes
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
String smsVerificationMessage
A container with information about the SMS verification message.
String emailVerificationMessage
The contents of the email verification message.
String emailVerificationSubject
The subject of the email verification message.
VerificationMessageTemplateType verificationMessageTemplate
The template for verification messages.
String smsAuthenticationMessage
The contents of the SMS authentication message.
String mfaConfiguration
Can be one of the following values:
OFF - MFA tokens are not required and cannot be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify required when you are
initially creating a user pool.
OPTIONAL - Users have the option when registering to create an MFA token.
DeviceConfigurationType deviceConfiguration
Device configuration.
EmailConfigurationType emailConfiguration
Email configuration.
SmsConfigurationType smsConfiguration
SMS configuration.
Map<K,V> userPoolTags
The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
AdminCreateUserConfigType adminCreateUserConfig
The configuration for AdminCreateUser requests.
String jobName
The job name for the user import job.
String jobId
The job ID for the user import job.
String userPoolId
The user pool ID for the user pool that the users are being imported into.
String preSignedUrl
The pre-signed URL to be used to upload the .csv file.
Date creationDate
The date the user import job was created.
Date startDate
The date when the user import job was started.
Date completionDate
The date when the user import job was completed.
String status
The status of the user import job. One of the following:
Created - The job was created but not started.
Pending - A transition state. You have started the job, but it has not begun importing users yet.
InProgress - The job has started, and users are being imported.
Stopping - You have stopped the job, but the job has not stopped importing users yet.
Stopped - You have stopped the job, and the job has stopped importing users.
Succeeded - The job has completed successfully.
Failed - The job has stopped due to an error.
Expired - You created a job, but did not start the job within 24-48 hours. All data associated with
the job was deleted, and the job cannot be started.
String cloudWatchLogsRoleArn
The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
Long importedUsers
The number of users that were successfully imported.
Long skippedUsers
The number of users that were skipped.
Long failedUsers
The number of users that could not be imported.
String completionMessage
The message returned when the user import job is completed.
String userPoolId
The user pool ID for the user pool client.
String clientName
The client name from the user pool request of the client type.
String clientId
The ID of the client associated with the user pool.
String clientSecret
The client secret from the user pool request of the client type.
Date lastModifiedDate
The date the user pool client was last modified.
Date creationDate
The date the user pool client was created.
Integer refreshTokenValidity
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
List<E> readAttributes
The Read-only attributes.
List<E> writeAttributes
The writeable attributes.
List<E> explicitAuthFlows
The explicit authentication flows.
List<E> supportedIdentityProviders
A list of provider names for the identity providers that are supported on this client.
List<E> callbackURLs
A list of allowed callback URLs for the identity providers.
List<E> logoutURLs
A list of allowed logout URLs for the identity providers.
String defaultRedirectURI
The default redirect URI. Must be in the CallbackURLs list.
List<E> allowedOAuthFlows
Set to code to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to token to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
List<E> allowedOAuthScopes
A list of allowed OAuth scopes. Currently supported values are "phone",
"email", "openid", and "Cognito".
Boolean allowedOAuthFlowsUserPoolClient
Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
String id
The ID in a user pool description.
String name
The name in a user pool description.
LambdaConfigType lambdaConfig
The AWS Lambda configuration information in a user pool description.
String status
The user pool status in a user pool description.
Date lastModifiedDate
The date the user pool description was last modified.
Date creationDate
The date the user pool description was created.
PasswordPolicyType passwordPolicy
A container for information about the user pool password policy.
String id
The ID of the user pool.
String name
The name of the user pool.
UserPoolPolicyType policies
A container for the policies associated with a user pool.
LambdaConfigType lambdaConfig
A container for the AWS Lambda triggers associated with a user pool.
String status
The status of a user pool.
Date lastModifiedDate
The date the user pool was last modified.
Date creationDate
The date the user pool was created.
List<E> schemaAttributes
A container with the schema attributes of a user pool.
List<E> autoVerifiedAttributes
Specifies the attributes that are auto-verified in a user pool.
List<E> aliasAttributes
Specifies the attributes that are aliased in a user pool.
List<E> usernameAttributes
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
String smsVerificationMessage
The contents of the SMS verification message.
String emailVerificationMessage
The contents of the email verification message.
String emailVerificationSubject
The subject of the email verification message.
VerificationMessageTemplateType verificationMessageTemplate
The template for verification messages.
String smsAuthenticationMessage
The contents of the SMS authentication message.
String mfaConfiguration
Can be one of the following values:
OFF - MFA tokens are not required and cannot be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify required when you are
initially creating a user pool.
OPTIONAL - Users have the option when registering to create an MFA token.
DeviceConfigurationType deviceConfiguration
The device configuration.
Integer estimatedNumberOfUsers
A number estimating the size of the user pool.
EmailConfigurationType emailConfiguration
The email configuration.
SmsConfigurationType smsConfiguration
The SMS configuration.
Map<K,V> userPoolTags
The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
String smsConfigurationFailure
The reason why the SMS configuration cannot send the messages to your users.
String emailConfigurationFailure
The reason why the email configuration cannot send the messages to your users.
AdminCreateUserConfigType adminCreateUserConfig
The configuration for AdminCreateUser requests.
String username
The user name of the user you wish to describe.
List<E> attributes
A container with information about the user type attributes.
Date userCreateDate
The creation date of the user.
Date userLastModifiedDate
The last modified date of the user.
Boolean enabled
Specifies whether the user is enabled.
String userStatus
The user status. Can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
ARCHIVED - User is no longer active.
COMPROMISED - User is disabled due to a potential security threat.
UNKNOWN - User status is not known.
List<E> mFAOptions
The MFA options for the user.
String smsMessage
The SMS message template.
String emailMessage
The email message template.
String emailSubject
The subject line for the email message template.
String emailMessageByLink
The email message template for sending a confirmation link to the user.
String emailSubjectByLink
The subject line for the email message template for sending a confirmation link to the user.
String defaultEmailOption
The default email option.
Copyright © 2017. All rights reserved.