@Generated(value="software.amazon.awssdk:codegen") public class AdminInitiateAuthRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<AdminInitiateAuthRequest.Builder,AdminInitiateAuthRequest>
Initiates the authorization request, as an administrator.
Modifier and Type | Class and Description |
---|---|
static interface |
AdminInitiateAuthRequest.Builder |
Modifier and Type | Method and Description |
---|---|
AuthFlowType |
authFlow()
The authentication flow for this call to execute.
|
String |
authFlowString()
The authentication flow for this call to execute.
|
Map<String,String> |
authParameters()
The authentication parameters.
|
static AdminInitiateAuthRequest.Builder |
builder() |
String |
clientId()
The app client ID.
|
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.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
static Class<? extends AdminInitiateAuthRequest.Builder> |
serializableBuilderClass() |
AdminInitiateAuthRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
userPoolId()
The ID of the Amazon Cognito user pool.
|
requestOverrideConfig
copy
public String userPoolId()
The ID of the Amazon Cognito user pool.
public String clientId()
The app client ID.
public 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.
If the service returns an enum value that is not available in the current SDK version, authFlow
will
return AuthFlowType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
authFlowString()
.
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
public String authFlowString()
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.
If the service returns an enum value that is not available in the current SDK version, authFlow
will
return AuthFlowType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
authFlowString()
.
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
public 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
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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
public 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public AdminInitiateAuthRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AdminInitiateAuthRequest.Builder,AdminInitiateAuthRequest>
toBuilder
in class CognitoIdentityProviderRequest
public static AdminInitiateAuthRequest.Builder builder()
public static Class<? extends AdminInitiateAuthRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.