<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content
How to Query Sign-On, Global Session, and Authentication Policies with API Calls
Administration
Okta Classic Engine
Okta Identity Engine
Overview

This article provides a quick reference on how to query:

  • Sign-on policies (Okta Classic)
  • Global Session Policies (Okta Identity Engine)
  • Authentication Policies (Okta Identity Engine) with API calls

This helps obtain details such as PolicyID, Rule names, and configuration details for reference or further action.

Applies To
  • API
Solution

Full details may be referenced in the Policy API documentation. When querying policies with the API, the policy type must be input. Different Policy types control settings for different operations. All Policy types share a common framework, message structure, and API but have different Policy settings and Rule data. The data structures specific to each Policy type are discussed in the Policy Type link above.


The policy type for Sign-on policies in Okta Classic is the same one used for Global Session Policy in Okta Identity Engine(OIE):

  • OKTA_SIGN_ON

 

For Authentication Policies (OIE Only), the type is:

  • ACCESS_POLICY

 

Syntax:

  • For Sign-on or Global Session Policies:
    • GET {{url}}/api/v1/policies?type=OKTA_SIGN_ON
  • For Authentication Policies:
    • GET {{url}}/api/v1/policies?type=ACCESS_POLICY

 

Example (Postman):

Sign On Query in Postman

Related References

Loading
How to Query Sign-On, Global Session, and Authentication Policies with API Calls