docs.AuthenticationMethod.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.

The newest version!



# AuthenticationMethod


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**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] |
|**id** | **String** | An ID that identifies the authenticator |  [optional] |
|**key** | **String** | A label that identifies the authenticator |  |
|**method** | **String** | Specifies the method used for the authenticator |  |
|**phishingResistant** | [**PhishingResistantEnum**](#PhishingResistantEnum) | Indicates if phishing-resistant Factors are required. 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: 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: UserVerificationEnum

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


## Implemented Interfaces

* Serializable