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



# ProfileEnrollmentPolicyRuleAction


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**access** | [**AccessEnum**](#AccessEnum) | **Note:** The Profile Enrollment Action object can't be modified to set the `access` property to `DENY` after the policy is created. |  [optional] |
|**activationRequirements** | [**ProfileEnrollmentPolicyRuleActivationRequirement**](ProfileEnrollmentPolicyRuleActivationRequirement.md) |  |  [optional] |
|**allowedIdentifiers** | **List<String>** | <x-lifecycle class=\"ea\"></x-lifecycle> A list of attributes to identify an end user. Can be used across Okta sign-in, unlock, and recovery flows. |  [optional] |
|**enrollAuthenticatorTypes** | **List<String>** | Additional authenticator fields that can be used on the first page of user registration. Valid values only includes `'password'`. |  [optional] |
|**preRegistrationInlineHooks** | [**List<PreRegistrationInlineHook>**](PreRegistrationInlineHook.md) | (Optional) The `id` of at most one registration inline hook |  [optional] |
|**profileAttributes** | [**List<ProfileEnrollmentPolicyRuleProfileAttribute>**](ProfileEnrollmentPolicyRuleProfileAttribute.md) | A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes can also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported. |  [optional] |
|**progressiveProfilingAction** | [**ProgressiveProfilingActionEnum**](#ProgressiveProfilingActionEnum) | Progressive profile enrollment helps evaluate the profile enrollment policy at every user login. Users can be prompted to provide input for newly required attributes. |  [optional] |
|**targetGroupIds** | **List<String>** | (Optional, max 1 entry) The `id` of a Group that this User should be added to |  [optional] |
|**uiSchemaId** | **String** | Value created by the backend. If present, all policy updates must include this attribute/value. |  [optional] |
|**unknownUserAction** | [**UnknownUserActionEnum**](#UnknownUserActionEnum) | Which action should be taken if this User is new |  [optional] |



## Enum: AccessEnum

| Name | Value |
|---- | -----|
| ALLOW | "ALLOW" |
| DENY | "DENY" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: ProgressiveProfilingActionEnum

| Name | Value |
|---- | -----|
| ENABLED | "ENABLED" |
| DISABLED | "DISABLED" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: UnknownUserActionEnum

| Name | Value |
|---- | -----|
| DENY | "DENY" |
| REGISTER | "REGISTER" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |


## Implemented Interfaces

* Serializable