PUT /api/v1/policies/{policyId}

Replaces the properties of a Policy identified by policyId

Servers

Path parameters

Name Type Required Description
policyId String Yes

id of the Policy

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 Policy

Default value: "Assigned"

_links Object No
priority Integer No

Specifies the order in which this Policy is evaluated in relation to the other policies

_embedded Object No
created String No

Timestamp when the Policy was created

name String Yes

Name of the Policy

description String No

Description of the Policy

system Boolean No

Specifies whether Okta created the Policy

Default value: false

type String Yes

All Okta orgs contain only one IdP Discovery Policy with an immutable default Rule routing to your org's sign-in page. Creating or replacing a policy with the IDP_DISCOVERY type isn't supported. The following policy types are available with Identity Engine: ACCESS_POLICY, PROFILE_ENROLLMENT, POST_AUTH_SESSION, and ENTITY_RISK. The POST_AUTH_SESSION, and ENTITY_RISK policy types are in . Contact your Okta account team to enable these features.

Possible values:

  • "PASSWORD"
  • "ACCESS_POLICY"
  • "MFA_ENROLL"
  • "PROFILE_ENROLLMENT"
  • "IDP_DISCOVERY"
  • "OKTA_SIGN_ON"
  • "ENTITY_RISK"
  • "RESOURCE_ACCESS"
  • "POST_AUTH_SESSION"
status String No

Possible values:

  • "ACTIVE"
  • "INACTIVE"
lastUpdated String No

Timestamp when the Policy 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.