@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DeviceConfigurationType extends Object implements Serializable, Cloneable, StructuredPojo
The device-remembering configuration for a user pool. A
DescribeUserPool request returns a null value for this object when the user pool isn't configured to remember
devices. When device remembering is active, you can remember a user's device with a ConfirmDevice API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt
is
true
, you must follow ConfirmDevice
with an UpdateDeviceStatus API request that sets the user's device to remembered
or
not_remembered
.
To sign in with a remembered device, include DEVICE_KEY
in the authentication parameters in your user's
InitiateAuth request. If your app doesn't include a DEVICE_KEY
parameter, the response from Amazon Cognito includes newly-generated DEVICE_KEY
and DEVICE_GROUP_KEY
values under NewDeviceMetadata
. Store these values to use in future device-authentication requests.
When you provide a value for any property of DeviceConfiguration
, you activate the device remembering
for the user pool.
Constructor and Description |
---|
DeviceConfigurationType() |
Modifier and Type | Method and Description |
---|---|
DeviceConfigurationType |
clone() |
boolean |
equals(Object obj) |
Boolean |
getChallengeRequiredOnNewDevice()
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time
password (TOTP) factors for multi-factor authentication (MFA).
|
Boolean |
getDeviceOnlyRememberedOnUserPrompt()
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
ConfirmDevice API request.
|
int |
hashCode() |
Boolean |
isChallengeRequiredOnNewDevice()
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time
password (TOTP) factors for multi-factor authentication (MFA).
|
Boolean |
isDeviceOnlyRememberedOnUserPrompt()
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
ConfirmDevice API request.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setChallengeRequiredOnNewDevice(Boolean challengeRequiredOnNewDevice)
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time
password (TOTP) factors for multi-factor authentication (MFA).
|
void |
setDeviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt)
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
ConfirmDevice API request.
|
String |
toString()
Returns a string representation of this object.
|
DeviceConfigurationType |
withChallengeRequiredOnNewDevice(Boolean challengeRequiredOnNewDevice)
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time
password (TOTP) factors for multi-factor authentication (MFA).
|
DeviceConfigurationType |
withDeviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt)
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
ConfirmDevice API request.
|
public void setChallengeRequiredOnNewDevice(Boolean challengeRequiredOnNewDevice)
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Whether or not ChallengeRequiredOnNewDevice
is true, users who sign in with devices that have not
been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
challengeRequiredOnNewDevice
- When true, a remembered device can sign in with device authentication instead of SMS and time-based
one-time password (TOTP) factors for multi-factor authentication (MFA).
Whether or not ChallengeRequiredOnNewDevice
is true, users who sign in with devices that have
not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
public Boolean getChallengeRequiredOnNewDevice()
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Whether or not ChallengeRequiredOnNewDevice
is true, users who sign in with devices that have not
been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
Whether or not ChallengeRequiredOnNewDevice
is true, users who sign in with devices that
have not been confirmed or remembered must still provide a second factor in a user pool that requires
MFA.
public DeviceConfigurationType withChallengeRequiredOnNewDevice(Boolean challengeRequiredOnNewDevice)
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Whether or not ChallengeRequiredOnNewDevice
is true, users who sign in with devices that have not
been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
challengeRequiredOnNewDevice
- When true, a remembered device can sign in with device authentication instead of SMS and time-based
one-time password (TOTP) factors for multi-factor authentication (MFA).
Whether or not ChallengeRequiredOnNewDevice
is true, users who sign in with devices that have
not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
public Boolean isChallengeRequiredOnNewDevice()
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Whether or not ChallengeRequiredOnNewDevice
is true, users who sign in with devices that have not
been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
Whether or not ChallengeRequiredOnNewDevice
is true, users who sign in with devices that
have not been confirmed or remembered must still provide a second factor in a user pool that requires
MFA.
public void setDeviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt)
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt
is false
, Amazon Cognito immediately remembers
devices that you register in a ConfirmDevice
API request.
deviceOnlyRememberedOnUserPrompt
- When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to
remember their device. Return the user's choice in an
UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt
is false
, Amazon Cognito immediately
remembers devices that you register in a ConfirmDevice
API request.
public Boolean getDeviceOnlyRememberedOnUserPrompt()
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt
is false
, Amazon Cognito immediately remembers
devices that you register in a ConfirmDevice
API request.
When DeviceOnlyRememberedOnUserPrompt
is false
, Amazon Cognito immediately
remembers devices that you register in a ConfirmDevice
API request.
public DeviceConfigurationType withDeviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt)
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt
is false
, Amazon Cognito immediately remembers
devices that you register in a ConfirmDevice
API request.
deviceOnlyRememberedOnUserPrompt
- When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to
remember their device. Return the user's choice in an
UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt
is false
, Amazon Cognito immediately
remembers devices that you register in a ConfirmDevice
API request.
public Boolean isDeviceOnlyRememberedOnUserPrompt()
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt
is false
, Amazon Cognito immediately remembers
devices that you register in a ConfirmDevice
API request.
When DeviceOnlyRememberedOnUserPrompt
is false
, Amazon Cognito immediately
remembers devices that you register in a ConfirmDevice
API request.
public String toString()
toString
in class Object
Object.toString()
public DeviceConfigurationType clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.