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, among other things, user session lifetime, whether multi-factor authentication is required when logging in, what MFA factors may be employed, password complexity requirements, what types of self-service operations are permitted under various circumstances, and what identity provider to route users to.
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.
okta.policies.read
Lists all policies with the specified type
Success
Forbidden
Too Many Requests
[- {
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.policies.manage
Creates a policy
Success
Bad Request
Forbidden
Too Many Requests
{- "description": "string",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "conditions": {
- "app": {
- "exclude": [
- {
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}
}
{- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}
}
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.
appInstance required | string The application instance ID for a simulate operation | ||||||||||||
object (PolicyContext) | |||||||||||||
| |||||||||||||
policyTypes | Array of strings (PolicyType) Supported policy types for a simulate operation. The default value, |
Success
Forbidden
Not Found
Too Many Requests
Simulate policy request body
{- "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
}
}
Simulate policy response body
{- "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": null
}, - "evaluated": {
- "policies": null
}
}, - {
- "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": null
}, - "evaluated": {
- "policies": null
}
}, - {
- "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": null
}, - "evaluated": {
- "policies": null
}
}
]
}
okta.policies.read
Retrieves a policy
Success
Forbidden
Not Found
Too Many Requests
{- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}
}
okta.policies.manage
Replaces the properties of a Policy identified by policyId
description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string (LifecycleStatus) Enum: "ACTIVE" "INACTIVE" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
system | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string (PolicyType) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PolicyRuleConditions) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "description": "string",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "conditions": {
- "app": {
- "exclude": [
- {
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}
}
{- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}
}
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": [
- "string"
], - "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "licensing": {
- "seatCount": 0
}, - "profile": {
- "property1": { },
- "property2": { }
}, - "signOnMode": "AUTO_LOGIN",
- "status": "ACTIVE",
- "visibility": {
- "appLinks": {
- "property1": true,
- "property2": true
}, - "autoLaunch": true,
- "autoSubmitToolbar": true,
- "hide": {
- "iOS": true,
- "web": true
}
}, - "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "accessPolicy": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "activate": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "deactivate": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "groups": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "logo": [
- {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
], - "metadata": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "users": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.policies.manage
Clones an existing policy
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}
}
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": "string",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "application": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
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": "string",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "application": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.policies.read
Retrieves a resource Mapping for a Policy identified by policyId
and mappingId
Success
Forbidden
Not Found
Too Many Requests
{- "id": "string",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "application": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
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
Success
Forbidden
Not Found
Too Many Requests
[- {
- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "ACCESS_POLICY"
}
]
okta.policies.manage
Creates a policy rule
id | string | ||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||
priority | integer | ||||||||||||||||||||||||||
status | string (LifecycleStatus) Enum: "ACTIVE" "INACTIVE" | ||||||||||||||||||||||||||
system | boolean Default: false | ||||||||||||||||||||||||||
type | string (PolicyRuleType) | ||||||||||||||||||||||||||
object (AccessPolicyRuleActions) | |||||||||||||||||||||||||||
object (AccessPolicyRuleConditions) | |||||||||||||||||||||||||||
|