PUT /zones/{zone_id}/access/apps/{app_id}/policies/{policy_id}
Update a configured Access policy.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
policy_id |
String | Yes | |
app_id |
String | Yes | |
zone_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
purpose_justification_required |
Boolean | No |
Require users to enter a justification when they log in to the application. Default value: false |
name |
String | Yes |
The name of the Access policy. |
include[] |
Array | Yes |
Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules. |
require[] |
Array | No |
Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules. |
purpose_justification_prompt |
String | No |
A custom message that will appear on the purpose justification screen. |
decision |
String | Yes |
The action Access will take if a user matches this policy. Possible values:
|
precedence |
Integer | No |
The order of execution for this policy. Must be unique for each policy. |
approval_required |
Boolean | No |
Requires the user to request access from an administrator at the start of each session. Default value: false |
approval_groups[] |
Array | No |
Administrators who can approve a temporary authentication request. |
approval_groups[].email_list_uuid |
String | No |
The UUID of an re-usable email list. |
approval_groups[].approvals_needed |
Number | Yes |
The number of approvals needed to obtain access. |
approval_groups[].email_addresses[] |
Array | No |
A list of emails that can approve the access request. |
isolation_required |
Boolean | No |
Require this application to be served in an isolated browser for users matching this policy. Default value: false |
exclude[] |
Array | No |
Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules. |
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.