docs.PossessionConstraint.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of okta-sdk-api Show documentation

The Okta Java SDK API .jar provides a Java API that your code can use to make calls to the Okta API. This .jar is the only compile-time dependency within the Okta SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

There is a newer version: 21.0.0

Show newest version



# PossessionConstraint


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**authenticationMethods** | [**List<AuthenticationMethodObject>**](AuthenticationMethodObject.md) | This property specifies the precise authenticator and method for authentication. <x-lifecycle class=\"oie\"></x-lifecycle> |  [optional] |
|**excludedAuthenticationMethods** | [**List<AuthenticationMethodObject>**](AuthenticationMethodObject.md) | This property specifies the precise authenticator and method to exclude from authentication. <x-lifecycle class=\"oie\"></x-lifecycle> |  [optional] |
|**methods** | [**List<MethodsEnum>**](#List<MethodsEnum>) | The Authenticator methods that are permitted |  [optional] |
|**reauthenticateIn** | **String** | 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`). |  [optional] |
|**required** | **Boolean** | 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> |  [optional] |
|**types** | [**List<TypesEnum>**](#List<TypesEnum>) | The Authenticator types that are permitted |  [optional] |
|**deviceBound** | [**DeviceBoundEnum**](#DeviceBoundEnum) | Indicates if device-bound Factors are required. This property is only set for `POSSESSION` constraints. |  [optional] |
|**hardwareProtection** | [**HardwareProtectionEnum**](#HardwareProtectionEnum) | 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. |  [optional] |
|**phishingResistant** | [**PhishingResistantEnum**](#PhishingResistantEnum) | Indicates if phishing-resistant Factors are required. This property is only set for `POSSESSION` constraints. |  [optional] |
|**userPresence** | [**UserPresenceEnum**](#UserPresenceEnum) | 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. |  [optional] |
|**userVerification** | [**UserVerificationEnum**](#UserVerificationEnum) | Indicates the user interaction requirement (PIN or biometrics) to ensure verification of a possession factor |  [optional] |



## Enum: List<MethodsEnum>

| Name | Value |
|---- | -----|
| PASSWORD | "PASSWORD" |
| SECURITY_QUESTION | "SECURITY_QUESTION" |
| SMS | "SMS" |
| VOICE | "VOICE" |
| EMAIL | "EMAIL" |
| PUSH | "PUSH" |
| SIGNED_NONCE | "SIGNED_NONCE" |
| OTP | "OTP" |
| TOTP | "TOTP" |
| WEBAUTHN | "WEBAUTHN" |
| DUO | "DUO" |
| IDP | "IDP" |
| CERT | "CERT" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: List<TypesEnum>

| Name | Value |
|---- | -----|
| SECURITY_KEY | "SECURITY_KEY" |
| PHONE | "PHONE" |
| EMAIL | "EMAIL" |
| PASSWORD | "PASSWORD" |
| SECURITY_QUESTION | "SECURITY_QUESTION" |
| APP | "APP" |
| FEDERATED | "FEDERATED" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: DeviceBoundEnum

| Name | Value |
|---- | -----|
| OPTIONAL | "OPTIONAL" |
| REQUIRED | "REQUIRED" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: HardwareProtectionEnum

| Name | Value |
|---- | -----|
| OPTIONAL | "OPTIONAL" |
| REQUIRED | "REQUIRED" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: PhishingResistantEnum

| Name | Value |
|---- | -----|
| OPTIONAL | "OPTIONAL" |
| REQUIRED | "REQUIRED" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: UserPresenceEnum

| Name | Value |
|---- | -----|
| OPTIONAL | "OPTIONAL" |
| REQUIRED | "REQUIRED" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: UserVerificationEnum

| Name | Value |
|---- | -----|
| OPTIONAL | "OPTIONAL" |
| REQUIRED | "REQUIRED" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |


## Implemented Interfaces

* Serializable