Package com.okta.sdk.resource.api

Class PolicyApi

java.lang.Object

com.okta.sdk.resource.api.PolicyApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-03-29T16:46:27.777599-05:00[America/Chicago]",
           comments="Generator version: 7.4.0")
public class PolicyApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PolicyApi()
PolicyApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	activatePolicy(String policyId)	Activate a Policy Activates a policy
void	activatePolicy(String policyId, Map<String,String> additionalHeaders)	Activate a Policy Activates a policy
void	activatePolicyRule(String policyId, String ruleId)	Activate a Policy Rule Activates a Policy Rule identified by `policyId` and `ruleId`
void	activatePolicyRule(String policyId, String ruleId, Map<String,String> additionalHeaders)	Activate a Policy Rule Activates a Policy Rule identified by `policyId` and `ruleId`
Policy	clonePolicy(String policyId)	Clone an existing Policy Clones an existing policy
Policy	clonePolicy(String policyId, Map<String,String> additionalHeaders)	Clone an existing Policy Clones an existing policy
Policy	createPolicy(Policy policy, Boolean activate)	Create a Policy Creates a policy
Policy	createPolicy(Policy policy, Boolean activate, Map<String,String> additionalHeaders)	Create a Policy Creates a policy
PolicyRule	createPolicyRule(String policyId, PolicyRule policyRule)	Create a Policy Rule Creates a policy rule
PolicyRule	createPolicyRule(String policyId, PolicyRule policyRule, Map<String,String> additionalHeaders)	Create a Policy Rule Creates a policy rule
List<SimulatePolicyEvaluations>	createPolicySimulation(List<SimulatePolicyBody> simulatePolicy, String expand)	Create a Policy Simulation Creates a policy or policy rule simulation.
List<SimulatePolicyEvaluations>	createPolicySimulation(List<SimulatePolicyBody> simulatePolicy, String expand, Map<String,String> additionalHeaders)	Create a Policy Simulation Creates a policy or policy rule simulation.
void	deactivatePolicy(String policyId)	Deactivate a Policy Deactivates a policy
void	deactivatePolicy(String policyId, Map<String,String> additionalHeaders)	Deactivate a Policy Deactivates a policy
void	deactivatePolicyRule(String policyId, String ruleId)	Deactivate a Policy Rule Deactivates a Policy Rule identified by `policyId` and `ruleId`
void	deactivatePolicyRule(String policyId, String ruleId, Map<String,String> additionalHeaders)	Deactivate a Policy Rule Deactivates a Policy Rule identified by `policyId` and `ruleId`
void	deletePolicy(String policyId)	Delete a Policy Deletes a policy
void	deletePolicy(String policyId, Map<String,String> additionalHeaders)	Delete a Policy Deletes a policy
void	deletePolicyResourceMapping(String policyId, String mappingId)	Delete a policy resource Mapping Deletes the resource Mapping for a Policy identified by `policyId` and `mappingId`
void	deletePolicyResourceMapping(String policyId, String mappingId, Map<String,String> additionalHeaders)	Delete a policy resource Mapping Deletes the resource Mapping for a Policy identified by `policyId` and `mappingId`
void	deletePolicyRule(String policyId, String ruleId)	Delete a Policy Rule Deletes a Policy Rule identified by `policyId` and `ruleId`
void	deletePolicyRule(String policyId, String ruleId, Map<String,String> additionalHeaders)	Delete a Policy Rule Deletes a Policy Rule identified by `policyId` and `ruleId`
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
Policy	getPolicy(String policyId, String expand)	Retrieve a Policy Retrieves a policy
Policy	getPolicy(String policyId, String expand, Map<String,String> additionalHeaders)	Retrieve a Policy Retrieves a policy
PolicyMapping	getPolicyMapping(String policyId, String mappingId)	Retrieve a policy resource Mapping Retrieves a resource Mapping for a Policy identified by `policyId` and `mappingId`
PolicyMapping	getPolicyMapping(String policyId, String mappingId, Map<String,String> additionalHeaders)	Retrieve a policy resource Mapping Retrieves a resource Mapping for a Policy identified by `policyId` and `mappingId`
PolicyRule	getPolicyRule(String policyId, String ruleId)	Retrieve a Policy Rule Retrieves a policy rule
PolicyRule	getPolicyRule(String policyId, String ruleId, Map<String,String> additionalHeaders)	Retrieve a Policy Rule Retrieves a policy rule
List<Policy>	listPolicies(String type, String status, String expand)	List all Policies Lists all policies with the specified type
List<Policy>	listPolicies(String type, String status, String expand, Map<String,String> additionalHeaders)	List all Policies Lists all policies with the specified type
List<Application>	listPolicyApps(String policyId)	Deprecated.
List<Application>	listPolicyApps(String policyId, Map<String,String> additionalHeaders)	Deprecated.
List<PolicyMapping>	listPolicyMappings(String policyId)	List all resources mapped to a Policy Lists all resources mapped to a Policy identified by `policyId`
List<PolicyMapping>	listPolicyMappings(String policyId, Map<String,String> additionalHeaders)	List all resources mapped to a Policy Lists all resources mapped to a Policy identified by `policyId`
List<PolicyRule>	listPolicyRules(String policyId)	List all Policy Rules Lists all policy rules
List<PolicyRule>	listPolicyRules(String policyId, Map<String,String> additionalHeaders)	List all Policy Rules Lists all policy rules
PolicyMapping	mapResourceToPolicy(String policyId, PolicyMappingRequest policyMappingRequest)	Map a resource to a Policy Maps a resource to a Policy identified by `policyId`
PolicyMapping	mapResourceToPolicy(String policyId, PolicyMappingRequest policyMappingRequest, Map<String,String> additionalHeaders)	Map a resource to a Policy Maps a resource to a Policy identified by `policyId`
Policy	replacePolicy(String policyId, Policy policy)	Replace a Policy Replaces the properties of a Policy identified by `policyId`
Policy	replacePolicy(String policyId, Policy policy, Map<String,String> additionalHeaders)	Replace a Policy Replaces the properties of a Policy identified by `policyId`
PolicyRule	replacePolicyRule(String policyId, String ruleId, PolicyRule policyRule)	Replace a Policy Rule Replaces the properties for a Policy Rule identified by `policyId` and `ruleId`
PolicyRule	replacePolicyRule(String policyId, String ruleId, PolicyRule policyRule, Map<String,String> additionalHeaders)	Replace a Policy Rule Replaces the properties for a Policy Rule identified by `policyId` and `ruleId`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PolicyApi

public PolicyApi()

PolicyApi

public PolicyApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activatePolicy

public void activatePolicy(String policyId)
                    throws ApiException

Activate a Policy Activates a policy

Parameters:

policyId - `id` of the Policy (required)

Throws:

ApiException - if fails to make API call

activatePolicy

public void activatePolicy(String policyId,
 Map<String,String> additionalHeaders)
                    throws ApiException

Activate a Policy Activates a policy

Parameters:

policyId - `id` of the Policy (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

activatePolicyRule

public void activatePolicyRule(String policyId,
 String ruleId)
                        throws ApiException

Activate a Policy Rule Activates a Policy Rule identified by `policyId` and `ruleId`

Parameters:

policyId - `id` of the Policy (required)

ruleId - `id` of the Policy Rule (required)

Throws:

ApiException - if fails to make API call

activatePolicyRule

public void activatePolicyRule(String policyId,
 String ruleId,
 Map<String,String> additionalHeaders)
                        throws ApiException

Activate a Policy Rule Activates a Policy Rule identified by `policyId` and `ruleId`

Parameters:

policyId - `id` of the Policy (required)

ruleId - `id` of the Policy Rule (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

clonePolicy

public Policy clonePolicy(String policyId)
                   throws ApiException

Clone an existing Policy Clones an existing policy

Parameters:

policyId - `id` of the Policy (required)

Returns:

Policy

Throws:

ApiException - if fails to make API call

clonePolicy

public Policy clonePolicy(String policyId,
 Map<String,String> additionalHeaders)
                   throws ApiException

Clone an existing Policy Clones an existing policy

Parameters:

policyId - `id` of the Policy (required)

additionalHeaders - additionalHeaders for this call

Returns:

Policy

Throws:

ApiException - if fails to make API call

createPolicy

public Policy createPolicy(Policy policy,
 Boolean activate)
                    throws ApiException

Create a Policy Creates a policy

Parameters:

policy - (required)

activate - (optional, default to true)

Returns:

Policy

Throws:

ApiException - if fails to make API call

createPolicy

public Policy createPolicy(Policy policy,
 Boolean activate,
 Map<String,String> additionalHeaders)
                    throws ApiException

Create a Policy Creates a policy

Parameters:

policy - (required)

activate - (optional, default to true)

additionalHeaders - additionalHeaders for this call

Returns:

Policy

Throws:

ApiException - if fails to make API call

createPolicyRule

public PolicyRule createPolicyRule(String policyId,
 PolicyRule policyRule)
                            throws ApiException

Create a Policy Rule Creates a policy rule

Parameters:

policyId - `id` of the Policy (required)

policyRule - (required)

Returns:

PolicyRule

Throws:

ApiException - if fails to make API call

createPolicyRule

public PolicyRule createPolicyRule(String policyId,
 PolicyRule policyRule,
 Map<String,String> additionalHeaders)
                            throws ApiException

Create a Policy Rule Creates a policy rule

Parameters:

policyId - `id` of the Policy (required)

policyRule - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PolicyRule

Throws:

ApiException - if fails to make API call

createPolicySimulation

public List<SimulatePolicyEvaluations> createPolicySimulation(List<SimulatePolicyBody> simulatePolicy,
 String expand)
                                                       throws ApiException

Create a Policy Simulation Creates a policy or policy rule simulation. The access simulation evaluates policy and policy rules based on the existing policy rule configuration. The evaluation result simulates what the real-world authentication flow is and what policy rules have been applied or matched to the authentication flow.

Parameters:

simulatePolicy - (required)

expand - Use `expand=EVALUATED` to include a list of evaluated but not matched policies and policy rules. Use `expand=RULE` to include details about why a rule condition was (not) matched. (optional)

Returns:

List<SimulatePolicyEvaluations>

Throws:

ApiException - if fails to make API call

createPolicySimulation

public List<SimulatePolicyEvaluations> createPolicySimulation(List<SimulatePolicyBody> simulatePolicy,
 String expand,
 Map<String,String> additionalHeaders)
                                                       throws ApiException

Create a Policy Simulation Creates a policy or policy rule simulation. The access simulation evaluates policy and policy rules based on the existing policy rule configuration. The evaluation result simulates what the real-world authentication flow is and what policy rules have been applied or matched to the authentication flow.

Parameters:

simulatePolicy - (required)

expand - Use `expand=EVALUATED` to include a list of evaluated but not matched policies and policy rules. Use `expand=RULE` to include details about why a rule condition was (not) matched. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<SimulatePolicyEvaluations>

Throws:

ApiException - if fails to make API call

deactivatePolicy

public void deactivatePolicy(String policyId)
                      throws ApiException

Deactivate a Policy Deactivates a policy

Parameters:

policyId - `id` of the Policy (required)

Throws:

ApiException - if fails to make API call

deactivatePolicy

public void deactivatePolicy(String policyId,
 Map<String,String> additionalHeaders)
                      throws ApiException

Deactivate a Policy Deactivates a policy

Parameters:

policyId - `id` of the Policy (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deactivatePolicyRule

public void deactivatePolicyRule(String policyId,
 String ruleId)
                          throws ApiException

Deactivate a Policy Rule Deactivates a Policy Rule identified by `policyId` and `ruleId`

Parameters:

policyId - `id` of the Policy (required)

ruleId - `id` of the Policy Rule (required)

Throws:

ApiException - if fails to make API call

deactivatePolicyRule

public void deactivatePolicyRule(String policyId,
 String ruleId,
 Map<String,String> additionalHeaders)
                          throws ApiException

Deactivate a Policy Rule Deactivates a Policy Rule identified by `policyId` and `ruleId`

Parameters:

policyId - `id` of the Policy (required)

ruleId - `id` of the Policy Rule (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deletePolicy

public void deletePolicy(String policyId)
                  throws ApiException

Delete a Policy Deletes a policy

Parameters:

policyId - `id` of the Policy (required)

Throws:

ApiException - if fails to make API call

deletePolicy

public void deletePolicy(String policyId,
 Map<String,String> additionalHeaders)
                  throws ApiException

Delete a Policy Deletes a policy

Parameters:

policyId - `id` of the Policy (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deletePolicyResourceMapping

public void deletePolicyResourceMapping(String policyId,
 String mappingId)
                                 throws ApiException

Delete a policy resource Mapping Deletes the resource Mapping for a Policy identified by `policyId` and `mappingId`

Parameters:

policyId - `id` of the Policy (required)

mappingId - `id` of the policy resource Mapping (required)

Throws:

ApiException - if fails to make API call

deletePolicyResourceMapping

public void deletePolicyResourceMapping(String policyId,
 String mappingId,
 Map<String,String> additionalHeaders)
                                 throws ApiException

Delete a policy resource Mapping Deletes the resource Mapping for a Policy identified by `policyId` and `mappingId`

Parameters:

policyId - `id` of the Policy (required)

mappingId - `id` of the policy resource Mapping (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deletePolicyRule

public void deletePolicyRule(String policyId,
 String ruleId)
                      throws ApiException

Delete a Policy Rule Deletes a Policy Rule identified by `policyId` and `ruleId`

Parameters:

policyId - `id` of the Policy (required)

ruleId - `id` of the Policy Rule (required)

Throws:

ApiException - if fails to make API call

deletePolicyRule

public void deletePolicyRule(String policyId,
 String ruleId,
 Map<String,String> additionalHeaders)
                      throws ApiException

Delete a Policy Rule Deletes a Policy Rule identified by `policyId` and `ruleId`

Parameters:

policyId - `id` of the Policy (required)

ruleId - `id` of the Policy Rule (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getPolicy

public Policy getPolicy(String policyId,
 String expand)
                 throws ApiException

Retrieve a Policy Retrieves a policy

Parameters:

policyId - `id` of the Policy (required)

expand - (optional, default to )

Returns:

Policy

Throws:

ApiException - if fails to make API call

getPolicy

public Policy getPolicy(String policyId,
 String expand,
 Map<String,String> additionalHeaders)
                 throws ApiException

Retrieve a Policy Retrieves a policy

Parameters:

policyId - `id` of the Policy (required)

expand - (optional, default to )

additionalHeaders - additionalHeaders for this call

Returns:

Policy

Throws:

ApiException - if fails to make API call

getPolicyMapping

public PolicyMapping getPolicyMapping(String policyId,
 String mappingId)
                               throws ApiException

Retrieve a policy resource Mapping Retrieves a resource Mapping for a Policy identified by `policyId` and `mappingId`

Parameters:

policyId - `id` of the Policy (required)

mappingId - `id` of the policy resource Mapping (required)

Returns:

PolicyMapping

Throws:

ApiException - if fails to make API call

getPolicyMapping

public PolicyMapping getPolicyMapping(String policyId,
 String mappingId,
 Map<String,String> additionalHeaders)
                               throws ApiException

Retrieve a policy resource Mapping Retrieves a resource Mapping for a Policy identified by `policyId` and `mappingId`

Parameters:

policyId - `id` of the Policy (required)

mappingId - `id` of the policy resource Mapping (required)

additionalHeaders - additionalHeaders for this call

Returns:

PolicyMapping

Throws:

ApiException - if fails to make API call

getPolicyRule

public PolicyRule getPolicyRule(String policyId,
 String ruleId)
                         throws ApiException

Retrieve a Policy Rule Retrieves a policy rule

Parameters:

policyId - `id` of the Policy (required)

ruleId - `id` of the Policy Rule (required)

Returns:

PolicyRule

Throws:

ApiException - if fails to make API call

getPolicyRule

public PolicyRule getPolicyRule(String policyId,
 String ruleId,
 Map<String,String> additionalHeaders)
                         throws ApiException

Retrieve a Policy Rule Retrieves a policy rule

Parameters:

policyId - `id` of the Policy (required)

ruleId - `id` of the Policy Rule (required)

additionalHeaders - additionalHeaders for this call

Returns:

PolicyRule

Throws:

ApiException - if fails to make API call

listPolicies

public List<Policy> listPolicies(String type,
 String status,
 String expand)
                          throws ApiException

List all Policies Lists all policies with the specified type

Parameters:

type - (required)

status - (optional)

expand - (optional, default to )

Returns:

List<Policy>

Throws:

ApiException - if fails to make API call

listPolicies

public List<Policy> listPolicies(String type,
 String status,
 String expand,
 Map<String,String> additionalHeaders)
                          throws ApiException

List all Policies Lists all policies with the specified type

Parameters:

type - (required)

status - (optional)

expand - (optional, default to )

additionalHeaders - additionalHeaders for this call

Returns:

List<Policy>

Throws:

ApiException - if fails to make API call

listPolicyApps

@Deprecated
public List<Application> listPolicyApps(String policyId)
                                 throws ApiException

Deprecated.

List all Applications mapped to a Policy Lists all applications mapped to a policy identified by `policyId`

Parameters:

policyId - `id` of the Policy (required)

Returns:

List<Application>

Throws:

ApiException - if fails to make API call

listPolicyApps

@Deprecated
public List<Application> listPolicyApps(String policyId,
 Map<String,String> additionalHeaders)
                                 throws ApiException

Deprecated.

List all Applications mapped to a Policy Lists all applications mapped to a policy identified by `policyId`

Parameters:

policyId - `id` of the Policy (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<Application>

Throws:

ApiException - if fails to make API call

listPolicyMappings

public List<PolicyMapping> listPolicyMappings(String policyId)
                                       throws ApiException

List all resources mapped to a Policy Lists all resources mapped to a Policy identified by `policyId`

Parameters:

policyId - `id` of the Policy (required)

Returns:

List<PolicyMapping>

Throws:

ApiException - if fails to make API call

listPolicyMappings

public List<PolicyMapping> listPolicyMappings(String policyId,
 Map<String,String> additionalHeaders)
                                       throws ApiException

List all resources mapped to a Policy Lists all resources mapped to a Policy identified by `policyId`

Parameters:

policyId - `id` of the Policy (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<PolicyMapping>

Throws:

ApiException - if fails to make API call

listPolicyRules

public List<PolicyRule> listPolicyRules(String policyId)
                                 throws ApiException

List all Policy Rules Lists all policy rules

Parameters:

policyId - `id` of the Policy (required)

Returns:

List<PolicyRule>

Throws:

ApiException - if fails to make API call

listPolicyRules

public List<PolicyRule> listPolicyRules(String policyId,
 Map<String,String> additionalHeaders)
                                 throws ApiException

List all Policy Rules Lists all policy rules

Parameters:

policyId - `id` of the Policy (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<PolicyRule>

Throws:

ApiException - if fails to make API call

mapResourceToPolicy

public PolicyMapping mapResourceToPolicy(String policyId,
 PolicyMappingRequest policyMappingRequest)
                                  throws ApiException

Map a resource to a Policy Maps a resource to a Policy identified by `policyId`

Parameters:

policyId - `id` of the Policy (required)

policyMappingRequest - (required)

Returns:

PolicyMapping

Throws:

ApiException - if fails to make API call

mapResourceToPolicy

public PolicyMapping mapResourceToPolicy(String policyId,
 PolicyMappingRequest policyMappingRequest,
 Map<String,String> additionalHeaders)
                                  throws ApiException

Map a resource to a Policy Maps a resource to a Policy identified by `policyId`

Parameters:

policyId - `id` of the Policy (required)

policyMappingRequest - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PolicyMapping

Throws:

ApiException - if fails to make API call

replacePolicy

public Policy replacePolicy(String policyId,
 Policy policy)
                     throws ApiException

Replace a Policy Replaces the properties of a Policy identified by `policyId`

Parameters:

policyId - `id` of the Policy (required)

policy - (required)

Returns:

Policy

Throws:

ApiException - if fails to make API call

replacePolicy

public Policy replacePolicy(String policyId,
 Policy policy,
 Map<String,String> additionalHeaders)
                     throws ApiException

Replace a Policy Replaces the properties of a Policy identified by `policyId`

Parameters:

policyId - `id` of the Policy (required)

policy - (required)

additionalHeaders - additionalHeaders for this call

Returns:

Policy

Throws:

ApiException - if fails to make API call

replacePolicyRule

public PolicyRule replacePolicyRule(String policyId,
 String ruleId,
 PolicyRule policyRule)
                             throws ApiException

Replace a Policy Rule Replaces the properties for a Policy Rule identified by `policyId` and `ruleId`

Parameters:

policyId - `id` of the Policy (required)

ruleId - `id` of the Policy Rule (required)

policyRule - (required)

Returns:

PolicyRule

Throws:

ApiException - if fails to make API call

replacePolicyRule

public PolicyRule replacePolicyRule(String policyId,
 String ruleId,
 PolicyRule policyRule,
 Map<String,String> additionalHeaders)
                             throws ApiException

Replace a Policy Rule Replaces the properties for a Policy Rule identified by `policyId` and `ruleId`

Parameters:

policyId - `id` of the Policy (required)

ruleId - `id` of the Policy Rule (required)

policyRule - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PolicyRule

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()