GET /api/v1/policies

Lists all policies with the specified type

Servers

Query parameters

Name Type Required Description
limit String No

Defines the number of policies returned, see Pagination

sortBy String No

Refines the query by sorting on the policy name in ascending order

resourceId String No

Reference to the associated authorization server

q String No

Refines the query by policy name prefix (startWith method) passed in as q=string

after String No

End page cursor for pagination, see Pagination

expand String No
type String Yes

Specifies the type of policy to return. The following policy types are available only with the Okta 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"
  • "MFA_ENROLL"
  • "ACCESS_POLICY"
  • "PROFILE_ENROLLMENT"
  • "IDP_DISCOVERY"
  • "OKTA_SIGN_ON"
  • "ENTITY_RISK"
  • "POST_AUTH_SESSION"
status String No

Refines the query by the status of the policy - ACTIVE or INACTIVE

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.