com.okta.sdk.resource.policy

Interface Policy

All Superinterfaces:

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

All Known Subinterfaces:

AccessPolicy, IdentityProviderPolicy, OAuthAuthorizationPolicy, OktaSignOnPolicy, PasswordPolicy, ProfileEnrollmentPolicy

All Known Implementing Classes:

DefaultAccessPolicy, DefaultIdentityProviderPolicy, DefaultOAuthAuthorizationPolicy, DefaultOktaSignOnPolicy, DefaultPasswordPolicy, DefaultPolicy, DefaultProfileEnrollmentPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-02-02T10:57:05.026-06:00")
public interface Policy
extends ExtensibleResource, Deletable

Policy

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Policy.StatusEnum Enum status

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.
PolicyRule	createRule(PolicyRule policyRule) Creates a policy rule.
void	deactivate() Deactivates a policy.
void	delete() Removes a policy.
PolicyRuleConditions	getConditions()
Date	getCreated()
String	getDescription()
Map<String,Object>	getEmbedded()
String	getId()
Date	getLastUpdated()
Map<String,Object>	getLinks()
String	getName()
PolicyRule	getPolicyRule(String ruleId) Gets a policy rule.
Integer	getPriority()
Policy.StatusEnum	getStatus()
Boolean	getSystem()
PolicyType	getType()
PolicyRuleList	listPolicyRules() Enumerates all policy rules.
Policy	setConditions(PolicyRuleConditions conditions)
Policy	setDescription(String description)
Policy	setName(String name)
Policy	setPriority(Integer priority)
Policy	setStatus(Policy.StatusEnum status)
Policy	setSystem(Boolean system)
Policy	setType(PolicyType type)
Policy	update() Updates a policy.

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

getEmbedded

Map<String,Object> getEmbedded()

getLinks

Map<String,Object> getLinks()

getConditions

PolicyRuleConditions getConditions()

setConditions

Policy setConditions(PolicyRuleConditions conditions)

getCreated

Date getCreated()

getDescription

String getDescription()

setDescription

Policy setDescription(String description)

getId

String getId()

getLastUpdated

Date getLastUpdated()

getName

String getName()

setName

Policy setName(String name)

getPriority

Integer getPriority()

setPriority

Policy setPriority(Integer priority)

getStatus

Policy.StatusEnum getStatus()

setStatus

Policy setStatus(Policy.StatusEnum status)

getSystem

Boolean getSystem()

setSystem

Policy setSystem(Boolean system)

getType

PolicyType getType()

setType

Policy setType(PolicyType type)

createRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-02-02T10:57:05.026-06:00",
           comments="POST - /api/v1/policies/{policyId}/rules")
PolicyRule createRule(PolicyRule policyRule)

Creates a policy rule.

Parameters:

policyRule - (required)

Returns:

PolicyRule

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-02-02T10:57:05.026-06:00",
           comments="POST - /api/v1/policies/{policyId}/lifecycle/deactivate")
void deactivate()

Deactivates a policy.

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-02-02T10:57:05.026-06:00",
           comments="PUT - /api/v1/policies/{policyId}")
Policy update()

Updates a policy.

Returns:

Policy

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-02-02T10:57:05.026-06:00",
           comments="DELETE - /api/v1/policies/{policyId}")
void delete()

Removes a policy.

Specified by:

delete in interface Deletable

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-02-02T10:57:05.026-06:00",
           comments="POST - /api/v1/policies/{policyId}/lifecycle/activate")
void activate()

Activates a policy.

listPolicyRules

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-02-02T10:57:05.026-06:00",
           comments="GET - /api/v1/policies/{policyId}/rules")
PolicyRuleList listPolicyRules()

Enumerates all policy rules.

Returns:

PolicyRuleList

getPolicyRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-02-02T10:57:05.026-06:00",
           comments="GET - /api/v1/policies/{policyId}/rules/{ruleId}")
PolicyRule getPolicyRule(String ruleId)

Gets a policy rule.

Parameters:

ruleId - (required)

Returns:

PolicyRule