com.okta.sdk.resource.authorization.server

Interface AuthorizationServerPolicy

All Superinterfaces:

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

All Known Implementing Classes:

DefaultAuthorizationServerPolicy

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

AuthorizationServerPolicy

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthorizationServerPolicy.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(String authServerId) Activate Authorization Server Policy
AuthorizationServerPolicyRule	createPolicyRule(String authServerId, AuthorizationServerPolicyRule policyRule) Creates a policy rule for the specified Custom Authorization Server and Policy.
void	deactivate(String authServerId) Deactivate Authorization Server Policy
void	delete(String authServerId) Success
void	deletePolicyRule(String authServerId, String ruleId) Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.
PolicyRuleConditions	getConditions()
Date	getCreated()
String	getDescription()
Map<String,Object>	getEmbedded()
String	getId()
Date	getLastUpdated()
Map<String,Object>	getLinks()
String	getName()
AuthorizationServerPolicyRule	getPolicyRule(String authServerId, String ruleId) Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.
Integer	getPriority()
AuthorizationServerPolicy.StatusEnum	getStatus()
Boolean	getSystem()
PolicyType	getType()
AuthorizationServerPolicyRuleList	listPolicyRules(String authServerId) Enumerates all policy rules for the specified Custom Authorization Server and Policy.
AuthorizationServerPolicy	setConditions(PolicyRuleConditions conditions)
AuthorizationServerPolicy	setDescription(String description)
AuthorizationServerPolicy	setName(String name)
AuthorizationServerPolicy	setPriority(Integer priority)
AuthorizationServerPolicy	setStatus(AuthorizationServerPolicy.StatusEnum status)
AuthorizationServerPolicy	setSystem(Boolean system)
AuthorizationServerPolicy	setType(PolicyType type)
AuthorizationServerPolicy	update(String authServerId) Success

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

AuthorizationServerPolicy setConditions(PolicyRuleConditions conditions)

getCreated

Date getCreated()

getDescription

String getDescription()

setDescription

AuthorizationServerPolicy setDescription(String description)

getId

String getId()

getLastUpdated

Date getLastUpdated()

getName

String getName()

setName

AuthorizationServerPolicy setName(String name)

getPriority

Integer getPriority()

setPriority

AuthorizationServerPolicy setPriority(Integer priority)

getStatus

AuthorizationServerPolicy.StatusEnum getStatus()

setStatus

AuthorizationServerPolicy setStatus(AuthorizationServerPolicy.StatusEnum status)

getSystem

Boolean getSystem()

setSystem

AuthorizationServerPolicy setSystem(Boolean system)

getType

PolicyType getType()

setType

AuthorizationServerPolicy setType(PolicyType type)

getPolicyRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}")
AuthorizationServerPolicyRule getPolicyRule(String authServerId,
                                                                                                                                                                                                                                                                               String ruleId)

Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.

Parameters:

authServerId - (required)

ruleId - (required)

Returns:

AuthorizationServerPolicyRule

deactivate

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

Deactivate Authorization Server Policy

Parameters:

authServerId - (required)

createPolicyRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules")
AuthorizationServerPolicyRule createPolicyRule(String authServerId,
                                                                                                                                                                                                                                                                          AuthorizationServerPolicyRule policyRule)

Creates a policy rule for the specified Custom Authorization Server and Policy.

Parameters:

authServerId - (required)

policyRule - (required)

Returns:

AuthorizationServerPolicyRule

update

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

Success

Parameters:

authServerId - (required)

Returns:

AuthorizationServerPolicy

delete

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

Success

Parameters:

authServerId - (required)

listPolicyRules

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules")
AuthorizationServerPolicyRuleList listPolicyRules(String authServerId)

Enumerates all policy rules for the specified Custom Authorization Server and Policy.

Parameters:

authServerId - (required)

Returns:

AuthorizationServerPolicyRuleList

activate

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

Activate Authorization Server Policy

Parameters:

authServerId - (required)

deletePolicyRule

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

Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.

Parameters:

authServerId - (required)

ruleId - (required)