The Okta Policy API enables an administrator to perform policy and policy rule operations. The policy framework is used by Okta to control rules and settings that govern many things:
Policy settings for a particular policy type, such as SIGN_ON
policy, consist of one or more policy objects, each of which contains one or more policy rules. Policies and rules contain conditions that determine whether they are applicable to a particular user at a particular time.
See:
MFA_ENROLL
ACCESS_POLICY
ENTITY_RISK
SIGN_ON
IDP_DISCOVERY
PASSWORD
POST_AUTH_SESSION
PROFILE_ENROLLMENT
When a policy needs to be retrieved for a particular user, for example when the user attempts to sign in to Okta, or when the user initiates a self-service operation, then a policy evaluation takes place. During policy evaluation each policy of the appropriate type is considered in turn, in the order indicated by the policy priority.
Each of the conditions associated with the policy is evaluated. If one or more of the conditions can't be met, then the next policy in the list is considered. If the conditions can be met, then each of the rules associated with the policy is considered in turn, in the order specified by the rule priority. Each of the conditions associated with a given rule is evaluated. If all of the conditions associated with a rule are met, then the settings contained in the rule, and in the associated policy, are applied to the user. If none of the policy rules have conditions that can be met, then the next policy in the list is considered.
Rules have a priority that govern the order that they are considered during evaluation. The highest priority rule has a priority of 1
. For example, if a particular policy had two rules:
1
and applies to LDAP API scenarios.2
and applies to ANYWHERE (network connection) scenarios.If a request came in from the LDAP endpoint, the action in rule A is taken, and rule B isn't evaluated. This occurs because even though requests coming from anywhere match the ANYWHERE location condition of rule B, rule A has higher priority and is evaluated first.
Only the default policy contains a default rule. In Identity Engine, you can't delete default rules, but can edit them, except for:
maxSessionLifetimeMinutes
and usePersistentCookie
of the default global session policy's default rule, which are read-only.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. Keep in mind the following policy-specific limitations.
The authentication policy has the following limitations:
99
. The highest priority that you can set an authentication policy rule to is 0
.The IdP discovery policy has the following limitations:
idp
policy action.AgentlessDSSO
, IWA
, X509
.idpSelectionType
is DYNAMIC
.providerExpression
if idpSelectionType
is SPECIFIC
.OKTA
provider, sign-in requests are handled by Okta exclusively.The password policy is enforced only for Okta and AD-sourced users. For AD-sourced users, ensure that your Active Directory policies don't conflict with the Okta policies.
The user profile policy has the following limitations:
email
, firstName
, or lastName
.The default rule is required and is always the last rule in the priority order. If you add rules to the default policy, they have a higher priority than the default rule. The system
object determines whether a rule is created by a system or by a user. The default rule is the only rule that has this attribute. See Configure multiple identifiers.
okta.policies.read
Lists all policies with the specified type
type required | string Specifies the type of policy to return. The following policy types are available only with the Okta Identity Engine - |
status | string Refines the query by the |
q | string Refines the query by policy name prefix (startWith method) passed in as |
expand | string Default: "" |
sortBy | string Refines the query by sorting on the policy |
limit | string Defines the number of policies returned, see Pagination |
resourceId | string Reference to the associated authorization server |
after | string End page cursor for pagination, see Pagination |
Success
Forbidden
Too Many Requests
{- "type": "PASSWORD",
- "id": "policyId",
- "status": "ACTIVE",
- "name": "Policy name",
- "description": "Policy description",
- "priority": 1,
- "system": true,
- "created": "createdDate",
- "lastUpdated": "lastUpdated",
- "conditions": {
- "people": {
- "groups": {
- "include": [
- "groupId"
]
}
}, - "authProvider": {
- "provider": "provider"
}
}, - "settings": {
- "password": {
- "complexity": {
- "minLength": 8,
- "minLowerCase": 1,
- "minUpperCase": 1,
- "minNumber": null,
- "minSymbol": 0,
- "excludeUsername": true,
- "dictionary": {
- "common": {
- "exclude": false
}
}, - "excludeAttributes": [ ]
}, - "age": {
- "maxAgeDays": 0,
- "expireWarnDays": 0,
- "minAgeMinutes": 0,
- "historyCount": 4
}, - "lockout": {
- "maxAttempts": 0,
- "autoUnlockMinutes": 0,
- "userLockoutNotificationChannels": [ ],
- "showLockoutFailures": false
}
}, - "recovery": {
- "factors": {
- "recovery_question": {
- "status": "ACTIVE",
- "properties": {
- "complexity": {
- "complexity": 4
}
}
}, - "okta_email": {
- "status": "ACTIVE",
- "properties": {
- "recoveryToken": {
- "tokenLifetimeMinutes": 10080
}
}
}, - "okta_sms": {
- "status": "INACTIVE"
}, - "okta_call": {
- "status": "INACTIVE"
}
}
}, - "delegation": {
- "options": {
- "skipUnlock": false
}
}
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT"
]
}
}, - "rules": {
- "hints": {
- "allow": [
- "POST",
- "GET"
]
}
}
}
}
okta.policies.manage
Creates a policy. There are many types of policies that you can create. See Policies for an overview of the types of policies available and links to more indepth information.
Success
Bad Request
Forbidden
Too Many Requests
{- "description": null,
- "name": "string",
- "priority": "Last / Lowest Priority, for example `1`",
- "status": "ACTIVE",
- "system": false,
- "type": "ACCESS_POLICY",
- "conditions": null,
- "_embedded": {
- "resourceType": "string",
- "property1": { },
- "property2": { }
}
}
{- "type": "PASSWORD",
- "id": "policyId",
- "status": "ACTIVE",
- "name": "Policy name",
- "description": "Policy description",
- "priority": 1,
- "system": true,
- "created": "createdDate",
- "lastUpdated": "lastUpdated",
- "conditions": {
- "people": {
- "groups": {
- "include": [
- "groupId"
]
}
}, - "authProvider": {
- "provider": "provider"
}
}, - "settings": {
- "password": {
- "complexity": {
- "minLength": 8,
- "minLowerCase": 1,
- "minUpperCase": 1,
- "minNumber": null,
- "minSymbol": 0,
- "excludeUsername": true,
- "dictionary": {
- "common": {
- "exclude": false
}
}, - "excludeAttributes": [ ]
}, - "age": {
- "maxAgeDays": 0,
- "expireWarnDays": 0,
- "minAgeMinutes": 0,
- "historyCount": 4
}, - "lockout": {
- "maxAttempts": 0,
- "autoUnlockMinutes": 0,
- "userLockoutNotificationChannels": [ ],
- "showLockoutFailures": false
}
}, - "recovery": {
- "factors": {
- "recovery_question": {
- "status": "ACTIVE",
- "properties": {
- "complexity": {
- "complexity": 4
}
}
}, - "okta_email": {
- "status": "ACTIVE",
- "properties": {
- "recoveryToken": {
- "tokenLifetimeMinutes": 10080
}
}
}, - "okta_sms": {
- "status": "INACTIVE"
}, - "okta_call": {
- "status": "INACTIVE"
}
}
}, - "delegation": {
- "options": {
- "skipUnlock": false
}
}
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT"
]
}
}, - "rules": {
- "hints": {
- "allow": [
- "POST",
- "GET"
]
}
}
}
}
okta.policies.read
Creates a policy or policy rule simulation. The access simulation evaluates policy and policy rules based on the existing policy rule configuration. The evaluation result simulates what the real-world authentication flow is and what policy rules have been applied or matched to the authentication flow.
Success
Forbidden
Not Found
Too Many Requests
{- "policyType": [
- "OKTA_SIGN_ON",
- "MFA_ENROLL"
], - "appInstance": "0oa4eroj3nYCIJIW70g7",
- "policyContext": {
- "groups": {
- "ids": [
- "00g4eralvekR5RLuS0g7",
- "00g4eralvekR5RLuS0g8"
]
}, - "risk": {
- "level": "LOW"
}, - "zones": {
- "ids": [
- "nzo4eralxcRnbIHYJ0g7"
]
}, - "device": {
- "platform": "IOS",
- "registered": true,
- "managed": true
}
}
}
{- "evaluation": [
- {
- "status": null,
- "policyType": "OKTA_SIGN_ON",
- "result": {
- "policies": [
- {
- "id": "00p4eromwukk6qUku0g7",
- "name": "test policy",
- "status": "MATCH",
- "conditions": [ ],
- "rules": [
- {
- "id": "0pr4erof85nGcyC7Y0g7",
- "name": "test rule",
- "status": "MATCH",
- "conditions": [
- {
- "type": "people.groups.include",
- "status": "MATCH"
}
]
}
]
}
]
}, - "undefined": {
- "policies": [ ]
}, - "evaluated": {
- "policies": [ ]
}
}, - {
- "status": null,
- "policyType": "MFA_ENROLL",
- "result": {
- "policies": [
- {
- "id": "00p4eram2kw1aLcrx0g7",
- "name": "Default Policy",
- "status": "MATCH",
- "conditions": [ ],
- "rules": [
- {
- "id": "0pr4eram2lMQT5FZF0g7",
- "name": null,
- "status": "MATCH",
- "conditions": [ ]
}
]
}
]
}, - "undefined": {
- "policies": [ ]
}, - "evaluated": {
- "policies": [ ]
}
}, - {
- "status": null,
- "policyType": "ACCESS_POLICY",
- "result": {
- "policies": [
- {
- "id": "rst4eram06ZKZewEe0g7",
- "name": "Any two factors",
- "status": "MATCH",
- "conditions": [ ],
- "rules": [
- {
- "id": "rul4eram07VsWgybo0g7",
- "name": "Catch-all rule",
- "status": "MATCH",
- "conditions": [ ]
}
]
}
]
}, - "undefined": {
- "policies": [ ]
}, - "evaluated": {
- "policies": [ ]
}
}, - {
- "status": null,
- "policyType": "PROFILE_ENROLLMENT",
- "result": {
- "policies": [
- {
- "id": "rst4eram08ZSjPTOl0g7",
- "name": "Default Policy",
- "status": "MATCH",
- "conditions": [ ],
- "rules": [
- {
- "id": "rul4eram094PrQ2BX0g7",
- "name": "Catch-all rule",
- "status": "MATCH",
- "conditions": [ ]
}
]
}
]
}, - "undefined": {
- "policies": [ ]
}, - "evaluated": {
- "policies": [ ]
}
}
]
}
okta.policies.read
Retrieves a policy
Success
Forbidden
Not Found
Too Many Requests
{- "type": "PASSWORD",
- "id": "policyId",
- "status": "ACTIVE",
- "name": "Policy name",
- "description": "Policy description",
- "priority": 1,
- "system": true,
- "created": "createdDate",
- "lastUpdated": "lastUpdated",
- "conditions": {
- "people": {
- "groups": {
- "include": [
- "groupId"
]
}
}, - "authProvider": {
- "provider": "provider"
}
}, - "settings": {
- "password": {
- "complexity": {
- "minLength": 8,
- "minLowerCase": 1,
- "minUpperCase": 1,
- "minNumber": null,
- "minSymbol": 0,
- "excludeUsername": true,
- "dictionary": {
- "common": {
- "exclude": false
}
}, - "excludeAttributes": [ ]
}, - "age": {
- "maxAgeDays": 0,
- "expireWarnDays": 0,
- "minAgeMinutes": 0,
- "historyCount": 4
}, - "lockout": {
- "maxAttempts": 0,
- "autoUnlockMinutes": 0,
- "userLockoutNotificationChannels": [ ],
- "showLockoutFailures": false
}
}, - "recovery": {
- "factors": {
- "recovery_question": {
- "status": "ACTIVE",
- "properties": {
- "complexity": {
- "complexity": 4
}
}
}, - "okta_email": {
- "status": "ACTIVE",
- "properties": {
- "recoveryToken": {
- "tokenLifetimeMinutes": 10080
}
}
}, - "okta_sms": {
- "status": "INACTIVE"
}, - "okta_call": {
- "status": "INACTIVE"
}
}
}, - "delegation": {
- "options": {
- "skipUnlock": false
}
}
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT"
]
}
}, - "rules": {
- "hints": {
- "allow": [
- "POST",
- "GET"
]
}
}
}
}
okta.policies.manage
Replaces the properties of a policy identified by policyId
name required | string Name of the policy |
type required | string (PolicyType) All Okta orgs contain only one IdP Discovery policy with an immutable default rule routing to your org's sign-in page, one Entity Risk policy, and one Post Auth Session policy.
Creating or replacing a policy with the |
description | string Default: null Description of the policy |
priority | integer Default: "Last / Lowest Priority, for example `1`" Specifies the order in which this policy is evaluated in relation to the other policies |
status | string Whether or not the policy is active. Use the |
system | boolean Default: false Specifies whether Okta created the policy |
conditions | string or null Default: null Policy conditions aren't supported. Conditions are applied at the rule level for this policy type. |
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "description": null,
- "name": "string",
- "priority": "Last / Lowest Priority, for example `1`",
- "status": "ACTIVE",
- "system": false,
- "type": "ACCESS_POLICY",
- "conditions": null,
- "_embedded": {
- "resourceType": "string",
- "property1": { },
- "property2": { }
}
}
{- "type": "PASSWORD",
- "id": "policyId",
- "status": "ACTIVE",
- "name": "Policy name",
- "description": "Policy description",
- "priority": 1,
- "system": true,
- "created": "createdDate",
- "lastUpdated": "lastUpdated",
- "conditions": {
- "people": {
- "groups": {
- "include": [
- "groupId"
]
}
}, - "authProvider": {
- "provider": "provider"
}
}, - "settings": {
- "password": {
- "complexity": {
- "minLength": 8,
- "minLowerCase": 1,
- "minUpperCase": 1,
- "minNumber": null,
- "minSymbol": 0,
- "excludeUsername": true,
- "dictionary": {
- "common": {
- "exclude": false
}
}, - "excludeAttributes": [ ]
}, - "age": {
- "maxAgeDays": 0,
- "expireWarnDays": 0,
- "minAgeMinutes": 0,
- "historyCount": 4
}, - "lockout": {
- "maxAttempts": 0,
- "autoUnlockMinutes": 0,
- "userLockoutNotificationChannels": [ ],
- "showLockoutFailures": false
}
}, - "recovery": {
- "factors": {
- "recovery_question": {
- "status": "ACTIVE",
- "properties": {
- "complexity": {
- "complexity": 4
}
}
}, - "okta_email": {
- "status": "ACTIVE",
- "properties": {
- "recoveryToken": {
- "tokenLifetimeMinutes": 10080
}
}
}, - "okta_sms": {
- "status": "INACTIVE"
}, - "okta_call": {
- "status": "INACTIVE"
}
}
}, - "delegation": {
- "options": {
- "skipUnlock": false
}
}
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT"
]
}
}, - "rules": {
- "hints": {
- "allow": [
- "POST",
- "GET"
]
}
}
}
}
okta.policies.manage
Deletes a policy
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.policies.read
Lists all applications mapped to a policy identified by policyId
Note: Use List all resources mapped to a Policy to list all applications mapped to a policy.
Success
Forbidden
Not Found
Too Many Requests
[- {
- "accessibility": {
- "errorRedirectUrl": "string",
- "loginRedirectUrl": "string",
- "selfService": true
}, - "created": "2019-08-24T14:15:22Z",
- "features": [
- "GROUP_PUSH"
], - "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "licensing": {
- "seatCount": 0
}, - "orn": "string",
- "profile": { },
- "signOnMode": "AUTO_LOGIN",
- "status": "ACTIVE",
- "visibility": {
- "appLinks": {
- "property1": true,
- "property2": true
}, - "autoLaunch": true,
- "autoSubmitToolbar": true,
- "hide": {
- "iOS": false,
- "web": true
}
}, - "_embedded": {
- "user": {
- "property1": { },
- "property2": { }
}
}, - "_links": {
- "accessPolicy": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}, - "activate": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}, - "appLinks": [
- {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}
], - "deactivate": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}, - "groups": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}, - "help": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}, - "logo": [
- {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}
], - "metadata": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}, - "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}, - "users": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}
}
}
]
okta.policies.manage
Clones an existing policy
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "type": "PASSWORD",
- "id": "policyId",
- "status": "ACTIVE",
- "name": "Policy name",
- "description": "Policy description",
- "priority": 1,
- "system": true,
- "created": "createdDate",
- "lastUpdated": "lastUpdated",
- "conditions": {
- "people": {
- "groups": {
- "include": [
- "groupId"
]
}
}, - "authProvider": {
- "provider": "provider"
}
}, - "settings": {
- "password": {
- "complexity": {
- "minLength": 8,
- "minLowerCase": 1,
- "minUpperCase": 1,
- "minNumber": null,
- "minSymbol": 0,
- "excludeUsername": true,
- "dictionary": {
- "common": {
- "exclude": false
}
}, - "excludeAttributes": [ ]
}, - "age": {
- "maxAgeDays": 0,
- "expireWarnDays": 0,
- "minAgeMinutes": 0,
- "historyCount": 4
}, - "lockout": {
- "maxAttempts": 0,
- "autoUnlockMinutes": 0,
- "userLockoutNotificationChannels": [ ],
- "showLockoutFailures": false
}
}, - "recovery": {
- "factors": {
- "recovery_question": {
- "status": "ACTIVE",
- "properties": {
- "complexity": {
- "complexity": 4
}
}
}, - "okta_email": {
- "status": "ACTIVE",
- "properties": {
- "recoveryToken": {
- "tokenLifetimeMinutes": 10080
}
}
}, - "okta_sms": {
- "status": "INACTIVE"
}, - "okta_call": {
- "status": "INACTIVE"
}
}
}, - "delegation": {
- "options": {
- "skipUnlock": false
}
}
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT"
]
}
}, - "rules": {
- "hints": {
- "allow": [
- "POST",
- "GET"
]
}
}
}
}
okta.policies.manage
Activates a policy
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.policies.manage
Deactivates a policy
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.policies.read
Lists all resources mapped to a policy identified by policyId
Success
Forbidden
Not Found
Too Many Requests
[- {
- "id": "policyId",
- "_links": {
- "application": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "policy": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}
}
}
]
okta.policies.manage
Maps a resource to a policy identified by policyId
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "resourceId": "string",
- "resourceType": "APP"
}
{- "id": "policyId",
- "_links": {
- "application": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "policy": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}
}
}
okta.policies.read
Retrieves a resource mapping for a policy identified by policyId
and mappingId
Success
Forbidden
Not Found
Too Many Requests
{- "id": "policyId",
- "_links": {
- "application": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "policy": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}
}
}
okta.policies.manage
Deletes the resource mapping for a policy identified by policyId
and mappingId
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.policies.read
Lists all policy rules
limit | string Defines the number of policy rules returned. See Pagination. |
Success
Forbidden
Not Found
Too Many Requests
[- {
- "id": "0prh1sd28q5sXGW08697",
- "status": "ACTIVE",
- "name": "Test rule",
- "priority": 0,
- "created": "2024-04-25T17:35:02.000Z",
- "lastUpdated": "2024-04-25T17:35:02.000Z",
- "system": false,
- "conditions": {
- "people": {
- "users": {
- "exclude": [ ]
}
}, - "network": {
- "connection": "ANYWHERE"
}, - "risk": {
- "behaviors": [ ]
}, - "riskScore": {
- "level": "ANY"
}, - "identityProvider": {
- "provider": "ANY"
}
}, - "actions": {
- "signon": {
- "requireFactor": false,
- "factorPromptMode": "ALWAYS",
- "factorLifetime": 15,
- "access": "ALLOW",
- "primaryFactor": "PASSWORD_IDP_ANY_FACTOR",
- "session": {
- "maxSessionIdleMinutes": 720,
- "maxSessionLifetimeMinutes": 0,
- "usePersistentCookie": false
}
}
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "deactivate": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}, - "type": "SIGN_ON"
}
]
okta.policies.manage
Creates a policy rule
Note: You can't create additional rules for the
PROFILE_ENROLLMENT
orPOST_AUTH_SESSION
policies.
limit | string Defines the number of policy rules returned. See Pagination. |
activate | boolean Default: true Set this parameter to |
name | string Name of the rule | ||||||||||||||||||||||||||||||||||||||||||
priority | integer or null Priority of the rule | ||||||||||||||||||||||||||||||||||||||||||
status | string Whether or not the rule is active. Use the | ||||||||||||||||||||||||||||||||||||||||||
system | boolean Default: false Specifies whether Okta created the policy rule ( | ||||||||||||||||||||||||||||||||||||||||||
type | string (PolicyRuleType) Rule type | ||||||||||||||||||||||||||||||||||||||||||
object (AccessPolicyRuleActions) Specifies actions to be taken, or operations that may be allowed, if the rule conditions are satisfied. | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
object (AccessPolicyRuleConditions) Specifies conditions that must be met during policy evaluation to apply the rule. All policy conditions, as well as conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule. | |||||||||||||||||||||||||||||||||||||||||||
|
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "name": "SSPR Rule",
- "priority": 1,
- "status": "ACTIVE",
- "conditions": {
- "people": {
- "users": {
- "exclude": [ ]
}
}, - "network": {
- "connection": "ANYWHERE"
}
}, - "actions": {
- "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW",
- "requirement": {
- "primary": {
- "methods": [
- "push",
- "sms"
]
}, - "stepUp": {
- "required": true,
- "methods": [
- "security_question"
]
}
}
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}
}, - "system": false,
- "type": "PASSWORD"
}
{- "id": "ruleId",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "deactivate": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}, - "name": "SSPR Rule",
- "priority": 1,
- "status": "ACTIVE",
- "conditions": {
- "people": {
- "users": {
- "exclude": [ ]
}
}, - "network": {
- "connection": "ANYWHERE"
}
}, - "actions": {
- "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW",
- "requirement": {
- "primary": {
- "methods": [
- "push",
- "sms"
]
}, - "stepUp": {
- "required": true,
- "methods": [
- "security_question"
]
}
}
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}
}, - "system": false,
- "type": "PASSWORD"
}
okta.policies.read
Retrieves a policy rule
Success
Forbidden
Not Found
Too Many Requests
{- "id": "ruleId",
- "name": "SSPR Rule",
- "priority": 1,
- "status": "ACTIVE",
- "conditions": {
- "people": {
- "users": {
- "exclude": [ ]
}
}, - "network": {
- "connection": "ANYWHERE"
}
}, - "actions": {
- "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW",
- "requirement": {
- "primary": {
- "methods": [
- "push",
- "sms"
]
}, - "stepUp": {
- "required": true,
- "methods": [
- "security_question"
]
}
}
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}
}, - "system": false,
- "type": "PASSWORD"
}
okta.policies.manage
Replaces the properties for a policy rule identified by policyId
and ruleId
name | string Name of the rule | ||||||||||||||||||||||||||||||||||||||||||
priority | integer or null Priority of the rule | ||||||||||||||||||||||||||||||||||||||||||
status | string Whether or not the rule is active. Use the | ||||||||||||||||||||||||||||||||||||||||||
system | boolean Default: false Specifies whether Okta created the policy rule ( | ||||||||||||||||||||||||||||||||||||||||||
type | string (PolicyRuleType) Rule type | ||||||||||||||||||||||||||||||||||||||||||
object (AccessPolicyRuleActions) Specifies actions to be taken, or operations that may be allowed, if the rule conditions are satisfied. | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
object (AccessPolicyRuleConditions) Specifies conditions that must be met during policy evaluation to apply the rule. All policy conditions, as well as conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule. | |||||||||||||||||||||||||||||||||||||||||||
|
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "id": "ruleId",
- "name": "SSPR Rule",
- "priority": 1,
- "status": "ACTIVE",
- "conditions": {
- "people": {
- "users": {
- "exclude": [ ]
}
}, - "network": {
- "connection": "ANYWHERE"
}
}, - "actions": {
- "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW",
- "requirement": {
- "primary": {
- "methods": [
- "push",
- "sms"
]
}, - "stepUp": {
- "required": true,
- "methods": [
- "security_question"
]
}
}
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}
}, - "system": false,
- "type": "PASSWORD"
}
{- "id": "ruleId",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "PUT",
- "DELETE"
]
}
}, - "deactivate": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}, - "name": "SSPR Rule",
- "priority": 1,
- "status": "ACTIVE",
- "conditions": {
- "people": {
- "users": {
- "exclude": [ ]
}
}, - "network": {
- "connection": "ANYWHERE"
}
}, - "actions": {
- "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW",
- "requirement": {
- "primary": {
- "methods": [
- "push",
- "sms"
]
}, - "stepUp": {
- "required": true,
- "methods": [
- "security_question"
]
}
}
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}
}, - "system": false,
- "type": "PASSWORD"
}
okta.policies.manage
Deletes a policy rule identified by policyId
and ruleId
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.policies.manage
Activates a policy rule identified by policyId
and ruleId
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.policies.manage
Deactivates a policy rule identified by policyId
and ruleId
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}