PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}

Replaces the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy

Servers

Path parameters

Name Type Required Description
ruleId String Yes

id of the Policy Rule

policyId String Yes

id of the Policy

authServerId String Yes

id of the Authorization Server

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
id String No

Identifier of the rule

priority Integer No

Priority of the rule

created String No

Timestamp when the rule was created

name String No

Name of the rule

system Boolean No

Set to true for system rules. You can't delete system rules.

conditions Object No
conditions.scopes Object No

Array of scopes that the condition includes

conditions.scopes.include[] Array No
conditions.people Object No

Identifies Users and Groups that are used together

conditions.people.groups Object No

Specifies a set of Groups whose Users are to be included

conditions.people.groups.include[] Array No

Groups to be included

conditions.people.users Object No

Specifies a set of Users to be included

conditions.people.users.include[] Array No

Users to be included

conditions.grantTypes Object No

Array of grant types that this condition includes. Determines the mechanism that Okta uses to authorize the creation of the tokens.

conditions.grantTypes.include[] Array No

Array of grant types that this condition includes.

type String No

Rule type

Possible values:

  • "RESOURCE_ACCESS"
status String No

Status of the rule

Possible values:

  • "ACTIVE"
  • "INACTIVE"
lastUpdated String No

Timestamp when the rule was last modified

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.