Package com.okta.sdk.resource.model

Class ProfileEnrollmentPolicyRuleAction

java.lang.Object

com.okta.sdk.resource.model.ProfileEnrollmentPolicyRuleAction

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]",
           comments="Generator version: 7.15.0")
public class ProfileEnrollmentPolicyRuleAction
extends Object
implements Serializable

ProfileEnrollmentPolicyRuleAction

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProfileEnrollmentPolicyRuleAction.AccessEnum	Indicates if the user profile is granted access > **Note:** You can't set the `access` property to `DENY` after you create the policy
static enum	ProfileEnrollmentPolicyRuleAction.ProgressiveProfilingActionEnum	Progressive profile enrollment helps evaluate the user profile policy at every user login.
static enum	ProfileEnrollmentPolicyRuleAction.UnknownUserActionEnum	Which action should be taken if this user is new

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ACCESS
static final String	JSON_PROPERTY_ACTIVATION_REQUIREMENTS
static final String	JSON_PROPERTY_ALLOWED_IDENTIFIERS
static final String	JSON_PROPERTY_ENROLL_AUTHENTICATOR_TYPES
static final String	JSON_PROPERTY_PRE_REGISTRATION_INLINE_HOOKS
static final String	JSON_PROPERTY_PROFILE_ATTRIBUTES
static final String	JSON_PROPERTY_PROGRESSIVE_PROFILING_ACTION
static final String	JSON_PROPERTY_TARGET_GROUP_IDS
static final String	JSON_PROPERTY_UI_SCHEMA_ID
static final String	JSON_PROPERTY_UNKNOWN_USER_ACTION

Constructor Summary

Constructors

Constructor	Description
ProfileEnrollmentPolicyRuleAction()

Method Summary

Modifier and Type	Method	Description
ProfileEnrollmentPolicyRuleAction	access(ProfileEnrollmentPolicyRuleAction.AccessEnum access)
ProfileEnrollmentPolicyRuleAction	activationRequirements(ProfileEnrollmentPolicyRuleActivationRequirement activationRequirements)
ProfileEnrollmentPolicyRuleAction	addallowedIdentifiersItem(String allowedIdentifiersItem)
ProfileEnrollmentPolicyRuleAction	addenrollAuthenticatorTypesItem(String enrollAuthenticatorTypesItem)
ProfileEnrollmentPolicyRuleAction	addpreRegistrationInlineHooksItem(PreRegistrationInlineHook preRegistrationInlineHooksItem)
ProfileEnrollmentPolicyRuleAction	addprofileAttributesItem(ProfileEnrollmentPolicyRuleProfileAttribute profileAttributesItem)
ProfileEnrollmentPolicyRuleAction	addtargetGroupIdsItem(String targetGroupIdsItem)
ProfileEnrollmentPolicyRuleAction	allowedIdentifiers(List<String> allowedIdentifiers)
ProfileEnrollmentPolicyRuleAction	enrollAuthenticatorTypes(List<String> enrollAuthenticatorTypes)
boolean	equals(Object o)
ProfileEnrollmentPolicyRuleAction.AccessEnum	getAccess()	Indicates if the user profile is granted access > **Note:** You can't set the `access` property to `DENY` after you create the policy
ProfileEnrollmentPolicyRuleActivationRequirement	getActivationRequirements()	Get activationRequirements
List<String>	getAllowedIdentifiers()	A list of attributes to identify an end user.
List<String>	getEnrollAuthenticatorTypes()	Additional authenticator fields that can be used on the first page of user registration.
List<PreRegistrationInlineHook>	getPreRegistrationInlineHooks()	(Optional) The `id` of at most one registration inline hook
List<ProfileEnrollmentPolicyRuleProfileAttribute>	getProfileAttributes()	A list of attributes to prompt the user for during registration or progressive profiling.
ProfileEnrollmentPolicyRuleAction.ProgressiveProfilingActionEnum	getProgressiveProfilingAction()	Progressive profile enrollment helps evaluate the user profile policy at every user login.
List<String>	getTargetGroupIds()	(Optional, max 1 entry) The `id` of a group that this user should be added to
String	getUiSchemaId()	Value created by the backend.
ProfileEnrollmentPolicyRuleAction.UnknownUserActionEnum	getUnknownUserAction()	Which action should be taken if this user is new
int	hashCode()
ProfileEnrollmentPolicyRuleAction	preRegistrationInlineHooks(List<PreRegistrationInlineHook> preRegistrationInlineHooks)
ProfileEnrollmentPolicyRuleAction	profileAttributes(List<ProfileEnrollmentPolicyRuleProfileAttribute> profileAttributes)
ProfileEnrollmentPolicyRuleAction	progressiveProfilingAction(ProfileEnrollmentPolicyRuleAction.ProgressiveProfilingActionEnum progressiveProfilingAction)
void	setAccess(ProfileEnrollmentPolicyRuleAction.AccessEnum access)
void	setActivationRequirements(ProfileEnrollmentPolicyRuleActivationRequirement activationRequirements)
void	setAllowedIdentifiers(List<String> allowedIdentifiers)
void	setEnrollAuthenticatorTypes(List<String> enrollAuthenticatorTypes)
void	setPreRegistrationInlineHooks(List<PreRegistrationInlineHook> preRegistrationInlineHooks)
void	setProfileAttributes(List<ProfileEnrollmentPolicyRuleProfileAttribute> profileAttributes)
void	setProgressiveProfilingAction(ProfileEnrollmentPolicyRuleAction.ProgressiveProfilingActionEnum progressiveProfilingAction)
void	setTargetGroupIds(List<String> targetGroupIds)
void	setUiSchemaId(String uiSchemaId)
void	setUnknownUserAction(ProfileEnrollmentPolicyRuleAction.UnknownUserActionEnum unknownUserAction)
ProfileEnrollmentPolicyRuleAction	targetGroupIds(List<String> targetGroupIds)
String	toString()
ProfileEnrollmentPolicyRuleAction	uiSchemaId(String uiSchemaId)
ProfileEnrollmentPolicyRuleAction	unknownUserAction(ProfileEnrollmentPolicyRuleAction.UnknownUserActionEnum unknownUserAction)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_ACCESS

public static final String JSON_PROPERTY_ACCESS

See Also:

• Constant Field Values

JSON_PROPERTY_ACTIVATION_REQUIREMENTS

public static final String JSON_PROPERTY_ACTIVATION_REQUIREMENTS

See Also:

• Constant Field Values

JSON_PROPERTY_ALLOWED_IDENTIFIERS

public static final String JSON_PROPERTY_ALLOWED_IDENTIFIERS

See Also:

• Constant Field Values

JSON_PROPERTY_ENROLL_AUTHENTICATOR_TYPES

public static final String JSON_PROPERTY_ENROLL_AUTHENTICATOR_TYPES

See Also:

• Constant Field Values

JSON_PROPERTY_PRE_REGISTRATION_INLINE_HOOKS

public static final String JSON_PROPERTY_PRE_REGISTRATION_INLINE_HOOKS

See Also:

• Constant Field Values

JSON_PROPERTY_PROFILE_ATTRIBUTES

public static final String JSON_PROPERTY_PROFILE_ATTRIBUTES

See Also:

• Constant Field Values

JSON_PROPERTY_PROGRESSIVE_PROFILING_ACTION

public static final String JSON_PROPERTY_PROGRESSIVE_PROFILING_ACTION

See Also:

• Constant Field Values

JSON_PROPERTY_TARGET_GROUP_IDS

public static final String JSON_PROPERTY_TARGET_GROUP_IDS

See Also:

• Constant Field Values

JSON_PROPERTY_UI_SCHEMA_ID

public static final String JSON_PROPERTY_UI_SCHEMA_ID

See Also:

• Constant Field Values

JSON_PROPERTY_UNKNOWN_USER_ACTION

public static final String JSON_PROPERTY_UNKNOWN_USER_ACTION

See Also:

• Constant Field Values

Constructor Details

ProfileEnrollmentPolicyRuleAction

public ProfileEnrollmentPolicyRuleAction()

Method Details

access

public ProfileEnrollmentPolicyRuleAction access(ProfileEnrollmentPolicyRuleAction.AccessEnum access)

getAccess

@Nullable
public ProfileEnrollmentPolicyRuleAction.AccessEnum getAccess()

Indicates if the user profile is granted access > **Note:** You can't set the `access` property to `DENY` after you create the policy

Returns:

access

setAccess

public void setAccess(ProfileEnrollmentPolicyRuleAction.AccessEnum access)

activationRequirements

public ProfileEnrollmentPolicyRuleAction activationRequirements(ProfileEnrollmentPolicyRuleActivationRequirement activationRequirements)

getActivationRequirements

@Nullable
public ProfileEnrollmentPolicyRuleActivationRequirement getActivationRequirements()

Get activationRequirements

Returns:

activationRequirements

setActivationRequirements

public void setActivationRequirements(ProfileEnrollmentPolicyRuleActivationRequirement activationRequirements)

allowedIdentifiers

public ProfileEnrollmentPolicyRuleAction allowedIdentifiers(List<String> allowedIdentifiers)

addallowedIdentifiersItem

public ProfileEnrollmentPolicyRuleAction addallowedIdentifiersItem(String allowedIdentifiersItem)

getAllowedIdentifiers

@Nullable
public List<String> getAllowedIdentifiers()

A list of attributes to identify an end user. Can be used across Okta sign-in, unlock, and recovery flows.

Returns:

allowedIdentifiers

setAllowedIdentifiers

public void setAllowedIdentifiers(List<String> allowedIdentifiers)

enrollAuthenticatorTypes

public ProfileEnrollmentPolicyRuleAction enrollAuthenticatorTypes(List<String> enrollAuthenticatorTypes)

addenrollAuthenticatorTypesItem

public ProfileEnrollmentPolicyRuleAction addenrollAuthenticatorTypesItem(String enrollAuthenticatorTypesItem)

getEnrollAuthenticatorTypes

@Nullable
public List<String> getEnrollAuthenticatorTypes()

Additional authenticator fields that can be used on the first page of user registration. Valid values only includes `'password'`.

Returns:

enrollAuthenticatorTypes

setEnrollAuthenticatorTypes

public void setEnrollAuthenticatorTypes(List<String> enrollAuthenticatorTypes)

preRegistrationInlineHooks

public ProfileEnrollmentPolicyRuleAction preRegistrationInlineHooks(List<PreRegistrationInlineHook> preRegistrationInlineHooks)

addpreRegistrationInlineHooksItem

public ProfileEnrollmentPolicyRuleAction addpreRegistrationInlineHooksItem(PreRegistrationInlineHook preRegistrationInlineHooksItem)

getPreRegistrationInlineHooks

@Nullable
public List<PreRegistrationInlineHook> getPreRegistrationInlineHooks()

(Optional) The `id` of at most one registration inline hook

Returns:

preRegistrationInlineHooks

setPreRegistrationInlineHooks

public void setPreRegistrationInlineHooks(List<PreRegistrationInlineHook> preRegistrationInlineHooks)

profileAttributes

public ProfileEnrollmentPolicyRuleAction profileAttributes(List<ProfileEnrollmentPolicyRuleProfileAttribute> profileAttributes)

addprofileAttributesItem

public ProfileEnrollmentPolicyRuleAction addprofileAttributesItem(ProfileEnrollmentPolicyRuleProfileAttribute profileAttributesItem)

getProfileAttributes

@Nullable
public List<ProfileEnrollmentPolicyRuleProfileAttribute> getProfileAttributes()

A list of attributes to prompt the user for during registration or progressive profiling. Where defined on the user schema, these attributes are persisted in the user profile. You can also add non-schema attributes, 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.

Returns:

profileAttributes

setProfileAttributes

public void setProfileAttributes(List<ProfileEnrollmentPolicyRuleProfileAttribute> profileAttributes)

progressiveProfilingAction

public ProfileEnrollmentPolicyRuleAction progressiveProfilingAction(ProfileEnrollmentPolicyRuleAction.ProgressiveProfilingActionEnum progressiveProfilingAction)

getProgressiveProfilingAction

@Nullable
public ProfileEnrollmentPolicyRuleAction.ProgressiveProfilingActionEnum getProgressiveProfilingAction()

Progressive profile enrollment helps evaluate the user profile policy at every user login. Users can be prompted to provide input for newly required attributes.

Returns:

progressiveProfilingAction

setProgressiveProfilingAction

public void setProgressiveProfilingAction(ProfileEnrollmentPolicyRuleAction.ProgressiveProfilingActionEnum progressiveProfilingAction)

targetGroupIds

public ProfileEnrollmentPolicyRuleAction targetGroupIds(List<String> targetGroupIds)

addtargetGroupIdsItem

public ProfileEnrollmentPolicyRuleAction addtargetGroupIdsItem(String targetGroupIdsItem)

getTargetGroupIds

@Nullable
public List<String> getTargetGroupIds()

(Optional, max 1 entry) The `id` of a group that this user should be added to

Returns:

targetGroupIds

setTargetGroupIds

public void setTargetGroupIds(List<String> targetGroupIds)

uiSchemaId

public ProfileEnrollmentPolicyRuleAction uiSchemaId(String uiSchemaId)

getUiSchemaId

@Nullable
public String getUiSchemaId()

Value created by the backend. If present, all policy updates must include this attribute/value.

Returns:

uiSchemaId

setUiSchemaId

public void setUiSchemaId(String uiSchemaId)

unknownUserAction

public ProfileEnrollmentPolicyRuleAction unknownUserAction(ProfileEnrollmentPolicyRuleAction.UnknownUserActionEnum unknownUserAction)

getUnknownUserAction

@Nullable
public ProfileEnrollmentPolicyRuleAction.UnknownUserActionEnum getUnknownUserAction()

Which action should be taken if this user is new

Returns:

unknownUserAction

setUnknownUserAction

public void setUnknownUserAction(ProfileEnrollmentPolicyRuleAction.UnknownUserActionEnum unknownUserAction)

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