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="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.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	**Note:** The Profile Enrollment Action object can't be modified to set the `access` property to `DENY` after the policy is created.
static enum	ProfileEnrollmentPolicyRuleAction.ProgressiveProfilingActionEnum	Progressive profile enrollment helps evaluate the profile enrollment 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()	**Note:** The Profile Enrollment Action object can't be modified to set the `access` property to `DENY` after the policy is created.
ProfileEnrollmentPolicyRuleActivationRequirement	getActivationRequirements()	Get activationRequirements
List<String>	getAllowedIdentifiers()	<x-lifecycle class=\"ea\"></x-lifecycle> 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 during registration or progressive profiling.
ProfileEnrollmentPolicyRuleAction.ProgressiveProfilingActionEnum	getProgressiveProfilingAction()	Progressive profile enrollment helps evaluate the profile enrollment 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()

**Note:** The Profile Enrollment Action object can't be modified to set the `access` property to `DENY` after the policy is created.

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()

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

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

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 profile enrollment 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