Policies
Policies.
Table Specific Information
Required Scopes
To query this table, Scope must include okta.policies.read. To edit this table, it must include okta.policies.manage.
Select
The driver uses the Okta API to process WHERE clause conditions built with the following columns and operators.Note that the LIKE operator is case-sensitive.
- Id supports the '=' operator
- Name supports the '=' and 'LIKE (starts with)' operators
- Type supports the '=' operator
All other filters are processed client-side within the driver.
For example, the following queries are processed server-side:
SELECT * FROM Policies WHERE Id = '00plrilJ7jZ66Gn0X0g3' SELECT * FROM Policies WHERE Type='PASSWORD' and name like 'Default%'
The Type filter only accepts certain values. Possible values for this filter are "OKTA_SIGN_ON" "PASSWORD" "MFA_ENROLL" "IDP_DISCOVERY" "ACCESS_POLICY" "PROFILE_ENROLLMENT" "POST_AUTH_SESSION" "ENTITY_RISK". Note that the policies ACCESS_POLICY, PROFILE_ENROLLMENT, POST_AUTH_SESSION, and ENTITY_RISK are only available in Okta Identity Engine. Note that POST_AUTH_SESSION and ENTITY_RISK are currently in early access and must be enabled in Okta before they can be queried. For this reason, they are not automatically queried and must be specified in the Type filter in order to be queried.
Note: Due to a limitation of the Okta API that affects queries to the Policies endpoint, we only support full-table queries or filters on individual Types or Ids.
Insert
At minimum the Name and Type are required to insert into this table. Note that creating a policy with the IDP_DISCOVERY, ENTITY_RISK, or POST_AUTH_SESSION types isn't supported.A sample Insert is given below.
INSERT INTO Policies (Name, Type) VALUES ('newPolicy', 'ACCESS_POLICY')
Update
Note that updating a policy with the IDP_DISCOVERY, ENTITY_RISK, or POST_AUTH_SESSION types isn't supported.A sample Update is given below.
UPDATE Policies SET Description = 'foo' WHERE id = 'rstmbdpgvyIX4BBwZ5d7'
Delete
A sample Delete is given below.DELETE FROM Policies WHERE Id = 'rstmbdpgvyIX4BBwZ5d7'
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
Id of the policy |
Created | Datetime | True |
When the policy was created |
LastUpdated | Datetime | True |
When the policy was last updated |
Name | String | False |
Name of the policy |
Type | String | False |
Type of policy. |
System | Boolean | False |
If this is a system policy |
Description | String | False |
Description of the policy |
Priority | Integer | False |
Priority of the policy |
Status | String | False |
Status of the policy |