POST /api/v1/policies/simulate

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.

Servers

https://{yourOktaDomain}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name	Type	Required	Description
`expand`	String	No	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 wasn't matched.

Request body fields

Name	Type	Required	Description
`[]`	Array	Yes
`[].policyTypes[]`	Array	No	Supported policy types for a simulate operation. The default value, `null`, returns all types.
`[].appInstance`	String	Yes	The application instance ID for a simulate operation
`[].policyContext`	Object	No
`[].policyContext.device`	Object	No
`[].policyContext.device.platform`	String	No	The platform of the device, for example, IOS.
`[].policyContext.device.assuranceId`	String	No	The device assurance policy ID for the simulation
`[].policyContext.device.registered`	Boolean	No	If the device is registered
`[].policyContext.device.managed`	Boolean	No	If the device is managed
`[].policyContext.risk`	Object	No	The risk rule condition level
`[].policyContext.risk.level`	String	No	Possible values: `"LOW"` `"HIGH"` `"MEDIUM"`
`[].policyContext.groups`	Object	Yes	An array of Group IDs for the simulate operation. Only user IDs or Group IDs are allowed, not both.
`[].policyContext.groups.ids[]`	Array	Yes
`[].policyContext.user`	Object	Yes	The user ID for the simulate operation. Only user IDs or Group IDs are allowed, not both.
`[].policyContext.user.id`	String	Yes	The unique ID number for the user.
`[].policyContext.zones`	Object	No	The zone ID under the network rule condition.
`[].policyContext.zones.ids[]`	Array	No
`[].policyContext.ip`	String	No	The network rule condition, zone, or IP address

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.