public static interface AdminInitiateAuthRequest.Builder extends CognitoIdentityProviderRequest.Builder, CopyableBuilder<AdminInitiateAuthRequest.Builder,AdminInitiateAuthRequest>
Modifier and Type | Method and Description |
---|---|
AdminInitiateAuthRequest.Builder |
authFlow(AuthFlowType authFlow)
The authentication flow for this call to execute.
|
AdminInitiateAuthRequest.Builder |
authFlow(String authFlow)
The authentication flow for this call to execute.
|
AdminInitiateAuthRequest.Builder |
authParameters(Map<String,String> authParameters)
The authentication parameters.
|
AdminInitiateAuthRequest.Builder |
clientId(String clientId)
The app client ID.
|
AdminInitiateAuthRequest.Builder |
clientMetadata(Map<String,String> 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.
|
AdminInitiateAuthRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
AdminInitiateAuthRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
AdminInitiateAuthRequest.Builder |
userPoolId(String userPoolId)
The ID of the Amazon Cognito user pool.
|
build
overrideConfiguration
copy
applyMutation, build
AdminInitiateAuthRequest.Builder userPoolId(String userPoolId)
The ID of the Amazon Cognito user pool.
userPoolId
- The ID of the Amazon Cognito user pool.AdminInitiateAuthRequest.Builder clientId(String clientId)
The app client ID.
clientId
- The app client ID.AdminInitiateAuthRequest.Builder authFlow(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.
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.
AuthFlowType
,
AuthFlowType
AdminInitiateAuthRequest.Builder authFlow(AuthFlowType 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.
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.
AuthFlowType
,
AuthFlowType
AdminInitiateAuthRequest.Builder authParameters(Map<String,String> 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
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
AdminInitiateAuthRequest.Builder clientMetadata(Map<String,String> 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.
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.AdminInitiateAuthRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.AdminInitiateAuthRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.