PlatformConditionEvaluatorPlatformOperatingSystemVersion
{
"type": "object",
"properties": {
"value": {
"type": "string"
},
"matchType": {
"enum": [
"EXPRESSION",
"SEMVER"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
PlatformPolicyRuleCondition
{
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlatformConditionEvaluatorPlatform"
}
},
"include": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlatformConditionEvaluatorPlatform"
}
}
},
"x-okta-tags": [
"Policy"
]
}
Policy
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/PolicyType"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"system": {
"type": "boolean"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"priority": {
"type": "integer"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"conditions": {
"$ref": "#/components/schemas/PolicyRuleConditions"
},
"description": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "getPolicy"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "policyId"
},
{
"dest": "policy",
"self": true
}
],
"operationId": "updatePolicy"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "deletePolicy"
}
],
"x-okta-tags": [
"Policy"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "activatePolicy"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "deactivatePolicy"
},
{
"alias": "listPolicyRules",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "listPolicyRules"
},
{
"alias": "createRule",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "createPolicyRule"
},
{
"alias": "getPolicyRule",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "getPolicyRule"
}
],
"x-openapi-v3-discriminator": {
"mapping": {
"PASSWORD": "#/definitions/PasswordPolicy",
"MFA_ENROLL": "#/definitions/MultifactorEnrollmentPolicy",
"OKTA_SIGN_ON": "#/definitions/OktaSignOnPolicy",
"ACCESS_POLICY": "#/definitions/AccessPolicy",
"IDP_DISCOVERY": "#/definitions/IdentityProviderPolicy",
"PROFILE_ENROLLMENT": "#/definitions/ProfileEnrollmentPolicy",
"OAUTH_AUTHORIZATION_POLICY": "#/definitions/OAuthAuthorizationPolicy"
},
"propertyName": "type"
}
}
PolicyAccountLink
{
"type": "object",
"properties": {
"action": {
"enum": [
"AUTO",
"DISABLED"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/PolicyAccountLinkFilter"
}
},
"x-okta-tags": [
"Policy"
]
}
PolicyAccountLinkFilter
{
"type": "object",
"properties": {
"groups": {
"$ref": "#/components/schemas/PolicyAccountLinkFilterGroups"
}
},
"x-okta-tags": [
"Policy"
]
}
PolicyAccountLinkFilterGroups
{
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
PolicyEnumerateRulesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyRule"
}
}
PolicyGetAllWithTypeResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Policy"
}
}
PolicyNetworkCondition
{
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
},
"connection": {
"enum": [
"ANYWHERE",
"ZONE"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
PolicyPeopleCondition
{
"type": "object",
"properties": {
"users": {
"$ref": "#/components/schemas/UserCondition"
},
"groups": {
"$ref": "#/components/schemas/GroupCondition"
}
},
"x-okta-tags": [
"Policy"
]
}
PolicyRule
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"enum": [
"SIGN_ON",
"PASSWORD"
],
"type": "string"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"default": "ACTIVE"
},
"system": {
"type": "boolean",
"default": false
},
"actions": {
"$ref": "#/components/schemas/PolicyRuleActions"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"priority": {
"type": "integer"
},
"conditions": {
"$ref": "#/components/schemas/PolicyRuleConditions"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyRule",
"self": true
},
{
"dest": "policyId",
"parentSrc": "id"
}
],
"operationId": "updatePolicyRule"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyId",
"parentSrc": "policyId"
}
],
"operationId": "deletePolicyRule"
}
],
"x-okta-tags": [
"Policy"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyId",
"parentSrc": "policyId"
}
],
"operationId": "activatePolicyRule"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyId",
"parentSrc": "policyId"
}
],
"operationId": "deactivatePolicyRule"
}
],
"x-openapi-v3-discriminator": {
"mapping": {
"SIGN_ON": "#/definitions/OktaSignOnPolicyRule",
"PASSWORD": "#/definitions/PasswordPolicyRule",
"ACCESS_POLICY": "#/definitions/AccessPolicyRule",
"PROFILE_ENROLLMENT": "#/definitions/ProfileEnrollmentPolicyRule"
},
"propertyName": "type"
}
}
PolicyRuleActions
{
"type": "object",
"properties": {
"idp": {
"$ref": "#/components/schemas/IdpPolicyRuleAction"
},
"enroll": {
"$ref": "#/components/schemas/PolicyRuleActionsEnroll"
},
"signon": {
"$ref": "#/components/schemas/OktaSignOnPolicyRuleSignonActions"
},
"passwordChange": {
"$ref": "#/components/schemas/PasswordPolicyRuleAction"
},
"selfServiceUnlock": {
"$ref": "#/components/schemas/PasswordPolicyRuleAction"
},
"selfServicePasswordReset": {
"$ref": "#/components/schemas/PasswordPolicyRuleAction"
}
},
"x-okta-tags": [
"Policy"
]
}
PolicyRuleActionsEnroll
{
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/PolicyRuleActionsEnrollSelf"
}
},
"x-okta-tags": [
"Policy"
]
}
PolicyRuleActionsEnrollSelf
{
"enum": [
"CHALLENGE",
"LOGIN",
"NEVER"
],
"type": "string",
"x-okta-tags": [
"Policy"
]
}
PolicyRuleAuthContextCondition
{
"type": "object",
"properties": {
"authType": {
"enum": [
"ANY",
"RADIUS"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
PolicyRuleConditions
{
"type": "object",
"properties": {
"app": {
"$ref": "#/components/schemas/AppAndInstancePolicyRuleCondition"
},
"apps": {
"$ref": "#/components/schemas/AppInstancePolicyRuleCondition"
},
"risk": {
"$ref": "#/components/schemas/RiskPolicyRuleCondition"
},
"users": {
"$ref": "#/components/schemas/UserPolicyRuleCondition"
},
"device": {
"$ref": "#/components/schemas/DevicePolicyRuleCondition"
},
"groups": {
"$ref": "#/components/schemas/GroupPolicyRuleCondition"
},
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
},
"scopes": {
"$ref": "#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition"
},
"clients": {
"$ref": "#/components/schemas/ClientPolicyCondition"
},
"context": {
"$ref": "#/components/schemas/ContextPolicyRuleCondition"
},
"network": {
"$ref": "#/components/schemas/PolicyNetworkCondition"
},
"platform": {
"$ref": "#/components/schemas/PlatformPolicyRuleCondition"
},
"riskScore": {
"$ref": "#/components/schemas/RiskScorePolicyRuleCondition"
},
"grantTypes": {
"$ref": "#/components/schemas/GrantTypePolicyRuleCondition"
},
"userStatus": {
"$ref": "#/components/schemas/UserStatusPolicyRuleCondition"
},
"authContext": {
"$ref": "#/components/schemas/PolicyRuleAuthContextCondition"
},
"authProvider": {
"$ref": "#/components/schemas/PasswordPolicyAuthenticationProviderCondition"
},
"mdmEnrollment": {
"$ref": "#/components/schemas/MDMEnrollmentPolicyRuleCondition"
},
"userIdentifier": {
"$ref": "#/components/schemas/UserIdentifierPolicyRuleCondition"
},
"identityProvider": {
"$ref": "#/components/schemas/IdentityProviderPolicyRuleCondition"
},
"beforeScheduledAction": {
"$ref": "#/components/schemas/BeforeScheduledActionPolicyRuleCondition"
}
},
"x-okta-tags": [
"Policy"
]
}
PolicySubject
{
"type": "object",
"properties": {
"filter": {
"type": "string"
},
"format": {
"type": "array",
"items": {
"type": "string"
}
},
"matchType": {
"$ref": "#/components/schemas/PolicySubjectMatchType"
},
"matchAttribute": {
"type": "string"
},
"userNameTemplate": {
"$ref": "#/components/schemas/PolicyUserNameTemplate"
}
},
"x-okta-tags": [
"Policy"
]
}
PolicySubjectMatchType
{
"enum": [
"USERNAME",
"EMAIL",
"USERNAME_OR_EMAIL",
"CUSTOM_ATTRIBUTE"
],
"type": "string",
"x-okta-tags": [
"Policy"
]
}
PolicyType
{
"enum": [
"OAUTH_AUTHORIZATION_POLICY",
"OKTA_SIGN_ON",
"PASSWORD",
"IDP_DISCOVERY",
"PROFILE_ENROLLMENT",
"ACCESS_POLICY",
"MFA_ENROLL"
],
"type": "string",
"x-okta-tags": [
"Policy"
]
}
PolicyUserNameTemplate
{
"type": "object",
"properties": {
"template": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
PossessionConstraint
{
"properties": {
"deviceBound": {
"type": "string"
},
"userPresence": {
"type": "string"
},
"phishingResistant": {
"type": "string"
},
"hardwareProtection": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/AccessPolicyConstraint"
}
PreRegistrationInlineHook
{
"type": "object",
"properties": {
"inlineHookId": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
ProfileEnrollmentPolicy
{
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
ProfileEnrollmentPolicyRule
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"actions": {
"$ref": "#/components/schemas/ProfileEnrollmentPolicyRuleActions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRule"
}
ProfileEnrollmentPolicyRuleAction
{
"type": "object",
"properties": {
"access": {
"type": "string"
},
"uiSchemaId": {
"type": "string"
},
"targetGroupIds": {
"type": "array",
"items": {
"type": "string"
}
},
"profileAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileEnrollmentPolicyRuleProfileAttribute"
}
},
"unknownUserAction": {
"type": "string"
},
"activationRequirements": {
"$ref": "#/components/schemas/ProfileEnrollmentPolicyRuleActivationRequirement"
},
"preRegistrationInlineHooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreRegistrationInlineHook"
}
}
},
"x-okta-tags": [
"Policy"
]
}
ProfileEnrollmentPolicyRuleActions
{
"type": "object",
"properties": {
"profileEnrollment": {
"$ref": "#/components/schemas/ProfileEnrollmentPolicyRuleAction"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleActions"
}
ProfileEnrollmentPolicyRuleActivationRequirement
{
"type": "object",
"properties": {
"emailVerification": {
"type": "boolean"
}
},
"x-okta-tags": [
"Policy"
]
}
ProfileEnrollmentPolicyRuleProfileAttribute
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"x-okta-tags": [
"Policy"
]
}
ProfileMapping
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"source": {
"$ref": "#/components/schemas/ProfileMappingSource"
},
"target": {
"$ref": "#/components/schemas/ProfileMappingSource"
},
"properties": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"$ref": "#/components/schemas/ProfileMappingProperty"
}
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"src": "id",
"dest": "mappingId"
}
],
"operationId": "getProfileMapping"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "mappingId"
}
],
"operationId": "updateProfileMapping"
}
],
"x-okta-tags": [
"ProfileMapping"
]
}
ProfileMappingListWithPaginationResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileMapping"
}
}
ProfileMappingProperty
{
"type": "object",
"properties": {
"expression": {
"type": "string"
},
"pushStatus": {
"$ref": "#/components/schemas/ProfileMappingPropertyPushStatus"
}
},
"x-okta-tags": [
"ProfileMapping"
]
}
ProfileMappingPropertyPushStatus
{
"enum": [
"PUSH",
"DONT_PUSH"
],
"type": "object",
"x-okta-tags": [
"ProfileMapping"
]
}
ProfileMappingSource
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
}
},
"x-okta-tags": [
"ProfileMapping"
]
}
ProfileSettingObject
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/EnabledStatus"
}
},
"x-okta-tags": [
"Application"
]
}
Protocol
{
"type": "object",
"properties": {
"type": {
"enum": [
"SAML2",
"OIDC",
"OAUTH2",
"MTLS"
],
"type": "string"
},
"issuer": {
"$ref": "#/components/schemas/ProtocolEndpoint"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"settings": {
"$ref": "#/components/schemas/ProtocolSettings"
},
"endpoints": {
"$ref": "#/components/schemas/ProtocolEndpoints"
},
"algorithms": {
"$ref": "#/components/schemas/ProtocolAlgorithms"
},
"relayState": {
"$ref": "#/components/schemas/ProtocolRelayState"
},
"credentials": {
"$ref": "#/components/schemas/IdentityProviderCredentials"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProtocolAlgorithmType
{
"type": "object",
"properties": {
"signature": {
"$ref": "#/components/schemas/ProtocolAlgorithmTypeSignature"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProtocolAlgorithmTypeSignature
{
"type": "object",
"properties": {
"scope": {
"enum": [
"RESPONSE",
"TOKEN",
"ANY",
"REQUEST",
"NONE"
],
"type": "string"
},
"algorithm": {
"type": "string"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProtocolAlgorithms
{
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/ProtocolAlgorithmType"
},
"response": {
"$ref": "#/components/schemas/ProtocolAlgorithmType"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProtocolEndpoint
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"type": {
"enum": [
"INSTANCE",
"ORG"
],
"type": "string"
},
"binding": {
"enum": [
"HTTP-POST",
"HTTP-REDIRECT"
],
"type": "string"
},
"destination": {
"type": "string"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProtocolEndpoints
{
"type": "object",
"properties": {
"acs": {
"$ref": "#/components/schemas/ProtocolEndpoint"
},
"slo": {
"$ref": "#/components/schemas/ProtocolEndpoint"
},
"sso": {
"$ref": "#/components/schemas/ProtocolEndpoint"
},
"jwks": {
"$ref": "#/components/schemas/ProtocolEndpoint"
},
"token": {
"$ref": "#/components/schemas/ProtocolEndpoint"
},
"metadata": {
"$ref": "#/components/schemas/ProtocolEndpoint"
},
"userInfo": {
"$ref": "#/components/schemas/ProtocolEndpoint"
},
"authorization": {
"$ref": "#/components/schemas/ProtocolEndpoint"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProtocolRelayState
{
"type": "object",
"properties": {
"format": {
"$ref": "#/components/schemas/ProtocolRelayStateFormat"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProtocolRelayStateFormat
{
"enum": [
"OPAQUE",
"FROM_URL"
],
"type": "string",
"x-okta-tags": [
"IdentityProvider"
]
}
ProtocolSettings
{
"type": "object",
"properties": {
"nameFormat": {
"type": "string"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
Provisioning
{
"type": "object",
"properties": {
"action": {
"enum": [
"AUTO",
"CALLOUT",
"DISABLED"
],
"type": "string"
},
"groups": {
"$ref": "#/components/schemas/ProvisioningGroups"
},
"conditions": {
"$ref": "#/components/schemas/ProvisioningConditions"
},
"profileMaster": {
"type": "boolean"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProvisioningConditions
{
"type": "object",
"properties": {
"suspended": {
"$ref": "#/components/schemas/ProvisioningSuspendedCondition"
},
"deprovisioned": {
"$ref": "#/components/schemas/ProvisioningDeprovisionedCondition"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProvisioningConnection
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/ProvisioningConnectionStatus"
},
"authScheme": {
"$ref": "#/components/schemas/ProvisioningConnectionAuthScheme"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-operations": [
{
"alias": "getDefaultProvisioningConnectionForApplication",
"operationId": "getDefaultProvisioningConnectionForApplication"
},
{
"alias": "activateDefaultProvisioningConnectionForApplication",
"operationId": "activateDefaultProvisioningConnectionForApplication"
},
{
"alias": "deactivateDefaultProvisioningConnectionForApplication",
"operationId": "deactivateDefaultProvisioningConnectionForApplication"
}
]
}
ProvisioningConnectionAuthScheme
{
"enum": [
"TOKEN",
"UNKNOWN"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
ProvisioningConnectionProfile
{
"type": "object",
"properties": {
"token": {
"type": "string"
},
"authScheme": {
"$ref": "#/components/schemas/ProvisioningConnectionAuthScheme"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-operations": [
{
"alias": "setDefaultProvisioningConnectionForApplication",
"operationId": "setDefaultProvisioningConnectionForApplication"
}
]
}
ProvisioningConnectionRequest
{
"type": "object",
"properties": {
"profile": {
"$ref": "#/components/schemas/ProvisioningConnectionProfile"
}
},
"x-okta-tags": [
"Application"
]
}
ProvisioningConnectionStatus
{
"enum": [
"DISABLED",
"ENABLED",
"UNKNOWN"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}