Package com.okta.sdk.resource.model

Class PossessionConstraint

java.lang.Object

com.okta.sdk.resource.model.PossessionConstraint

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T16:19:57.008753975Z[Etc/UTC]",
           comments="Generator version: 7.8.0")
public class PossessionConstraint
extends Object
implements Serializable

PossessionConstraint

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PossessionConstraint.DeviceBoundEnum	Indicates if device-bound Factors are required.
static enum	PossessionConstraint.HardwareProtectionEnum	Indicates if any secrets or private keys used during authentication must be hardware protected and not exportable.
static enum	PossessionConstraint.MethodsEnum	Gets or Sets methods
static enum	PossessionConstraint.PhishingResistantEnum	Indicates if phishing-resistant Factors are required.
static enum	PossessionConstraint.TypesEnum	Gets or Sets types
static enum	PossessionConstraint.UserPresenceEnum	Indicates if the user needs to approve an Okta Verify prompt or provide biometrics (meets NIST AAL2 requirements).
static enum	PossessionConstraint.UserVerificationEnum	Indicates the user interaction requirement (PIN or biometrics) to ensure verification of a possession factor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AUTHENTICATION_METHODS
static final String	JSON_PROPERTY_DEVICE_BOUND
static final String	JSON_PROPERTY_EXCLUDED_AUTHENTICATION_METHODS
static final String	JSON_PROPERTY_HARDWARE_PROTECTION
static final String	JSON_PROPERTY_METHODS
static final String	JSON_PROPERTY_PHISHING_RESISTANT
static final String	JSON_PROPERTY_REAUTHENTICATE_IN
static final String	JSON_PROPERTY_REQUIRED
static final String	JSON_PROPERTY_TYPES
static final String	JSON_PROPERTY_USER_PRESENCE
static final String	JSON_PROPERTY_USER_VERIFICATION

Constructor Summary

Constructors

Constructor	Description
PossessionConstraint()

Method Summary

Modifier and Type	Method	Description
PossessionConstraint	addauthenticationMethodsItem(AuthenticationMethodObject authenticationMethodsItem)
PossessionConstraint	addexcludedAuthenticationMethodsItem(AuthenticationMethodObject excludedAuthenticationMethodsItem)
PossessionConstraint	addmethodsItem(PossessionConstraint.MethodsEnum methodsItem)
PossessionConstraint	addtypesItem(PossessionConstraint.TypesEnum typesItem)
PossessionConstraint	authenticationMethods(List<AuthenticationMethodObject> authenticationMethods)
PossessionConstraint	deviceBound(PossessionConstraint.DeviceBoundEnum deviceBound)
boolean	equals(Object o)
PossessionConstraint	excludedAuthenticationMethods(List<AuthenticationMethodObject> excludedAuthenticationMethods)
List<AuthenticationMethodObject>	getAuthenticationMethods()	This property specifies the precise authenticator and method for authentication.
PossessionConstraint.DeviceBoundEnum	getDeviceBound()	Indicates if device-bound Factors are required.
List<AuthenticationMethodObject>	getExcludedAuthenticationMethods()	This property specifies the precise authenticator and method to exclude from authentication.
PossessionConstraint.HardwareProtectionEnum	getHardwareProtection()	Indicates if any secrets or private keys used during authentication must be hardware protected and not exportable.
List<PossessionConstraint.MethodsEnum>	getMethods()	The Authenticator methods that are permitted
PossessionConstraint.PhishingResistantEnum	getPhishingResistant()	Indicates if phishing-resistant Factors are required.
String	getReauthenticateIn()	The duration after which the user must re-authenticate regardless of user activity.
Boolean	getRequired()	This property indicates whether the knowledge or possession factor is required by the assurance.
List<PossessionConstraint.TypesEnum>	getTypes()	The Authenticator types that are permitted
PossessionConstraint.UserPresenceEnum	getUserPresence()	Indicates if the user needs to approve an Okta Verify prompt or provide biometrics (meets NIST AAL2 requirements).
PossessionConstraint.UserVerificationEnum	getUserVerification()	Indicates the user interaction requirement (PIN or biometrics) to ensure verification of a possession factor
PossessionConstraint	hardwareProtection(PossessionConstraint.HardwareProtectionEnum hardwareProtection)
int	hashCode()
PossessionConstraint	methods(List<PossessionConstraint.MethodsEnum> methods)
PossessionConstraint	phishingResistant(PossessionConstraint.PhishingResistantEnum phishingResistant)
PossessionConstraint	reauthenticateIn(String reauthenticateIn)
PossessionConstraint	required(Boolean required)
void	setAuthenticationMethods(List<AuthenticationMethodObject> authenticationMethods)
void	setDeviceBound(PossessionConstraint.DeviceBoundEnum deviceBound)
void	setExcludedAuthenticationMethods(List<AuthenticationMethodObject> excludedAuthenticationMethods)
void	setHardwareProtection(PossessionConstraint.HardwareProtectionEnum hardwareProtection)
void	setMethods(List<PossessionConstraint.MethodsEnum> methods)
void	setPhishingResistant(PossessionConstraint.PhishingResistantEnum phishingResistant)
void	setReauthenticateIn(String reauthenticateIn)
void	setRequired(Boolean required)
void	setTypes(List<PossessionConstraint.TypesEnum> types)
void	setUserPresence(PossessionConstraint.UserPresenceEnum userPresence)
void	setUserVerification(PossessionConstraint.UserVerificationEnum userVerification)
String	toString()
PossessionConstraint	types(List<PossessionConstraint.TypesEnum> types)
PossessionConstraint	userPresence(PossessionConstraint.UserPresenceEnum userPresence)
PossessionConstraint	userVerification(PossessionConstraint.UserVerificationEnum userVerification)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_AUTHENTICATION_METHODS

public static final String JSON_PROPERTY_AUTHENTICATION_METHODS

See Also:

• Constant Field Values

JSON_PROPERTY_EXCLUDED_AUTHENTICATION_METHODS

public static final String JSON_PROPERTY_EXCLUDED_AUTHENTICATION_METHODS

See Also:

• Constant Field Values

JSON_PROPERTY_METHODS

public static final String JSON_PROPERTY_METHODS

See Also:

• Constant Field Values

JSON_PROPERTY_REAUTHENTICATE_IN

public static final String JSON_PROPERTY_REAUTHENTICATE_IN

See Also:

• Constant Field Values

JSON_PROPERTY_REQUIRED

public static final String JSON_PROPERTY_REQUIRED

See Also:

• Constant Field Values

JSON_PROPERTY_TYPES

public static final String JSON_PROPERTY_TYPES

See Also:

• Constant Field Values

JSON_PROPERTY_DEVICE_BOUND

public static final String JSON_PROPERTY_DEVICE_BOUND

See Also:

• Constant Field Values

JSON_PROPERTY_HARDWARE_PROTECTION

public static final String JSON_PROPERTY_HARDWARE_PROTECTION

See Also:

• Constant Field Values

JSON_PROPERTY_PHISHING_RESISTANT

public static final String JSON_PROPERTY_PHISHING_RESISTANT

See Also:

• Constant Field Values

JSON_PROPERTY_USER_PRESENCE

public static final String JSON_PROPERTY_USER_PRESENCE

See Also:

• Constant Field Values

JSON_PROPERTY_USER_VERIFICATION

public static final String JSON_PROPERTY_USER_VERIFICATION

See Also:

• Constant Field Values

Constructor Details

PossessionConstraint

public PossessionConstraint()

Method Details

authenticationMethods

public PossessionConstraint authenticationMethods(List<AuthenticationMethodObject> authenticationMethods)

addauthenticationMethodsItem

public PossessionConstraint addauthenticationMethodsItem(AuthenticationMethodObject authenticationMethodsItem)

getAuthenticationMethods

@Nullable
public List<AuthenticationMethodObject> getAuthenticationMethods()

This property specifies the precise authenticator and method for authentication. <x-lifecycle class=\"oie\"></x-lifecycle>

Returns:

authenticationMethods

setAuthenticationMethods

public void setAuthenticationMethods(List<AuthenticationMethodObject> authenticationMethods)

excludedAuthenticationMethods

public PossessionConstraint excludedAuthenticationMethods(List<AuthenticationMethodObject> excludedAuthenticationMethods)

addexcludedAuthenticationMethodsItem

public PossessionConstraint addexcludedAuthenticationMethodsItem(AuthenticationMethodObject excludedAuthenticationMethodsItem)

getExcludedAuthenticationMethods

@Nullable
public List<AuthenticationMethodObject> getExcludedAuthenticationMethods()

This property specifies the precise authenticator and method to exclude from authentication. <x-lifecycle class=\"oie\"></x-lifecycle>

Returns:

excludedAuthenticationMethods

setExcludedAuthenticationMethods

public void setExcludedAuthenticationMethods(List<AuthenticationMethodObject> excludedAuthenticationMethods)

methods

public PossessionConstraint methods(List<PossessionConstraint.MethodsEnum> methods)

addmethodsItem

public PossessionConstraint addmethodsItem(PossessionConstraint.MethodsEnum methodsItem)

getMethods

@Nullable
public List<PossessionConstraint.MethodsEnum> getMethods()

The Authenticator methods that are permitted

Returns:

methods

setMethods

public void setMethods(List<PossessionConstraint.MethodsEnum> methods)

reauthenticateIn

public PossessionConstraint reauthenticateIn(String reauthenticateIn)

getReauthenticateIn

@Nullable
public String getReauthenticateIn()

The duration after which the user must re-authenticate regardless of user activity. This re-authentication interval overrides the Verification Method object's `reauthenticateIn` interval. The supported values use ISO 8601 period format for recurring time intervals (for example, `PT1H`).

Returns:

reauthenticateIn

setReauthenticateIn

public void setReauthenticateIn(String reauthenticateIn)

required

public PossessionConstraint required(Boolean required)

getRequired

@Nullable
public Boolean getRequired()

This property indicates whether the knowledge or possession factor is required by the assurance. It's optional in the request, but is always returned in the response. By default, this field is `true`. If the knowledge or possession constraint has values for `excludedAuthenticationMethods` the `required` value is false. <x-lifecycle class=\"oie\"></x-lifecycle>

Returns:

required

setRequired

public void setRequired(Boolean required)

types

public PossessionConstraint types(List<PossessionConstraint.TypesEnum> types)

addtypesItem

public PossessionConstraint addtypesItem(PossessionConstraint.TypesEnum typesItem)

getTypes

@Nullable
public List<PossessionConstraint.TypesEnum> getTypes()

The Authenticator types that are permitted

Returns:

types

setTypes

public void setTypes(List<PossessionConstraint.TypesEnum> types)

deviceBound

public PossessionConstraint deviceBound(PossessionConstraint.DeviceBoundEnum deviceBound)

getDeviceBound

@Nullable
public PossessionConstraint.DeviceBoundEnum getDeviceBound()

Indicates if device-bound Factors are required. This property is only set for `POSSESSION` constraints.

Returns:

deviceBound

setDeviceBound

public void setDeviceBound(PossessionConstraint.DeviceBoundEnum deviceBound)

hardwareProtection

public PossessionConstraint hardwareProtection(PossessionConstraint.HardwareProtectionEnum hardwareProtection)

getHardwareProtection

@Nullable
public PossessionConstraint.HardwareProtectionEnum getHardwareProtection()

Indicates if any secrets or private keys used during authentication must be hardware protected and not exportable. This property is only set for `POSSESSION` constraints.

Returns:

hardwareProtection

setHardwareProtection

public void setHardwareProtection(PossessionConstraint.HardwareProtectionEnum hardwareProtection)

phishingResistant

public PossessionConstraint phishingResistant(PossessionConstraint.PhishingResistantEnum phishingResistant)

getPhishingResistant

@Nullable
public PossessionConstraint.PhishingResistantEnum getPhishingResistant()

Indicates if phishing-resistant Factors are required. This property is only set for `POSSESSION` constraints.

Returns:

phishingResistant

setPhishingResistant

public void setPhishingResistant(PossessionConstraint.PhishingResistantEnum phishingResistant)

userPresence

public PossessionConstraint userPresence(PossessionConstraint.UserPresenceEnum userPresence)

getUserPresence

@Nullable
public PossessionConstraint.UserPresenceEnum getUserPresence()

Indicates if the user needs to approve an Okta Verify prompt or provide biometrics (meets NIST AAL2 requirements). This property is only set for `POSSESSION` constraints.

Returns:

userPresence

setUserPresence

public void setUserPresence(PossessionConstraint.UserPresenceEnum userPresence)

userVerification

public PossessionConstraint userVerification(PossessionConstraint.UserVerificationEnum userVerification)

getUserVerification

@Nullable
public PossessionConstraint.UserVerificationEnum getUserVerification()

Indicates the user interaction requirement (PIN or biometrics) to ensure verification of a possession factor

Returns:

userVerification

setUserVerification

public void setUserVerification(PossessionConstraint.UserVerificationEnum userVerification)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object