com.okta.sdk.resource.policy

Interface PolicyRule

All Superinterfaces:

Deletable, ExtensibleResource, Map<String,Object>, PropertyRetriever, Resource

All Known Subinterfaces:

AccessPolicyRule, OktaSignOnPolicyRule, PasswordPolicyRule, ProfileEnrollmentPolicyRule

All Known Implementing Classes:

DefaultAccessPolicyRule, DefaultOktaSignOnPolicyRule, DefaultPasswordPolicyRule, DefaultPolicyRule, DefaultProfileEnrollmentPolicyRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
public interface PolicyRule
extends ExtensibleResource, Deletable

PolicyRule

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PolicyRule.StatusEnum Enum status
static class	PolicyRule.TypeEnum Enum type

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	activate() Activates a policy rule.
void	deactivate() Deactivates a policy rule.
void	delete() Removes a policy rule.
PolicyRuleActions	getActions()
PolicyRuleConditions	getConditions()
Date	getCreated()
String	getId()
Date	getLastUpdated()
String	getName()
Integer	getPriority()
PolicyRule.StatusEnum	getStatus()
Boolean	getSystem()
PolicyRule.TypeEnum	getType()
PolicyRule	setActions(PolicyRuleActions actions)
PolicyRule	setConditions(PolicyRuleConditions conditions)
PolicyRule	setName(String name)
PolicyRule	setPriority(Integer priority)
PolicyRule	setStatus(PolicyRule.StatusEnum status)
PolicyRule	setSystem(Boolean system)
PolicyRule	setType(PolicyRule.TypeEnum type)
PolicyRule	update() Updates a policy rule.

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getActions

PolicyRuleActions getActions()

setActions

PolicyRule setActions(PolicyRuleActions actions)

getConditions

PolicyRuleConditions getConditions()

setConditions

PolicyRule setConditions(PolicyRuleConditions conditions)

getCreated

Date getCreated()

getId

String getId()

getLastUpdated

Date getLastUpdated()

getName

String getName()

setName

PolicyRule setName(String name)

getPriority

Integer getPriority()

setPriority

PolicyRule setPriority(Integer priority)

getStatus

PolicyRule.StatusEnum getStatus()

setStatus

PolicyRule setStatus(PolicyRule.StatusEnum status)

getSystem

Boolean getSystem()

setSystem

PolicyRule setSystem(Boolean system)

getType

PolicyRule.TypeEnum getType()

setType

PolicyRule setType(PolicyRule.TypeEnum type)

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="PUT - /api/v1/policies/{policyId}/rules/{ruleId}")
PolicyRule update()

Updates a policy rule.

Returns:

PolicyRule

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate")
void activate()

Activates a policy rule.

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate")
void deactivate()

Deactivates a policy rule.

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/policies/{policyId}/rules/{ruleId}")
void delete()

Removes a policy rule.

Specified by:

delete in interface Deletable