Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://your-subdomain.okta.com
/api/v1/apps/{appId}
Updates an application in your organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| appId | path | required | string |
{
"$ref": "#/components/requestBodies/Application"
}
PUT /api/v1/apps/{appId}
/api/v1/apps/{appId}/features/{name}
Updates a Feature object for an application.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| appId | path | required | string | |
| name | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CapabilitiesObject"
}
}
},
"required": true
}
PUT /api/v1/apps/{appId}/features/{name}
/api/v1/apps/{appId}/groups/{groupId}
Assigns a group to an application
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| appId | path | required | string | |
| groupId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationGroupAssignment"
}
}
}
}
PUT /api/v1/apps/{appId}/groups/{groupId}
/api/v1/apps/{appId}/policies/{policyId}
Assign an application to a specific policy. This unassigns the application from its currently assigned policy.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| appId | path | required | string | |
| policyId | path | required | string |
PUT /api/v1/apps/{appId}/policies/{policyId}
/api/v1/authenticators/{authenticatorId}
Updates an authenticator
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| authenticatorId | path | required | string |
{
"$ref": "#/components/requestBodies/Authenticator"
}
PUT /api/v1/authenticators/{authenticatorId}
/api/v1/authorizationServers/{authServerId}
Success
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| authServerId | path | required | string |
{
"$ref": "#/components/requestBodies/AuthorizationServer"
}
PUT /api/v1/authorizationServers/{authServerId}
/api/v1/authorizationServers/{authServerId}/claims/{claimId}
Success
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| authServerId | path | required | string | |
| claimId | path | required | string |
{
"$ref": "#/components/requestBodies/OAuth2Claim"
}
PUT /api/v1/authorizationServers/{authServerId}/claims/{claimId}
/api/v1/authorizationServers/{authServerId}/policies/{policyId}
Success
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| authServerId | path | required | string | |
| policyId | path | required | string |
{
"$ref": "#/components/requestBodies/AuthorizationServerPolicy"
}
PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}
/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}
Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| authServerId | path | required | string | |
| policyId | path | required | string | |
| ruleId | path | required | string |
{
"$ref": "#/components/requestBodies/AuthorizationServerPolicyRule"
}
PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}
/api/v1/authorizationServers/{authServerId}/scopes/{scopeId}
Success
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| authServerId | path | required | string | |
| scopeId | path | required | string |
{
"$ref": "#/components/requestBodies/OAuth2Scope"
}
PUT /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}
/api/v1/brands/{brandId}
Updates a brand by `brandId`
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| brandId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Brand"
}
}
},
"required": true
}
PUT /api/v1/brands/{brandId}
/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}
Update an email customization
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| brandId | path | required | string | |
| templateName | path | required | string | |
| customizationId | path | required | string |
{
"$ref": "#/components/requestBodies/EmailTemplateCustomizationRequest"
}
PUT /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}
/api/v1/brands/{brandId}/themes/{themeId}
Updates a theme for a brand
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| brandId | path | required | string | |
| themeId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Theme"
}
}
},
"required": true
}
PUT /api/v1/brands/{brandId}/themes/{themeId}
/api/v1/domains/{domainId}/certificate
Creates the Certificate for the Domain.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| domainId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainCertificate"
}
}
},
"required": true
}
PUT /api/v1/domains/{domainId}/certificate
/api/v1/eventHooks/{eventHookId}
Success
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| eventHookId | path | required | string |
{
"$ref": "#/components/requestBodies/EventHook"
}
PUT /api/v1/eventHooks/{eventHookId}
/api/v1/groups/rules/{ruleId}
Updates a group rule. Only `INACTIVE` rules can be updated.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| ruleId | path | required | string |
{
"$ref": "#/components/requestBodies/GroupRule"
}
PUT /api/v1/groups/rules/{ruleId}
/api/v1/groups/{groupId}
Updates the profile for a group with `OKTA_GROUP` type from your organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| groupId | path | required | string |
{
"$ref": "#/components/requestBodies/Group"
}
PUT /api/v1/groups/{groupId}
/api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}
Success
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| groupId | path | required | string | |
| roleId | path | required | string | |
| appName | path | required | string |
PUT /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}
/api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}
Add App Instance Target to App Administrator Role given to a Group
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| groupId | path | required | string | |
| roleId | path | required | string | |
| appName | path | required | string | |
| applicationId | path | required | string |
PUT /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}
/api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| groupId | path | required | string | |
| roleId | path | required | string | |
| targetGroupId | path | required | string |
PUT /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}
/api/v1/groups/{groupId}/users/{userId}
Adds a user to a group with 'OKTA_GROUP' type.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| groupId | path | required | string | |
| userId | path | required | string |
PUT /api/v1/groups/{groupId}/users/{userId}
/api/v1/idps/{idpId}
Updates the configuration for an IdP.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idpId | path | required | string |
{
"$ref": "#/components/requestBodies/IdentityProvider"
}
PUT /api/v1/idps/{idpId}
/api/v1/inlineHooks/{inlineHookId}
Updates an inline hook by ID
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| inlineHookId | path | required | string |
{
"$ref": "#/components/requestBodies/InlineHook"
}
PUT /api/v1/inlineHooks/{inlineHookId}
/api/v1/zones/{zoneId}
Updates a network zone in your organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| zoneId | path | required | string |
{
"$ref": "#/components/requestBodies/NetworkZone"
}
PUT /api/v1/zones/{zoneId}
/api/v1/org
Update settings of your organization.
{
"$ref": "#/components/requestBodies/OrgSetting"
}
PUT /api/v1/org
/api/v1/org/contacts/{contactType}
Updates the User associated with the specified Contact Type.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| contactType | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserIdString"
}
}
},
"required": true
}
PUT /api/v1/org/contacts/{contactType}
/api/v1/policies/{policyId}
Updates a policy.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| policyId | path | required | string |
{
"$ref": "#/components/requestBodies/Policy"
}
PUT /api/v1/policies/{policyId}
/api/v1/policies/{policyId}/rules/{ruleId}
Updates a policy rule.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| policyId | path | required | string | |
| ruleId | path | required | string |
{
"$ref": "#/components/requestBodies/PolicyRule"
}
PUT /api/v1/policies/{policyId}/rules/{ruleId}
/api/v1/templates/sms/{templateId}
Updates the SMS template.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| templateId | path | required | string |
{
"$ref": "#/components/requestBodies/SmsTemplate"
}
PUT /api/v1/templates/sms/{templateId}
/api/v1/trustedOrigins/{trustedOriginId}
Success
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| trustedOriginId | path | required | string |
{
"$ref": "#/components/requestBodies/TrustedOrigin"
}
PUT /api/v1/trustedOrigins/{trustedOriginId}
/api/v1/users/{associatedUserId}/linkedObjects/{primaryRelationshipName}/{primaryUserId}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| associatedUserId | path | required | string | |
| primaryRelationshipName | path | required | string | |
| primaryUserId | path | required | string |
PUT /api/v1/users/{associatedUserId}/linkedObjects/{primaryRelationshipName}/{primaryUserId}
/api/v1/users/{userId}
Update a user's profile and/or credentials using strict-update semantics.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userId | path | required | string | |
| strict | query | optional | boolean |
{
"$ref": "#/components/requestBodies/User"
}
PUT /api/v1/users/{userId}
/api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps
Success
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userId | path | required | string | |
| roleId | path | required | string |
PUT /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps
/api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}
Success
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userId | path | required | string | |
| roleId | path | required | string | |
| appName | path | required | string |
PUT /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}
/api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}
Add App Instance Target to App Administrator Role given to a User
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userId | path | required | string | |
| roleId | path | required | string | |
| appName | path | required | string | |
| applicationId | path | required | string |
PUT /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}
/api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}
Success
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userId | path | required | string | |
| roleId | path | required | string | |
| groupId | path | required | string |
PUT /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}
/api/v1/meta/types/user/{typeId}
Replace an existing User Type
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| typeId | path | required | string |
{
"$ref": "#/components/requestBodies/UserType"
}
PUT /api/v1/meta/types/user/{typeId}
AccessPolicy
{
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
AccessPolicyConstraint
{
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"type": "string"
}
},
"methods": {
"type": "array",
"items": {
"type": "string"
}
},
"reauthenticateIn": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
AccessPolicyConstraints
{
"type": "object",
"properties": {
"knowledge": {
"$ref": "#/components/schemas/KnowledgeConstraint"
},
"possession": {
"$ref": "#/components/schemas/PossessionConstraint"
}
},
"x-okta-tags": [
"Policy"
]
}
AccessPolicyRule
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"actions": {
"$ref": "#/components/schemas/AccessPolicyRuleActions"
},
"conditions": {
"$ref": "#/components/schemas/AccessPolicyRuleConditions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRule"
}
AccessPolicyRuleActions
{
"type": "object",
"properties": {
"appSignOn": {
"$ref": "#/components/schemas/AccessPolicyRuleApplicationSignOn"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleActions"
}
AccessPolicyRuleApplicationSignOn
{
"type": "object",
"properties": {
"access": {
"type": "string"
},
"verificationMethod": {
"$ref": "#/components/schemas/VerificationMethod"
}
},
"x-okta-tags": [
"Policy"
]
}
AccessPolicyRuleConditions
{
"properties": {
"device": {
"$ref": "#/components/schemas/DeviceAccessPolicyRuleCondition"
},
"userType": {
"$ref": "#/components/schemas/UserTypeCondition"
},
"elCondition": {
"$ref": "#/components/schemas/AccessPolicyRuleCustomCondition"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleConditions"
}
AccessPolicyRuleCustomCondition
{
"properties": {
"condition": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
AcsEndpoint
{
"properties": {
"url": {
"type": "string"
},
"index": {
"type": "integer"
}
},
"x-okta-tags": [
"Application"
]
}
ActivateFactorRequest
{
"properties": {
"passCode": {
"type": "string"
},
"clientData": {
"type": "string"
},
"stateToken": {
"type": "string"
},
"attestation": {
"type": "string"
},
"registrationData": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
AllowedForEnum
{
"enum": [
"recovery",
"sso",
"any",
"none"
],
"type": "string",
"x-okta-tags": [
"Authenticator"
]
}
AppAndInstanceConditionEvaluatorAppOrInstance
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"enum": [
"APP_TYPE",
"APP"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
AppAndInstancePolicyRuleCondition
{
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance"
}
},
"include": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance"
}
}
},
"x-okta-tags": [
"Policy"
]
}
AppInstancePolicyRuleCondition
{
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
AppLink
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"label": {
"type": "string",
"readOnly": true
},
"hidden": {
"type": "boolean",
"readOnly": true
},
"appName": {
"type": "string",
"readOnly": true
},
"linkUrl": {
"type": "string",
"readOnly": true
},
"logoUrl": {
"type": "string",
"readOnly": true
},
"sortOrder": {
"type": "integer",
"readOnly": true
},
"appInstanceId": {
"type": "string",
"readOnly": true
},
"appAssignmentId": {
"type": "string",
"readOnly": true
},
"credentialsSetup": {
"type": "boolean",
"readOnly": true
}
},
"x-okta-tags": [
"User"
]
}
AppUser
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"scope": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string",
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"profile": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"lastSync": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"syncState": {
"type": "string",
"readOnly": true
},
"externalId": {
"type": "string",
"readOnly": true
},
"credentials": {
"$ref": "#/components/schemas/AppUserCredentials"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"statusChanged": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"passwordChanged": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "update",
"arguments": [
{
"dest": "appId",
"parentSrc": "appId"
},
{
"src": "id",
"dest": "userId"
},
{
"dest": "appUser",
"self": true
}
],
"operationId": "updateApplicationUser"
},
{
"alias": "delete",
"arguments": [
{
"dest": "appId",
"parentSrc": "appId"
},
{
"src": "id",
"dest": "userId"
}
],
"operationId": "deleteApplicationUser"
}
],
"x-okta-tags": [
"Application"
]
}
AppUserCredentials
{
"type": "object",
"properties": {
"password": {
"$ref": "#/components/schemas/AppUserPasswordCredential"
},
"userName": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
AppUserPasswordCredential
{
"properties": {
"value": {
"type": "string",
"format": "password"
}
},
"x-okta-tags": [
"Application"
]
}
Application
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"label": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string",
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"profile": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"settings": {
"$ref": "#/components/schemas/ApplicationSettings"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"licensing": {
"$ref": "#/components/schemas/ApplicationLicensing"
},
"signOnMode": {
"$ref": "#/components/schemas/ApplicationSignOnMode"
},
"visibility": {
"$ref": "#/components/schemas/ApplicationVisibility"
},
"credentials": {
"$ref": "#/components/schemas/ApplicationCredentials"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"accessibility": {
"$ref": "#/components/schemas/ApplicationAccessibility"
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "getApplication"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "appId"
},
{
"dest": "application",
"self": true
}
],
"operationId": "updateApplication"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "deleteApplication"
}
],
"x-okta-tags": [
"Application"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "activateApplication"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "deactivateApplication"
},
{
"alias": "listApplicationUsers",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "listApplicationUsers"
},
{
"alias": "assignUserToApplication",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "assignUserToApplication"
},
{
"alias": "getApplicationUser",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "getApplicationUser"
},
{
"alias": "createApplicationGroupAssignment",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "createApplicationGroupAssignment"
},
{
"alias": "getApplicationGroupAssignment",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "getApplicationGroupAssignment"
},
{
"alias": "cloneApplicationKey",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "cloneApplicationKey"
},
{
"alias": "getApplicationKey",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "getApplicationKey"
},
{
"alias": "listGroupAssignments",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "listApplicationGroupAssignments"
},
{
"alias": "listKeys",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "listApplicationKeys"
},
{
"alias": "generateKey",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "generateApplicationKey"
},
{
"alias": "generateCsr",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "generateCsrForApplication"
},
{
"alias": "getCsr",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "getCsrForApplication"
},
{
"alias": "revokeCsr",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "revokeCsrFromApplication"
},
{
"alias": "listCsrs",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "listCsrsForApplication"
},
{
"alias": "publishCerCert",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "publishCerCert"
},
{
"alias": "publishBinaryCerCert",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "publishBinaryCerCert"
},
{
"alias": "publishDerCert",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "publishDerCert"
},
{
"alias": "publishBinaryDerCert",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "publishBinaryDerCert"
},
{
"alias": "publishBinaryPemCert",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "publishBinaryPemCert"
},
{
"alias": "listOAuth2Tokens",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "listOAuth2TokensForApplication"
},
{
"alias": "revokeOAuth2TokenForApplication",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "revokeOAuth2TokenForApplication"
},
{
"alias": "getOAuth2Token",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "getOAuth2TokenForApplication"
},
{
"alias": "revokeOAuth2Tokens",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "revokeOAuth2TokensForApplication"
},
{
"alias": "listScopeConsentGrants",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "listScopeConsentGrants"
},
{
"alias": "grantConsentToScope",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "grantConsentToScope"
},
{
"alias": "revokeScopeConsentGrant",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "revokeScopeConsentGrant"
},
{
"alias": "getScopeConsentGrant",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "getScopeConsentGrant"
},
{
"alias": "uploadApplicationLogo",
"operationId": "uploadApplicationLogo"
},
{
"alias": "getFeatureForApplication",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "getFeatureForApplication"
},
{
"alias": "updateFeatureForApplication",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "updateFeatureForApplication"
},
{
"alias": "updateApplicationPolicy",
"arguments": [
{
"src": "id",
"dest": "appId"
}
],
"operationId": "updateApplicationPolicy"
}
],
"x-openapi-v3-discriminator": {
"mapping": {
"BOOKMARK": "#/definitions/BookmarkApplication",
"SAML_1_1": "#/definitions/SamlApplication",
"SAML_2_0": "#/definitions/SamlApplication",
"AUTO_LOGIN": "#/definitions/AutoLoginApplication",
"BASIC_AUTH": "#/definitions/BasicAuthApplication",
"WS_FEDERATION": "#/definitions/WsFederationApplication",
"BROWSER_PLUGIN": "#/definitions/BrowserPluginApplication",
"OPENID_CONNECT": "#/definitions/OpenIdConnectApplication",
"SECURE_PASSWORD_STORE": "#/definitions/SecurePasswordStoreApplication"
},
"propertyName": "signOnMode"
}
}
ApplicationAccessibility
{
"type": "object",
"properties": {
"selfService": {
"type": "boolean"
},
"errorRedirectUrl": {
"type": "string"
},
"loginRedirectUrl": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationCredentials
{
"type": "object",
"properties": {
"signing": {
"$ref": "#/components/schemas/ApplicationCredentialsSigning"
},
"userNameTemplate": {
"$ref": "#/components/schemas/ApplicationCredentialsUsernameTemplate"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationCredentialsOAuthClient
{
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"pkce_required": {
"type": "boolean"
},
"autoKeyRotation": {
"type": "boolean"
},
"token_endpoint_auth_method": {
"$ref": "#/components/schemas/OAuthEndpointAuthenticationMethod"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationCredentialsScheme
{
"enum": [
"SHARED_USERNAME_AND_PASSWORD",
"EXTERNAL_PASSWORD_SYNC",
"EDIT_USERNAME_AND_PASSWORD",
"EDIT_PASSWORD_ONLY",
"ADMIN_SETS_CREDENTIALS"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
ApplicationCredentialsSigning
{
"type": "object",
"properties": {
"kid": {
"type": "string"
},
"use": {
"$ref": "#/components/schemas/ApplicationCredentialsSigningUse"
},
"lastRotated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"nextRotation": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"rotationMode": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationCredentialsSigningUse
{
"enum": [
"sig"
],
"type": "string",
"x-okta-tags": [
"AuthorizationServer"
]
}
ApplicationCredentialsUsernameTemplate
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"suffix": {
"type": "string"
},
"template": {
"type": "string"
},
"pushStatus": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationFeature
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/EnabledStatus"
},
"description": {
"type": "string"
},
"capabilities": {
"$ref": "#/components/schemas/CapabilitiesObject"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-operations": [
{
"alias": "listFeaturesForApplication",
"operationId": "listFeaturesForApplication"
}
]
}
ApplicationGroupAssignment
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"profile": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"priority": {
"type": "integer"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "delete",
"arguments": [
{
"dest": "appId",
"parentSrc": "appId"
},
{
"src": "id",
"dest": "groupId"
}
],
"operationId": "deleteApplicationGroupAssignment"
}
],
"x-okta-tags": [
"Application"
]
}
ApplicationLicensing
{
"type": "object",
"properties": {
"seatCount": {
"type": "integer"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationListAppsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Application"
}
}
ApplicationListAssignedUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AppUser"
}
}
ApplicationListClientSecretsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientSecret"
}
}
ApplicationListCsrsForApplicationResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Csr"
}
}
ApplicationListFeaturesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationFeature"
}
}
ApplicationListGroupsAssignedResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationGroupAssignment"
}
}
ApplicationListKeyCredentialsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKey"
}
}
ApplicationListScopeConsentGrantsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2ScopeConsentGrant"
}
}
ApplicationListTokensResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2Token"
}
}
ApplicationPreviewSamlAppMetadataResponse
{
"type": "object",
"properties": {
"EntityDescriptor": {
"type": "object",
"properties": {
"entityID": {
"xml": {
"attribute": true
},
"type": "string"
},
"IDPSSODescriptor": {
"type": "object",
"properties": {
"NameIDFormat": {
"type": "array",
"items": {
"type": "string"
}
},
"KeyDescriptor": {
"type": "object",
"properties": {
"use": {
"xml": {
"attribute": true
},
"type": "string"
},
"KeyInfo": {
"type": "object",
"properties": {
"X509Data": {
"type": "object",
"properties": {
"X509Certificate": {
"type": "string"
}
}
}
}
}
}
},
"SingleLogoutService": {
"type": "array",
"items": {
"type": "string"
},
"properties": {
"Binding": {
"xml": {
"attribute": true
},
"type": "string"
},
"Location": {
"xml": {
"attribute": true
},
"type": "string"
}
}
},
"SingleSignOnService": {
"type": "array",
"items": {
"type": "string"
},
"properties": {
"Binding": {
"xml": {
"attribute": true
},
"type": "string"
},
"Location": {
"xml": {
"attribute": true
},
"type": "string"
}
}
},
"WantAuthnRequestsSigned": {
"xml": {
"attribute": true
},
"type": "boolean"
},
"protocolSupportEnumeration": {
"xml": {
"attribute": true
},
"type": "string"
}
}
}
}
}
}
}
ApplicationSettings
{
"type": "object",
"properties": {
"app": {
"$ref": "#/components/schemas/ApplicationSettingsApplication"
},
"notes": {
"$ref": "#/components/schemas/ApplicationSettingsNotes"
},
"inlineHookId": {
"type": "string"
},
"notifications": {
"$ref": "#/components/schemas/ApplicationSettingsNotifications"
},
"implicitAssignment": {
"type": "boolean"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationSettingsApplication
{
"properties": {
"url": {
"type": "string"
},
"acsUrl": {
"type": "string"
},
"orgName": {
"type": "string"
},
"buttonField": {
"type": "string"
},
"loginUrlRegex": {
"type": "string"
},
"passwordField": {
"type": "string"
},
"usernameField": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationSettingsNotes
{
"type": "object",
"properties": {
"admin": {
"type": "string"
},
"enduser": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationSettingsNotifications
{
"type": "object",
"properties": {
"vpn": {
"$ref": "#/components/schemas/ApplicationSettingsNotificationsVpn"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationSettingsNotificationsVpn
{
"type": "object",
"properties": {
"helpUrl": {
"type": "string"
},
"message": {
"type": "string"
},
"network": {
"$ref": "#/components/schemas/ApplicationSettingsNotificationsVpnNetwork"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationSettingsNotificationsVpnNetwork
{
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
},
"connection": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationSignOnMode
{
"enum": [
"BOOKMARK",
"BASIC_AUTH",
"BROWSER_PLUGIN",
"SECURE_PASSWORD_STORE",
"AUTO_LOGIN",
"WS_FEDERATION",
"SAML_2_0",
"OPENID_CONNECT",
"SAML_1_1"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
ApplicationUpdateLogoRequest
{
"type": "object",
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
}
ApplicationVisibility
{
"type": "object",
"properties": {
"hide": {
"$ref": "#/components/schemas/ApplicationVisibilityHide"
},
"appLinks": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"autoLaunch": {
"type": "boolean"
},
"autoSubmitToolbar": {
"type": "boolean"
}
},
"x-okta-tags": [
"Application"
]
}
ApplicationVisibilityHide
{
"type": "object",
"properties": {
"iOS": {
"type": "boolean"
},
"web": {
"type": "boolean"
}
},
"x-okta-tags": [
"Application"
]
}
AssignRoleRequest
{
"properties": {
"type": {
"$ref": "#/components/schemas/RoleType"
}
},
"x-okta-tags": [
"Role"
]
}
AuthenticationProvider
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/AuthenticationProviderType"
}
},
"x-okta-tags": [
"User"
]
}
AuthenticationProviderType
{
"enum": [
"ACTIVE_DIRECTORY",
"FEDERATION",
"LDAP",
"OKTA",
"SOCIAL",
"IMPORT"
],
"type": "string",
"x-okta-tags": [
"User"
]
}
Authenticator
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/AuthenticatorType"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/AuthenticatorStatus"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"provider": {
"$ref": "#/components/schemas/AuthenticatorProvider"
},
"settings": {
"$ref": "#/components/schemas/AuthenticatorSettings"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [],
"operationId": "getAuthenticator"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "authenticatorId"
},
{
"dest": "authenticator",
"self": true
}
],
"operationId": "updateAuthenticator"
}
],
"x-okta-tags": [
"Authenticator"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "authenticatorId"
}
],
"operationId": "activateAuthenticator"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "authenticatorId"
}
],
"operationId": "deactivateAuthenticator"
}
]
}
AuthenticatorListAllAvailableResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Authenticator"
}
}
AuthenticatorProvider
{
"properties": {
"type": {
"type": "string"
},
"configuration": {
"$ref": "#/components/schemas/AuthenticatorProviderConfiguration"
}
},
"x-okta-tags": [
"Authenticator"
]
}
AuthenticatorProviderConfiguration
{
"properties": {
"host": {
"type": "string"
},
"authPort": {
"type": "integer"
},
"hostName": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"instanceId": {
"type": "string"
},
"sharedSecret": {
"type": "string"
},
"integrationKey": {
"type": "string"
},
"userNameTemplate": {
"$ref": "#/components/schemas/AuthenticatorProviderConfigurationUserNamePlate"
}
},
"x-okta-tags": [
"Authenticator"
]
}
AuthenticatorProviderConfigurationUserNamePlate
{
"properties": {
"template": {
"type": "string"
}
},
"x-okta-tags": [
"Authenticator"
]
}
AuthenticatorSettings
{
"type": "object",
"properties": {
"allowedFor": {
"$ref": "#/components/schemas/AllowedForEnum"
},
"compliance": {
"$ref": "#/components/schemas/Compliance"
},
"appInstanceId": {
"type": "string"
},
"channelBinding": {
"$ref": "#/components/schemas/ChannelBinding"
},
"userVerification": {
"$ref": "#/components/schemas/UserVerificationEnum"
},
"tokenLifetimeInMinutes": {
"type": "integer"
}
},
"x-okta-tags": [
"Authenticator"
]
}
AuthenticatorStatus
{
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"x-okta-tags": [
"Authenticator"
]
}
AuthenticatorType
{
"enum": [
"app",
"password",
"security_question",
"phone",
"email",
"security_key",
"federated"
],
"type": "string",
"x-okta-tags": [
"Authenticator"
]
}
AuthorizationServer
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"issuer": {
"type": "string"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"default": {
"type": "boolean",
"readOnly": true
},
"audiences": {
"type": "array",
"items": {
"type": "string"
}
},
"issuerMode": {
"enum": [
"ORG_URL",
"CUSTOM_URL",
"DYNAMIC"
],
"type": "string"
},
"credentials": {
"$ref": "#/components/schemas/AuthorizationServerCredentials"
},
"description": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "authorizationServer",
"self": true
}
],
"operationId": "createAuthorizationServer"
},
{
"alias": "read",
"arguments": [],
"operationId": "getAuthorizationServer"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "authServerId"
},
{
"dest": "authorizationServer",
"self": true
}
],
"operationId": "updateAuthorizationServer"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "authServerId"
},
{
"dest": "authorizationServer",
"self": true
}
],
"operationId": "deleteAuthorizationServer"
}
],
"x-okta-tags": [
"AuthorizationServer"
],
"x-okta-operations": [
{
"alias": "listOAuth2Claims",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listOAuth2Claims"
},
{
"alias": "createOAuth2Claim",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "createOAuth2Claim"
},
{
"alias": "deleteOAuth2Claim",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "deleteOAuth2Claim"
},
{
"alias": "getOAuth2Claim",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "getOAuth2Claim"
},
{
"alias": "updateOAuth2Claim",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "updateOAuth2Claim"
},
{
"alias": "listOAuth2Clients",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listOAuth2ClientsForAuthorizationServer"
},
{
"alias": "revokeRefreshTokensForClient",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "revokeRefreshTokensForAuthorizationServerAndClient"
},
{
"alias": "listRefreshTokensForClient",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listRefreshTokensForAuthorizationServerAndClient"
},
{
"alias": "getRefreshTokenForClient",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "getRefreshTokenForAuthorizationServerAndClient"
},
{
"alias": "revokeRefreshTokenForClient",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "revokeRefreshTokenForAuthorizationServerAndClient"
},
{
"alias": "listKeys",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listAuthorizationServerKeys"
},
{
"alias": "rotateKeys",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "rotateAuthorizationServerKeys"
},
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "activateAuthorizationServer"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "deactivateAuthorizationServer"
},
{
"alias": "listPolicies",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listAuthorizationServerPolicies"
},
{
"alias": "createPolicy",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "createAuthorizationServerPolicy"
},
{
"alias": "deletePolicy",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "deleteAuthorizationServerPolicy"
},
{
"alias": "getPolicy",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "getAuthorizationServerPolicy"
},
{
"alias": "updatePolicy",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "updateAuthorizationServerPolicy"
},
{
"alias": "listOAuth2Scopes",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listOAuth2Scopes"
},
{
"alias": "createOAuth2Scope",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "createOAuth2Scope"
},
{
"alias": "deleteOAuth2Scope",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "deleteOAuth2Scope"
},
{
"alias": "getOAuth2Scope",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "getOAuth2Scope"
},
{
"alias": "updateOAuth2Scope",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "updateOAuth2Scope"
}
]
}
AuthorizationServerCredentials
{
"properties": {
"signing": {
"$ref": "#/components/schemas/AuthorizationServerCredentialsSigningConfig"
}
},
"x-okta-tags": [
"Application"
]
}
AuthorizationServerCredentialsRotationMode
{
"enum": [
"AUTO",
"MANUAL"
],
"type": "string",
"x-okta-tags": [
"AuthorizationServer"
]
}
AuthorizationServerCredentialsSigningConfig
{
"properties": {
"kid": {
"type": "string"
},
"use": {
"$ref": "#/components/schemas/AuthorizationServerCredentialsUse"
},
"lastRotated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"nextRotation": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"rotationMode": {
"$ref": "#/components/schemas/AuthorizationServerCredentialsRotationMode"
}
},
"x-okta-tags": [
"AuthorizationServer"
]
}
AuthorizationServerCredentialsUse
{
"enum": [
"sig"
],
"type": "string",
"x-okta-tags": [
"AuthorizationServer"
]
}
AuthorizationServerEnumeratePolicyRulesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorizationServerPolicyRule"
}
}
AuthorizationServerGetClaimsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2Claim"
}
}
AuthorizationServerGetClientTokensResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2RefreshToken"
}
}
AuthorizationServerGetPoliciesSuccessResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorizationServerPolicy"
}
}
AuthorizationServerGetScopesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2Scope"
}
}
AuthorizationServerListClientsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2Client"
}
}
AuthorizationServerListCredentialsKeysResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKey"
}
}
AuthorizationServerListServersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorizationServer"
}
}
AuthorizationServerPolicy
{
"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": "getAuthorizationServerPolicy"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "policyId"
},
{
"dest": "policy",
"self": true
}
],
"operationId": "updateAuthorizationServerPolicy"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "deleteAuthorizationServerPolicy"
}
],
"x-okta-tags": [
"AuthorizationServer"
],
"x-okta-operations": [
{
"alias": "listPolicyRules",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "listAuthorizationServerPolicyRules"
},
{
"alias": "createPolicyRule",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "createAuthorizationServerPolicyRule"
},
{
"alias": "getPolicyRule",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "getAuthorizationServerPolicyRule"
},
{
"alias": "deletePolicyRule",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "deleteAuthorizationServerPolicyRule"
},
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "activateAuthorizationServerPolicy"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "deactivateAuthorizationServerPolicy"
}
]
}
AuthorizationServerPolicyRule
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"enum": [
"RESOURCE_ACCESS"
],
"type": "string"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"default": "ACTIVE"
},
"system": {
"type": "boolean",
"default": false
},
"actions": {
"$ref": "#/components/schemas/AuthorizationServerPolicyRuleActions"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"priority": {
"type": "integer"
},
"conditions": {
"$ref": "#/components/schemas/AuthorizationServerPolicyRuleConditions"
},
"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": "updateAuthorizationServerPolicyRule"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyId",
"parentSrc": "policyId"
}
],
"operationId": "deleteAuthorizationServerPolicyRule"
}
],
"x-okta-tags": [
"AuthorizationServerPolicy"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyId",
"parentSrc": "policyId"
}
],
"operationId": "activateAuthorizationServerPolicyRule"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyId",
"parentSrc": "policyId"
}
],
"operationId": "deactivateAuthorizationServerPolicyRule"
}
]
}
AuthorizationServerPolicyRuleActions
{
"type": "object",
"properties": {
"token": {
"$ref": "#/components/schemas/TokenAuthorizationServerPolicyRuleAction"
}
},
"x-okta-tags": [
"AuthorizationServerPolicy"
]
}
AuthorizationServerPolicyRuleConditions
{
"type": "object",
"properties": {
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
},
"scopes": {
"$ref": "#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition"
},
"clients": {
"$ref": "#/components/schemas/ClientPolicyCondition"
},
"grantTypes": {
"$ref": "#/components/schemas/GrantTypePolicyRuleCondition"
}
},
"x-okta-tags": [
"AuthorizationServerPolicy"
]
}
AuthorizationServerRotateKeyLifecycleResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKey"
}
}
AutoLoginApplication
{
"properties": {
"settings": {
"$ref": "#/components/schemas/AutoLoginApplicationSettings"
},
"credentials": {
"$ref": "#/components/schemas/SchemeApplicationCredentials"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application"
}
AutoLoginApplicationSettings
{
"properties": {
"signOn": {
"$ref": "#/components/schemas/AutoLoginApplicationSettingsSignOn"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
AutoLoginApplicationSettingsSignOn
{
"properties": {
"loginUrl": {
"type": "string"
},
"redirectUrl": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
BasicApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/BasicApplicationSettingsApplication"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
BasicApplicationSettingsApplication
{
"properties": {
"url": {
"type": "string"
},
"authURL": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
BasicAuthApplication
{
"properties": {
"name": {
"default": "template_basic_auth"
},
"settings": {
"$ref": "#/components/schemas/BasicApplicationSettings"
},
"credentials": {
"$ref": "#/components/schemas/SchemeApplicationCredentials"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-okta-defined-as": {
"name": "template_basic_auth"
}
}
BeforeScheduledActionPolicyRuleCondition
{
"type": "object",
"properties": {
"duration": {
"$ref": "#/components/schemas/Duration"
},
"lifecycleAction": {
"$ref": "#/components/schemas/ScheduledUserLifecycleAction"
}
},
"x-okta-tags": [
"Policy"
]
}
BookmarkApplication
{
"properties": {
"name": {
"default": "bookmark"
},
"settings": {
"$ref": "#/components/schemas/BookmarkApplicationSettings"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-okta-defined-as": {
"name": "bookmark"
}
}
BookmarkApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/BookmarkApplicationSettingsApplication"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
BookmarkApplicationSettingsApplication
{
"properties": {
"url": {
"type": "string"
},
"requestIntegration": {
"type": "boolean"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
Brand
{
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"removePoweredByOkta": {
"type": "boolean"
},
"customPrivacyPolicyUrl": {
"type": "string"
},
"agreeToCustomPrivacyPolicy": {
"type": "boolean"
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"src": "id",
"dest": "brandId"
}
],
"operationId": "getBrand"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "brandId"
},
{
"dest": "brand",
"self": true
}
],
"operationId": "updateBrand"
}
],
"x-okta-tags": [
"Brand"
]
}
BrandGetAllBrandsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Brand"
}
}
BrandGetThemesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ThemeResponse"
}
}
BrandListEmailTemplateCustomizationsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailTemplateCustomization"
}
}
BrandListEmailTemplatesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailTemplate"
}
}
BrowserPluginApplication
{
"properties": {
"credentials": {
"$ref": "#/components/schemas/SchemeApplicationCredentials"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-openapi-v3-discriminator": {
"mapping": {
"template_swa": "#/definitions/SwaApplication",
"template_swa3field": "#/definitions/SwaThreeFieldApplication"
},
"propertyName": "name"
}
}
CallUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/CallUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
CallUserFactorProfile
{
"properties": {
"phoneNumber": {
"type": "string"
},
"phoneExtension": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
CapabilitiesCreateObject
{
"type": "object",
"properties": {
"lifecycleCreate": {
"$ref": "#/components/schemas/LifecycleCreateSettingObject"
}
},
"x-okta-tags": [
"Application"
]
}
CapabilitiesObject
{
"type": "object",
"properties": {
"create": {
"$ref": "#/components/schemas/CapabilitiesCreateObject"
},
"update": {
"$ref": "#/components/schemas/CapabilitiesUpdateObject"
}
},
"x-okta-tags": [
"Application"
]
}
CapabilitiesUpdateObject
{
"type": "object",
"properties": {
"profile": {
"$ref": "#/components/schemas/ProfileSettingObject"
},
"password": {
"$ref": "#/components/schemas/PasswordSettingObject"
},
"lifecycleDeactivate": {
"$ref": "#/components/schemas/LifecycleDeactivateSettingObject"
}
},
"x-okta-tags": [
"Application"
]
}
CatalogApplication
{
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/CatalogApplicationStatus"
},
"website": {
"type": "string"
},
"category": {
"type": "string"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"signOnModes": {
"type": "array",
"items": {
"type": "string"
}
},
"verificationStatus": {
"type": "string"
}
},
"x-okta-tags": [
"Role"
]
}
CatalogApplicationStatus
{
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"x-okta-tags": [
"Role"
]
}
ChangeEnum
{
"enum": [
"KEEP_EXISTING",
"CHANGE"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
ChangePasswordRequest
{
"type": "object",
"properties": {
"newPassword": {
"$ref": "#/components/schemas/PasswordCredential"
},
"oldPassword": {
"$ref": "#/components/schemas/PasswordCredential"
}
},
"x-okta-tags": [
"User"
]
}
ChannelBinding
{
"type": "object",
"properties": {
"style": {
"type": "string"
},
"required": {
"$ref": "#/components/schemas/RequiredEnum"
}
},
"x-okta-tags": [
"Authenticator"
]
}
ClientPolicyCondition
{
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
ClientSecret
{
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"secret_hash": {
"type": "string"
},
"client_secret": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
ClientSecretMetadata
{
"properties": {
"client_secret": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
Compliance
{
"type": "object",
"properties": {
"fips": {
"$ref": "#/components/schemas/FipsEnum"
}
},
"x-okta-tags": [
"Authenticator"
]
}
ContextPolicyRuleCondition
{
"type": "object",
"properties": {
"expression": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
CreateSessionRequest
{
"type": "object",
"properties": {
"sessionToken": {
"type": "string"
}
},
"x-okta-tags": [
"Session"
]
}
CreateUserRequest
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/UserType"
},
"profile": {
"$ref": "#/components/schemas/UserProfile"
},
"groupIds": {
"type": "array",
"items": {
"type": "string"
}
},
"credentials": {
"$ref": "#/components/schemas/UserCredentials"
}
},
"x-okta-tags": [
"User"
]
}
Csr
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"csr": {
"type": "string",
"readOnly": true
},
"kty": {
"type": "string",
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-tags": [
"Application"
]
}
CsrMetadata
{
"properties": {
"subject": {
"$ref": "#/components/schemas/CsrMetadataSubject"
},
"subjectAltNames": {
"$ref": "#/components/schemas/CsrMetadataSubjectAltNames"
}
},
"x-okta-tags": [
"Application"
]
}
CsrMetadataSubject
{
"properties": {
"commonName": {
"type": "string"
},
"countryName": {
"type": "string"
},
"localityName": {
"type": "string"
},
"organizationName": {
"type": "string"
},
"stateOrProvinceName": {
"type": "string"
},
"organizationalUnitName": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
CsrMetadataSubjectAltNames
{
"properties": {
"dnsNames": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Application"
]
}
CustomHotpUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/CustomHotpUserFactorProfile"
},
"factorProfileId": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
CustomHotpUserFactorProfile
{
"properties": {
"sharedSecret": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
DNSRecord
{
"properties": {
"fqdn": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"expiration": {
"type": "string"
},
"recordType": {
"$ref": "#/components/schemas/DNSRecordType"
}
},
"x-okta-tags": [
"Domain"
]
}
DNSRecordType
{
"enum": [
"TXT",
"CNAME"
],
"type": "string",
"x-okta-tags": [
"Domain"
]
}
DeviceAccessPolicyRuleCondition
{
"properties": {
"managed": {
"type": "boolean"
},
"registered": {
"type": "boolean"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/DevicePolicyRuleCondition"
}
DevicePolicyRuleCondition
{
"type": "object",
"properties": {
"rooted": {
"type": "boolean"
},
"migrated": {
"type": "boolean"
},
"platform": {
"$ref": "#/components/schemas/DevicePolicyRuleConditionPlatform"
},
"trustLevel": {
"enum": [
"ANY",
"TRUSTED"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
DevicePolicyRuleConditionPlatform
{
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"enum": [
"IOS",
"ANDROID",
"OSX",
"WINDOWS"
],
"type": "string"
}
},
"supportedMDMFrameworks": {
"type": "array",
"items": {
"enum": [
"AFW",
"SAFE",
"NATIVE"
],
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
Domain
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"domain": {
"type": "string"
},
"dnsRecords": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DNSRecord"
}
},
"validationStatus": {
"$ref": "#/components/schemas/DomainValidationStatus"
},
"publicCertificate": {
"$ref": "#/components/schemas/DomainCertificateMetadata"
},
"certificateSourceType": {
"$ref": "#/components/schemas/DomainCertificateSourceType"
}
},
"x-okta-tags": [
"Domain"
]
}
DomainCertificate
{
"properties": {
"type": {
"$ref": "#/components/schemas/DomainCertificateType"
},
"privateKey": {
"type": "string"
},
"certificate": {
"type": "string"
},
"certificateChain": {
"type": "string"
}
},
"x-okta-tags": [
"Domain"
],
"x-okta-operations": [
{
"alias": "createCertificate",
"arguments": [
{
"dest": "certificate",
"self": true
}
],
"operationId": "createCertificate"
}
]
}
DomainCertificateMetadata
{
"properties": {
"subject": {
"type": "string"
},
"expiration": {
"type": "string"
},
"fingerprint": {
"type": "string"
}
},
"x-okta-tags": [
"Domain"
]
}
DomainCertificateSourceType
{
"enum": [
"MANUAL",
"OKTA_MANAGED"
],
"type": "string",
"x-okta-tags": [
"Domain"
]
}
DomainCertificateType
{
"enum": [
"PEM"
],
"type": "string",
"x-okta-tags": [
"Domain"
]
}
DomainListResponse
{
"properties": {
"domains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Domain"
}
}
},
"x-okta-tags": [
"Domain"
]
}
DomainValidationStatus
{
"enum": [
"NOT_STARTED",
"IN_PROGRESS",
"VERIFIED",
"FAILED_TO_VERIFY",
"DOMAIN_TAKEN",
"COMPLETED"
],
"type": "string",
"x-okta-tags": [
"Domain"
]
}
Duration
{
"type": "object",
"properties": {
"unit": {
"type": "string"
},
"number": {
"type": "integer"
}
},
"x-okta-tags": [
"Policy"
]
}
EmailTemplate
{
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
}
},
"x-okta-crud": [
{
"alias": "read",
"operationId": "getEmailTemplate"
}
],
"x-okta-tags": [
"Brands"
],
"x-okta-operations": [
{
"alias": "getEmailTemplate",
"operationId": "getEmailTemplate"
},
{
"alias": "deleteEmailTemplateCustomizations",
"operationId": "deleteEmailTemplateCustomizations"
},
{
"alias": "listEmailTemplateCustomizations",
"operationId": "listEmailTemplateCustomizations"
},
{
"alias": "createEmailTemplateCustomization",
"operationId": "createEmailTemplateCustomization"
},
{
"alias": "deleteEmailTemplateCustomization",
"operationId": "deleteEmailTemplateCustomization"
},
{
"alias": "getEmailTemplateCustomization",
"operationId": "getEmailTemplateCustomization"
},
{
"alias": "updateEmailTemplateCustomization",
"operationId": "updateEmailTemplateCustomization"
},
{
"alias": "getEmailTemplateCustomizationPreview",
"operationId": "getEmailTemplateCustomizationPreview"
},
{
"alias": "getEmailTemplateDefaultContent",
"operationId": "getEmailTemplateDefaultContent"
},
{
"alias": "getEmailTemplateDefaultContentPreview",
"operationId": "getEmailTemplateDefaultContentPreview"
},
{
"alias": "sendTestEmail",
"operationId": "sendTestEmail"
}
]
}
EmailTemplateContent
{
"properties": {
"body": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"subject": {
"type": "string"
},
"fromName": {
"type": "string"
},
"fromAddress": {
"type": "string"
}
},
"x-okta-tags": [
"Brands"
]
}
EmailTemplateCustomization
{
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"body": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"subject": {
"type": "string"
},
"language": {
"type": "string",
"description": "unique under each email template"
},
"isDefault": {
"type": "boolean"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-tags": [
"Brands"
]
}
EmailTemplateCustomizationRequest
{
"properties": {
"body": {
"type": "string"
},
"subject": {
"type": "string"
},
"language": {
"type": "string",
"description": "unique under each email template"
},
"isDefault": {
"type": "boolean"
}
},
"x-okta-tags": [
"Brands"
]
}
EmailTemplateTestRequest
{
"properties": {
"customizationId": {
"type": "string"
}
},
"x-okta-tags": [
"Brands"
]
}
EmailTemplateTouchPointVariant
{
"enum": [
"OKTA_DEFAULT",
"FULL_THEME"
],
"type": "string",
"x-okta-tags": [
"Brand"
]
}
EmailUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/EmailUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
EmailUserFactorProfile
{
"properties": {
"email": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
EnabledStatus
{
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string",
"x-okta-tags": [
"Common"
]
}
EndUserDashboardTouchPointVariant
{
"enum": [
"OKTA_DEFAULT",
"WHITE_LOGO_BACKGROUND",
"FULL_THEME",
"LOGO_ON_FULL_WHITE_BACKGROUND"
],
"type": "string",
"x-okta-tags": [
"Brand"
]
}
ErrorPageTouchPointVariant
{
"enum": [
"OKTA_DEFAULT",
"BACKGROUND_SECONDARY_COLOR",
"BACKGROUND_IMAGE"
],
"type": "string",
"x-okta-tags": [
"Brand"
]
}
EventHook
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"events": {
"$ref": "#/components/schemas/EventSubscriptions"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/EventHookChannel"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"createdBy": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"verificationStatus": {
"enum": [
"UNVERIFIED",
"VERIFIED"
],
"type": "string"
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "eventHook",
"self": true
}
],
"operationId": "createEventHook"
},
{
"alias": "read",
"arguments": [],
"operationId": "getEventHook"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "eventHookId"
},
{
"dest": "eventHook",
"self": true
}
],
"operationId": "updateEventHook"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "eventHookId"
}
],
"operationId": "deleteEventHook"
}
],
"x-okta-tags": [
"EventHook"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "eventHookId"
}
],
"operationId": "activateEventHook"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "eventHookId"
}
],
"operationId": "deactivateEventHook"
},
{
"alias": "verify",
"arguments": [
{
"src": "id",
"dest": "eventHookId"
}
],
"operationId": "verifyEventHook"
}
]
}
EventHookChannel
{
"type": "object",
"properties": {
"type": {
"enum": [
"HTTP"
],
"type": "string",
"readOnly": false
},
"config": {
"$ref": "#/components/schemas/EventHookChannelConfig"
},
"version": {
"type": "string",
"readOnly": false
}
},
"x-okta-tags": [
"EventHook"
]
}
EventHookChannelConfig
{
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"headers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventHookChannelConfigHeader"
}
},
"authScheme": {
"$ref": "#/components/schemas/EventHookChannelConfigAuthScheme"
}
},
"x-okta-tags": [
"EventHook"
]
}
EventHookChannelConfigAuthScheme
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/EventHookChannelConfigAuthSchemeType"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"EventHook"
]
}
EventHookChannelConfigAuthSchemeType
{
"enum": [
"HEADER"
],
"type": "string",
"x-okta-tags": [
"EventHook"
]
}
EventHookChannelConfigHeader
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"EventHook"
]
}
EventHookListSuccessEventsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EventHook"
}
}
EventSubscriptions
{
"type": "object",
"properties": {
"type": {
"enum": [
"EVENT_TYPE",
"FLOW_EVENT"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"EventHook"
],
"discriminator": {
"propertyName": "type"
}
}
FactorProvider
{
"enum": [
"OKTA",
"RSA",
"FIDO",
"GOOGLE",
"SYMANTEC",
"DUO",
"YUBICO",
"CUSTOM",
"APPLE"
],
"type": "string",
"x-okta-tags": [
"UserFactor"
]
}
FactorResultType
{
"enum": [
"SUCCESS",
"CHALLENGE",
"WAITING",
"FAILED",
"REJECTED",
"TIMEOUT",
"TIME_WINDOW_EXCEEDED",
"PASSCODE_REPLAYED",
"ERROR",
"CANCELLED"
],
"type": "string",
"x-okta-tags": [
"UserFactor"
]
}
FactorStatus
{
"enum": [
"PENDING_ACTIVATION",
"ACTIVE",
"INACTIVE",
"NOT_SETUP",
"ENROLLED",
"DISABLED",
"EXPIRED"
],
"type": "string",
"x-okta-tags": [
"UserFactor"
]
}
FactorType
{
"enum": [
"call",
"email",
"hotp",
"push",
"question",
"signed_nonce",
"sms",
"token:hardware",
"token:hotp",
"token:software:totp",
"token",
"u2f",
"web",
"webauthn"
],
"type": "string",
"x-okta-tags": [
"UserFactor"
]
}
Feature
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FeatureType"
},
"stage": {
"$ref": "#/components/schemas/FeatureStage"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/EnabledStatus"
},
"description": {
"type": "string"
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [],
"operationId": "getFeature"
}
],
"x-okta-tags": [
"Feature"
],
"x-okta-operations": [
{
"alias": "updateLifecycle",
"arguments": [
{
"src": "id",
"dest": "featureId"
}
],
"operationId": "updateFeatureLifecycle"
},
{
"alias": "getDependents",
"arguments": [
{
"src": "id",
"dest": "featureId"
}
],
"operationId": "listFeatureDependents"
},
{
"alias": "getDependencies",
"arguments": [
{
"src": "id",
"dest": "featureId"
}
],
"operationId": "listFeatureDependencies"
}
]
}
FeatureGetSuccessResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Feature"
}
}
FeatureListDependenciesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Feature"
}
}
FeatureListDependentsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Feature"
}
}
FeatureStage
{
"type": "object",
"properties": {
"state": {
"$ref": "#/components/schemas/FeatureStageState"
},
"value": {
"$ref": "#/components/schemas/FeatureStageValue"
}
},
"x-okta-tags": [
"Feature"
]
}
FeatureStageState
{
"enum": [
"OPEN",
"CLOSED"
],
"type": "string",
"x-okta-tags": [
"Feature"
]
}
FeatureStageValue
{
"enum": [
"EA",
"BETA"
],
"type": "string",
"x-okta-tags": [
"Feature"
]
}
FeatureType
{
"enum": [
"self-service"
],
"type": "string",
"x-okta-tags": [
"Feature"
]
}
FipsEnum
{
"enum": [
"REQUIRED",
"OPTIONAL"
],
"type": "string",
"x-okta-tags": [
"Authenticator"
]
}
ForgotPasswordResponse
{
"properties": {
"resetPasswordUrl": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"User"
]
}
GrantTypePolicyRuleCondition
{
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
Group
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"$ref": "#/components/schemas/GroupType"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"profile": {
"$ref": "#/components/schemas/GroupProfile"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"objectClass": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"lastMembershipUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "groupId"
},
{
"dest": "group",
"self": true
}
],
"operationId": "updateGroup"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "groupId"
}
],
"operationId": "deleteGroup"
}
],
"x-okta-tags": [
"Group"
],
"x-okta-operations": [
{
"alias": "removeUser",
"arguments": [
{
"src": "id",
"dest": "groupId"
}
],
"operationId": "removeUserFromGroup"
},
{
"alias": "listUsers",
"arguments": [
{
"src": "id",
"dest": "groupId"
}
],
"operationId": "listGroupUsers"
},
{
"alias": "listApplications",
"arguments": [
{
"src": "id",
"dest": "groupId"
}
],
"operationId": "listAssignedApplicationsForGroup"
},
{
"alias": "assignRole",
"arguments": [
{
"src": "id",
"dest": "groupId"
}
],
"operationId": "assignRoleToGroup"
}
]
}
GroupCondition
{
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
GroupEnumerateGroupMembersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
GroupGetAllRulesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupRule"
}
}
GroupGetRoleListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
GroupGetRoleTargetsCatalogAppsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CatalogApplication"
}
}
GroupListAssignedAppsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Application"
}
}
GroupListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
GroupListRoleTargetsGroupsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
GroupPolicyRuleCondition
{
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
GroupProfile
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
},
"x-okta-tags": [
"Group"
],
"x-okta-extensible": true
}
GroupRule
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/GroupRuleStatus"
},
"actions": {
"$ref": "#/components/schemas/GroupRuleAction"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"conditions": {
"$ref": "#/components/schemas/GroupRuleConditions"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "groupRule",
"self": true
}
],
"operationId": "updateGroupRule"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "ruleId"
}
],
"operationId": "deleteGroupRule"
}
],
"x-okta-tags": [
"GroupRule"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "ruleId"
}
],
"operationId": "activateGroupRule"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "ruleId"
}
],
"operationId": "deactivateGroupRule"
}
]
}
GroupRuleAction
{
"type": "object",
"properties": {
"assignUserToGroups": {
"$ref": "#/components/schemas/GroupRuleGroupAssignment"
}
},
"x-okta-tags": [
"GroupRule"
]
}
GroupRuleConditions
{
"type": "object",
"properties": {
"people": {
"$ref": "#/components/schemas/GroupRulePeopleCondition"
},
"expression": {
"$ref": "#/components/schemas/GroupRuleExpression"
}
},
"x-okta-tags": [
"GroupRule"
]
}
GroupRuleExpression
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"GroupRule"
]
}
GroupRuleGroupAssignment
{
"type": "object",
"properties": {
"groupIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"GroupRule"
]
}
GroupRuleGroupCondition
{
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"GroupRule"
]
}
GroupRulePeopleCondition
{
"type": "object",
"properties": {
"users": {
"$ref": "#/components/schemas/GroupRuleUserCondition"
},
"groups": {
"$ref": "#/components/schemas/GroupRuleGroupCondition"
}
},
"x-okta-tags": [
"GroupRule"
]
}
GroupRuleStatus
{
"enum": [
"ACTIVE",
"INACTIVE",
"INVALID"
],
"type": "string",
"x-okta-tags": [
"GroupRule"
]
}
GroupRuleUserCondition
{
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"GroupRule"
]
}
GroupSchema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
},
"title": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"$schema": {
"type": "string",
"readOnly": true
},
"created": {
"type": "string",
"readOnly": true
},
"properties": {
"$ref": "#/components/schemas/UserSchemaProperties"
},
"definitions": {
"$ref": "#/components/schemas/GroupSchemaDefinitions"
},
"description": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"GroupSchema"
]
}
GroupSchemaAttribute
{
"type": "object",
"properties": {
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"$ref": "#/components/schemas/UserSchemaAttributeType"
},
"items": {
"$ref": "#/components/schemas/UserSchemaAttributeItems"
},
"oneOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSchemaAttributeEnum"
}
},
"scope": {
"$ref": "#/components/schemas/UserSchemaAttributeScope"
},
"title": {
"type": "string"
},
"union": {
"$ref": "#/components/schemas/UserSchemaAttributeUnion"
},
"master": {
"$ref": "#/components/schemas/UserSchemaAttributeMaster"
},
"unique": {
"type": "string"
},
"required": {
"type": "boolean"
},
"maxLength": {
"type": "integer"
},
"minLength": {
"type": "integer"
},
"mutability": {
"type": "string"
},
"description": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSchemaAttributePermission"
}
},
"externalName": {
"type": "string"
},
"externalNamespace": {
"type": "string"
}
},
"x-okta-tags": [
"GroupSchema"
]
}
GroupSchemaBase
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string"
},
"required": {
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"$ref": "#/components/schemas/GroupSchemaBaseProperties"
}
},
"x-okta-tags": [
"GroupSchema"
]
}
GroupSchemaBaseProperties
{
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/GroupSchemaAttribute"
},
"description": {
"$ref": "#/components/schemas/GroupSchemaAttribute"
}
},
"x-okta-tags": [
"GroupSchema"
]
}
GroupSchemaCustom
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string"
},
"required": {
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/GroupSchemaAttribute"
}
}
},
"x-okta-tags": [
"GroupSchema"
]
}
GroupSchemaDefinitions
{
"type": "object",
"properties": {
"base": {
"$ref": "#/components/schemas/GroupSchemaBase"
},
"custom": {
"$ref": "#/components/schemas/GroupSchemaCustom"
}
},
"x-okta-tags": [
"GroupSchema"
]
}
GroupType
{
"enum": [
"OKTA_GROUP",
"APP_GROUP",
"BUILT_IN"
],
"type": "string",
"x-okta-tags": [
"Group"
]
}
HardwareUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/HardwareUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
HardwareUserFactorProfile
{
"properties": {
"credentialId": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
IdentityProvider
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"enum": [
"SAML2",
"GOOGLE",
"FACEBOOK",
"LINKEDIN",
"MICROSOFT",
"OIDC",
"OKTA",
"IWA",
"AgentlessDSSO",
"X509"
],
"type": "string",
"x-okta-known-values": [
"SAML2",
"GOOGLE",
"FACEBOOK",
"LINKEDIN",
"MICROSOFT",
"OIDC",
"OKTA",
"IWA",
"AgentlessDSSO",
"X509"
]
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"policy": {
"$ref": "#/components/schemas/IdentityProviderPolicy"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"protocol": {
"$ref": "#/components/schemas/Protocol"
},
"issuerMode": {
"enum": [
"ORG_URL",
"CUSTOM_URL",
"DYNAMIC"
],
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "idpTrust",
"self": true
}
],
"operationId": "createIdentityProvider"
},
{
"alias": "read",
"arguments": [],
"operationId": "getIdentityProvider"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "idpId"
},
{
"dest": "idpTrust",
"self": true
}
],
"operationId": "updateIdentityProvider"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "deleteIdentityProvider"
}
],
"x-okta-tags": [
"IdentityProvider"
],
"x-okta-operations": [
{
"alias": "listSigningCsrs",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "listCsrsForIdentityProvider"
},
{
"alias": "generateCsr",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "generateCsrForIdentityProvider"
},
{
"alias": "deleteSigningCsr",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "revokeCsrForIdentityProvider"
},
{
"alias": "getSigningCsr",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "getCsrForIdentityProvider"
},
{
"alias": "listSigningKeys",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "listIdentityProviderSigningKeys"
},
{
"alias": "generateSigningKey",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "generateIdentityProviderSigningKey"
},
{
"alias": "getSigningKey",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "getIdentityProviderSigningKey"
},
{
"alias": "cloneKey",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "cloneIdentityProviderKey"
},
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "activateIdentityProvider"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "deactivateIdentityProvider"
},
{
"alias": "listUsers",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "listIdentityProviderApplicationUsers"
},
{
"alias": "unlinkUser",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "unlinkUserFromIdentityProvider"
},
{
"alias": "getUser",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "getIdentityProviderApplicationUser"
},
{
"alias": "linkUser",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "linkUserToIdentityProvider"
},
{
"alias": "listSocialAuthTokens",
"arguments": [
{
"src": "id",
"dest": "idpId"
}
],
"operationId": "listSocialAuthTokens"
}
]
}
IdentityProviderApplicationUser
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"created": {
"type": "string"
},
"profile": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"externalId": {
"type": "string"
},
"lastUpdated": {
"type": "string"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
IdentityProviderCredentials
{
"type": "object",
"properties": {
"trust": {
"$ref": "#/components/schemas/IdentityProviderCredentialsTrust"
},
"client": {
"$ref": "#/components/schemas/IdentityProviderCredentialsClient"
},
"signing": {
"$ref": "#/components/schemas/IdentityProviderCredentialsSigning"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
IdentityProviderCredentialsClient
{
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
IdentityProviderCredentialsSigning
{
"type": "object",
"properties": {
"kid": {
"type": "string"
},
"teamId": {
"type": "string"
},
"privateKey": {
"type": "string"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
IdentityProviderCredentialsTrust
{
"type": "object",
"properties": {
"kid": {
"type": "string"
},
"issuer": {
"type": "string"
},
"audience": {
"type": "string"
},
"revocation": {
"enum": [
"CRL",
"DELTA_CRL",
"OCSP"
],
"type": "string"
},
"revocationCacheLifetime": {
"type": "integer"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
IdentityProviderEnumerateIdpKeysResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKey"
}
}
IdentityProviderGetSocialAuthTokensResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SocialAuthToken"
}
}
IdentityProviderGetUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityProviderApplicationUser"
}
}
IdentityProviderListCsrsForCertificateSigningRequestsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Csr"
}
}
IdentityProviderListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityProvider"
}
}
IdentityProviderListSigningKeyCredentialsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKey"
}
}
IdentityProviderPolicy
{
"type": "object",
"properties": {
"subject": {
"$ref": "#/components/schemas/PolicySubject"
},
"accountLink": {
"$ref": "#/components/schemas/PolicyAccountLink"
},
"maxClockSkew": {
"type": "integer"
},
"provisioning": {
"$ref": "#/components/schemas/Provisioning"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
IdentityProviderPolicyRuleCondition
{
"type": "object",
"properties": {
"idpIds": {
"type": "array",
"items": {
"type": "string"
}
},
"provider": {
"enum": [
"ANY",
"OKTA",
"SPECIFIC_IDP"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
IdpPolicyRuleAction
{
"type": "object",
"properties": {
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdpPolicyRuleActionProvider"
}
}
},
"x-okta-tags": [
"Policy"
]
}
IdpPolicyRuleActionProvider
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
IframeEmbedScopeAllowedApps
{
"enum": [
"OKTA_ENDUSER"
],
"type": "string",
"x-okta-tags": [
"Role"
]
}
ImageUploadResponse
{
"properties": {
"url": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Brand"
]
}
InactivityPolicyRuleCondition
{
"type": "object",
"properties": {
"unit": {
"type": "string"
},
"number": {
"type": "integer"
}
},
"x-okta-tags": [
"Policy"
]
}
InlineHook
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/InlineHookType"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/InlineHookStatus"
},
"channel": {
"$ref": "#/components/schemas/InlineHookChannel"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"version": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "inlineHook",
"self": true
}
],
"operationId": "createInlineHook"
},
{
"alias": "read",
"arguments": [],
"operationId": "getInlineHook"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "inlineHookId"
},
{
"dest": "inlineHook",
"self": true
}
],
"operationId": "updateInlineHook"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "inlineHookId"
}
],
"operationId": "deleteInlineHook"
}
],
"x-okta-tags": [
"InlineHook"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "inlineHookId"
}
],
"operationId": "activateInlineHook"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "inlineHookId"
}
],
"operationId": "deactivateInlineHook"
},
{
"alias": "execute",
"arguments": [
{
"src": "id",
"dest": "inlineHookId"
}
],
"operationId": "executeInlineHook"
}
]
}
InlineHookChannel
{
"type": "object",
"properties": {
"type": {
"enum": [
"HTTP"
],
"type": "string",
"readOnly": false
},
"config": {
"$ref": "#/components/schemas/InlineHookChannelConfig"
},
"version": {
"type": "string",
"readOnly": false
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookChannelConfig
{
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"method": {
"type": "string"
},
"headers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InlineHookChannelConfigHeaders"
}
},
"authScheme": {
"$ref": "#/components/schemas/InlineHookChannelConfigAuthScheme"
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookChannelConfigAuthScheme
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookChannelConfigHeaders
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookGetSuccessResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InlineHook"
}
}
InlineHookPayload
{
"type": "object",
"x-okta-tags": [
"InlineHook"
],
"x-okta-extensible": true
}
InlineHookResponse
{
"type": "object",
"properties": {
"commands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InlineHookResponseCommands"
}
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookResponseCommandValue
{
"properties": {
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookResponseCommands
{
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InlineHookResponseCommandValue"
}
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookStatus
{
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"x-okta-tags": [
"InlineHook"
]
}
InlineHookType
{
"enum": [
"com.okta.oauth2.tokens.transform",
"com.okta.import.transform",
"com.okta.saml.tokens.transform",
"com.okta.user.pre-registration",
"com.okta.user.credential.password.import"
],
"type": "string",
"x-okta-tags": [
"InlineHook"
]
}
IonField
{
"type": "object",
"properties": {
"form": {
"$ref": "#/components/schemas/IonForm"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"secret": {
"type": "boolean"
},
"mutable": {
"type": "boolean"
},
"visible": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"x-okta-tags": [
"Ion"
]
}
IonForm
{
"type": "object",
"properties": {
"rel": {
"type": "array",
"items": {
"type": "string"
}
},
"href": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IonField"
},
"readOnly": true
},
"method": {
"type": "string"
},
"accepts": {
"type": "string"
},
"refresh": {
"type": "integer"
},
"produces": {
"type": "string"
},
"relatesTo": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Ion"
]
}
JsonWebKey
{
"type": "object",
"properties": {
"e": {
"type": "string",
"readOnly": false
},
"n": {
"type": "string",
"readOnly": false
},
"alg": {
"type": "string",
"readOnly": false
},
"kid": {
"type": "string",
"readOnly": false
},
"kty": {
"type": "string",
"readOnly": false
},
"use": {
"type": "string",
"readOnly": false
},
"x5c": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": false
},
"x5t": {
"type": "string",
"readOnly": false
},
"x5u": {
"type": "string",
"readOnly": false
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string",
"readOnly": false
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": false
},
"key_ops": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": false
},
"x5t#S256": {
"type": "string",
"readOnly": false
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": false
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": false
}
},
"x-okta-tags": [
"Application"
]
}
JwkUse
{
"properties": {
"use": {
"enum": [
"sig"
],
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
KnowledgeConstraint
{
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/AccessPolicyConstraint"
}
LifecycleCreateSettingObject
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/EnabledStatus"
}
},
"x-okta-tags": [
"Application"
]
}
LifecycleDeactivateSettingObject
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/EnabledStatus"
}
},
"x-okta-tags": [
"Application"
]
}
LifecycleExpirationPolicyRuleCondition
{
"type": "object",
"properties": {
"unit": {
"type": "string"
},
"number": {
"type": "integer"
},
"lifecycleStatus": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
LinkedObject
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"primary": {
"$ref": "#/components/schemas/LinkedObjectDetails"
},
"associated": {
"$ref": "#/components/schemas/LinkedObjectDetails"
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "linkedObjectDefinition",
"self": true
}
],
"operationId": "addLinkedObjectDefinition"
},
{
"alias": "read",
"arguments": [],
"operationId": "getLinkedObjectDefinition"
},
{
"alias": "delete",
"arguments": [
{
"dest": "linkedObjectName",
"self": true
}
],
"operationId": "deleteLinkedObjectDefinition"
}
],
"x-okta-tags": [
"LinkedObject"
]
}
LinkedObjectDetails
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/LinkedObjectDetailsType"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"x-okta-tags": [
"LinkedObject"
]
}
LinkedObjectDetailsType
{
"enum": [
"USER"
],
"type": "string",
"x-okta-tags": [
"LinkedObject"
]
}
LinkedObjectGetUserLinkedObjectsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkedObject"
}
}
LogActor
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
},
"detail": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"alternateId": {
"type": "string",
"readOnly": true
},
"displayName": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogAuthenticationContext
{
"type": "object",
"properties": {
"issuer": {
"$ref": "#/components/schemas/LogIssuer"
},
"interface": {
"type": "string",
"readOnly": true
},
"credentialType": {
"$ref": "#/components/schemas/LogCredentialType"
},
"externalSessionId": {
"type": "string",
"readOnly": true
},
"authenticationStep": {
"type": "integer",
"readOnly": true
},
"credentialProvider": {
"$ref": "#/components/schemas/LogCredentialProvider"
},
"authenticationProvider": {
"$ref": "#/components/schemas/LogAuthenticationProvider"
}
},
"x-okta-tags": [
"Log"
]
}
LogAuthenticationProvider
{
"enum": [
"OKTA_AUTHENTICATION_PROVIDER",
"ACTIVE_DIRECTORY",
"LDAP",
"FEDERATION",
"SOCIAL",
"FACTOR_PROVIDER"
],
"type": "string",
"x-okta-tags": [
"Log"
]
}
LogClient
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"zone": {
"type": "string",
"readOnly": true
},
"device": {
"type": "string",
"readOnly": true
},
"ipAddress": {
"type": "string",
"readOnly": true
},
"userAgent": {
"$ref": "#/components/schemas/LogUserAgent"
},
"geographicalContext": {
"$ref": "#/components/schemas/LogGeographicalContext"
}
},
"x-okta-tags": [
"Log"
]
}
LogCredentialProvider
{
"enum": [
"OKTA_AUTHENTICATION_PROVIDER",
"OKTA_CREDENTIAL_PROVIDER",
"RSA",
"SYMANTEC",
"GOOGLE",
"DUO",
"YUBIKEY",
"APPLE"
],
"type": "string",
"x-okta-tags": [
"Log"
]
}
LogCredentialType
{
"enum": [
"OTP",
"SMS",
"PASSWORD",
"ASSERTION",
"IWA",
"EMAIL",
"OAUTH2",
"JWT"
],
"type": "string",
"x-okta-tags": [
"Log"
]
}
LogDebugContext
{
"type": "object",
"properties": {
"debugData": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
}
},
"x-okta-tags": [
"Log"
]
}
LogEvent
{
"type": "object",
"properties": {
"uuid": {
"type": "string",
"readOnly": true
},
"actor": {
"$ref": "#/components/schemas/LogActor"
},
"client": {
"$ref": "#/components/schemas/LogClient"
},
"target": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogTarget"
},
"readOnly": true
},
"outcome": {
"$ref": "#/components/schemas/LogOutcome"
},
"request": {
"$ref": "#/components/schemas/LogRequest"
},
"version": {
"type": "string",
"readOnly": true
},
"severity": {
"$ref": "#/components/schemas/LogSeverity"
},
"eventType": {
"type": "string",
"readOnly": true
},
"published": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"transaction": {
"$ref": "#/components/schemas/LogTransaction"
},
"debugContext": {
"$ref": "#/components/schemas/LogDebugContext"
},
"displayMessage": {
"type": "string",
"readOnly": true
},
"legacyEventType": {
"type": "string",
"readOnly": true
},
"securityContext": {
"$ref": "#/components/schemas/LogSecurityContext"
},
"authenticationContext": {
"$ref": "#/components/schemas/LogAuthenticationContext"
}
},
"x-okta-tags": [
"Log"
]
}
LogGeographicalContext
{
"type": "object",
"properties": {
"city": {
"type": "string",
"readOnly": true
},
"state": {
"type": "string",
"readOnly": true
},
"country": {
"type": "string",
"readOnly": true
},
"postalCode": {
"type": "string",
"readOnly": true
},
"geolocation": {
"$ref": "#/components/schemas/LogGeolocation"
}
},
"x-okta-tags": [
"Log"
]
}
LogGeolocation
{
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"readOnly": true
},
"lon": {
"type": "number",
"format": "double",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogGetListEventsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/LogEvent"
}
}
LogIpAddress
{
"type": "object",
"properties": {
"ip": {
"type": "string",
"readOnly": true
},
"source": {
"type": "string",
"readOnly": true
},
"version": {
"type": "string",
"readOnly": true
},
"geographicalContext": {
"$ref": "#/components/schemas/LogGeographicalContext"
}
},
"x-okta-tags": [
"Log"
]
}
LogIssuer
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogOutcome
{
"type": "object",
"properties": {
"reason": {
"type": "string",
"readOnly": true
},
"result": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogRequest
{
"type": "object",
"properties": {
"ipChain": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogIpAddress"
},
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogSecurityContext
{
"type": "object",
"properties": {
"isp": {
"type": "string",
"readOnly": true
},
"asOrg": {
"type": "string",
"readOnly": true
},
"domain": {
"type": "string",
"readOnly": true
},
"isProxy": {
"type": "boolean",
"readOnly": true
},
"asNumber": {
"type": "integer",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogSeverity
{
"enum": [
"DEBUG",
"INFO",
"WARN",
"ERROR"
],
"type": "string",
"x-okta-tags": [
"Log"
]
}
LogTarget
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
},
"alternateId": {
"type": "string",
"readOnly": true
},
"detailEntry": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"displayName": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogTransaction
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
},
"detail": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
}
},
"x-okta-tags": [
"Log"
]
}
LogUserAgent
{
"type": "object",
"properties": {
"os": {
"type": "string",
"readOnly": true
},
"browser": {
"type": "string",
"readOnly": true
},
"rawUserAgent": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
MDMEnrollmentPolicyRuleCondition
{
"type": "object",
"properties": {
"enrollment": {
"enum": [
"OMM",
"ANY_OR_NONE"
],
"type": "string"
},
"blockNonSafeAndroid": {
"type": "boolean"
}
},
"x-okta-tags": [
"Policy"
]
}
MultifactorEnrollmentPolicy
{
"allOf": [
{
"$ref": "#/components/schemas/Policy"
},
{
"type": "object",
"properties": {
"settings": {
"$ref": "#/components/schemas/MultifactorEnrollmentPolicySettings"
},
"conditions": {
"$ref": "#/components/schemas/PolicyRuleConditions"
}
}
}
],
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
MultifactorEnrollmentPolicyAuthenticatorSettings
{
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/MultifactorEnrollmentPolicyAuthenticatorType"
},
"enroll": {
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/MultifactorEnrollmentPolicyAuthenticatorStatus"
}
}
},
"constraints": {
"type": "object",
"minimum": 0,
"properties": {
"aaguidGroups": {
"type": "array",
"items": {
"type": "string",
"uniqueItems": true
}
}
},
"x-okta-lifecycle": {
"features": [
"WEBAUTHN_MDS_CATALOG_BASED_AAGUID_ALLOWLIST"
]
}
}
},
"x-okta-tags": [
"Policy"
]
}
MultifactorEnrollmentPolicyAuthenticatorStatus
{
"enum": [
"NOT_ALLOWED",
"OPTIONAL",
"REQUIRED"
],
"type": "string",
"x-okta-tags": [
"Policy"
]
}
MultifactorEnrollmentPolicyAuthenticatorType
{
"enum": [
"custom_app",
"custom_otp",
"duo",
"external_idp",
"google_otp",
"okta_email",
"okta_password",
"okta_verify",
"onprem_mfa",
"phone_number",
"rsa_token",
"security_question",
"symantec_vip",
"webauthn",
"yubikey_token"
],
"type": "string",
"x-okta-tags": [
"Policy"
]
}
MultifactorEnrollmentPolicySettings
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/MultifactorEnrollmentPolicySettingsType"
},
"authenticators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultifactorEnrollmentPolicyAuthenticatorSettings"
}
}
},
"x-okta-tags": [
"Policy"
]
}
MultifactorEnrollmentPolicySettingsType
{
"enum": [
"AUTHENTICATORS"
],
"type": "string",
"x-okta-tags": [
"Policy"
]
}
NetworkZone
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"asns": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/NetworkZoneType"
},
"usage": {
"$ref": "#/components/schemas/NetworkZoneUsage"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/NetworkZoneStatus"
},
"system": {
"type": "boolean"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"proxies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkZoneAddress"
}
},
"gateways": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkZoneAddress"
}
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkZoneLocation"
}
},
"proxyType": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"src": "id",
"dest": "zoneId"
}
],
"operationId": "getNetworkZone"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "zoneId"
},
{
"dest": "zone",
"self": true
}
],
"operationId": "updateNetworkZone"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "zoneId"
}
],
"operationId": "deleteNetworkZone"
}
],
"x-okta-tags": [
"NetworkZone"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "zoneId"
}
],
"operationId": "activateNetworkZone"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "zoneId"
}
],
"operationId": "deactivateNetworkZone"
}
]
}
NetworkZoneAddress
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/NetworkZoneAddressType"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"NetworkZone"
]
}
NetworkZoneAddressType
{
"enum": [
"CIDR",
"RANGE"
],
"type": "string",
"x-okta-tags": [
"NetworkZone"
]
}
NetworkZoneListZonesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkZone"
}
}
NetworkZoneLocation
{
"type": "object",
"properties": {
"region": {
"type": "string"
},
"country": {
"type": "string"
}
},
"x-okta-tags": [
"NetworkZone"
]
}
NetworkZoneStatus
{
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"x-okta-tags": [
"NetworkZone"
]
}
NetworkZoneType
{
"enum": [
"IP",
"DYNAMIC"
],
"type": "string",
"x-okta-tags": [
"NetworkZone"
]
}
NetworkZoneUsage
{
"enum": [
"POLICY",
"BLOCKLIST"
],
"type": "string",
"x-okta-tags": [
"NetworkZone"
]
}
NotificationType
{
"enum": [
"CONNECTOR_AGENT",
"USER_LOCKED_OUT",
"APP_IMPORT",
"LDAP_AGENT",
"AD_AGENT",
"OKTA_ANNOUNCEMENT",
"OKTA_ISSUE",
"OKTA_UPDATE",
"IWA_AGENT",
"USER_DEPROVISION",
"REPORT_SUSPICIOUS_ACTIVITY",
"RATELIMIT_NOTIFICATION"
],
"type": "string",
"x-okta-tags": [
"Subscription"
]
}
OAuth2Actor
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2Claim
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"system": {
"type": "boolean"
},
"claimType": {
"enum": [
"IDENTITY",
"RESOURCE"
],
"type": "string"
},
"valueType": {
"enum": [
"EXPRESSION",
"GROUPS",
"SYSTEM"
],
"type": "string"
},
"conditions": {
"$ref": "#/components/schemas/OAuth2ClaimConditions"
},
"group_filter_type": {
"enum": [
"STARTS_WITH",
"EQUALS",
"CONTAINS",
"REGEX"
],
"type": "string"
},
"alwaysIncludeInToken": {
"type": "boolean"
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2ClaimConditions
{
"type": "object",
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2Client
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"logo_uri": {
"type": "string",
"readOnly": true
},
"client_id": {
"type": "string",
"readOnly": true
},
"client_uri": {
"type": "string",
"readOnly": true
},
"client_name": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2RefreshToken
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"issuer": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"enum": [
"ACTIVE",
"REVOKED"
],
"type": "string"
},
"userId": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"clientId": {
"type": "string"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"createdBy": {
"$ref": "#/components/schemas/OAuth2Actor"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2Scope
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"system": {
"type": "boolean"
},
"consent": {
"enum": [
"REQUIRED",
"IMPLICIT",
"ADMIN"
],
"type": "string"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"metadataPublish": {
"enum": [
"ALL_CLIENTS",
"NO_CLIENTS"
],
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2ScopeConsentGrant
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"issuer": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/OAuth2ScopeConsentGrantSource"
},
"status": {
"$ref": "#/components/schemas/OAuth2ScopeConsentGrantStatus"
},
"userId": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"scopeId": {
"type": "string"
},
"clientId": {
"type": "string"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"createdBy": {
"$ref": "#/components/schemas/OAuth2Actor"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2ScopeConsentGrantSource
{
"enum": [
"END_USER",
"ADMIN"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OAuth2ScopeConsentGrantStatus
{
"enum": [
"ACTIVE",
"REVOKED"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OAuth2ScopesMediationPolicyRuleCondition
{
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2Token
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"issuer": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"enum": [
"ACTIVE",
"REVOKED"
],
"type": "string"
},
"userId": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"clientId": {
"type": "string"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-tags": [
"Application"
]
}
OAuthApplicationCredentials
{
"properties": {
"oauthClient": {
"$ref": "#/components/schemas/ApplicationCredentialsOAuthClient"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationCredentials"
}
OAuthAuthorizationPolicy
{
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
OAuthEndpointAuthenticationMethod
{
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"client_secret_jwt",
"private_key_jwt"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OAuthGrantType
{
"enum": [
"authorization_code",
"implicit",
"password",
"refresh_token",
"client_credentials",
"saml2_bearer",
"device_code",
"token_exchange",
"interaction_code"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OAuthResponseType
{
"enum": [
"code",
"token",
"id_token"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OktaSignOnPolicy
{
"type": "object",
"properties": {
"conditions": {
"$ref": "#/components/schemas/OktaSignOnPolicyConditions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
OktaSignOnPolicyConditions
{
"properties": {
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleConditions"
}
OktaSignOnPolicyRule
{
"properties": {
"name": {
"type": "string"
},
"actions": {
"$ref": "#/components/schemas/OktaSignOnPolicyRuleActions"
},
"conditions": {
"$ref": "#/components/schemas/OktaSignOnPolicyRuleConditions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRule"
}
OktaSignOnPolicyRuleActions
{
"properties": {
"signon": {
"$ref": "#/components/schemas/OktaSignOnPolicyRuleSignonActions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleActions"
}
OktaSignOnPolicyRuleConditions
{
"properties": {
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
},
"network": {
"$ref": "#/components/schemas/PolicyNetworkCondition"
},
"authContext": {
"$ref": "#/components/schemas/PolicyRuleAuthContextCondition"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleConditions"
}
OktaSignOnPolicyRuleSignonActions
{
"type": "object",
"properties": {
"access": {
"enum": [
"ALLOW",
"DENY"
],
"type": "string"
},
"session": {
"$ref": "#/components/schemas/OktaSignOnPolicyRuleSignonSessionActions"
},
"requireFactor": {
"type": "boolean",
"default": false
},
"factorLifetime": {
"type": "integer"
},
"factorPromptMode": {
"enum": [
"ALWAYS",
"DEVICE",
"SESSION"
],
"type": "string"
},
"rememberDeviceByDefault": {
"type": "boolean",
"default": false
}
},
"x-okta-tags": [
"Policy"
]
}
OktaSignOnPolicyRuleSignonSessionActions
{
"type": "object",
"properties": {
"usePersistentCookie": {
"type": "boolean",
"default": false
},
"maxSessionIdleMinutes": {
"type": "integer",
"default": 120
},
"maxSessionLifetimeMinutes": {
"type": "integer",
"default": 0
}
},
"x-okta-tags": [
"Policy"
]
}
OpenIdConnectApplication
{
"properties": {
"name": {
"default": "oidc_client"
},
"settings": {
"$ref": "#/components/schemas/OpenIdConnectApplicationSettings"
},
"credentials": {
"$ref": "#/components/schemas/OAuthApplicationCredentials"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-okta-defined-as": {
"name": "oidc_client"
}
}
OpenIdConnectApplicationConsentMethod
{
"enum": [
"REQUIRED",
"TRUSTED"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationIdpInitiatedLogin
{
"type": "object",
"properties": {
"mode": {
"type": "string"
},
"default_scope": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationIssuerMode
{
"enum": [
"CUSTOM_URL",
"ORG_URL",
"DYNAMIC"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationSettings
{
"properties": {
"oauthClient": {
"$ref": "#/components/schemas/OpenIdConnectApplicationSettingsClient"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
OpenIdConnectApplicationSettingsClient
{
"properties": {
"jwks": {
"$ref": "#/components/schemas/OpenIdConnectApplicationSettingsClientKeys"
},
"tos_uri": {
"type": "string"
},
"logo_uri": {
"type": "string"
},
"client_uri": {
"type": "string"
},
"policy_uri": {
"type": "string"
},
"grant_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthGrantType"
}
},
"issuer_mode": {
"$ref": "#/components/schemas/OpenIdConnectApplicationIssuerMode"
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"refresh_token": {
"$ref": "#/components/schemas/OpenIdConnectApplicationSettingsRefreshToken"
},
"consent_method": {
"$ref": "#/components/schemas/OpenIdConnectApplicationConsentMethod"
},
"response_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthResponseType"
}
},
"application_type": {
"$ref": "#/components/schemas/OpenIdConnectApplicationType"
},
"wildcard_redirect": {
"type": "string"
},
"initiate_login_uri": {
"type": "string"
},
"idp_initiated_login": {
"$ref": "#/components/schemas/OpenIdConnectApplicationIdpInitiatedLogin"
},
"post_logout_redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationSettingsClientKeys
{
"properties": {
"keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKey"
}
}
},
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationSettingsRefreshToken
{
"type": "object",
"properties": {
"leeway": {
"type": "integer"
},
"rotation_type": {
"$ref": "#/components/schemas/OpenIdConnectRefreshTokenRotationType"
}
},
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationType
{
"enum": [
"web",
"native",
"browser",
"service"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OpenIdConnectRefreshTokenRotationType
{
"enum": [
"rotate",
"static"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
Org2OrgApplication
{
"properties": {
"name": {
"default": "okta_org2org"
},
"settings": {
"$ref": "#/components/schemas/Org2OrgApplicationSettings"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/SamlApplication",
"x-okta-defined-as": {
"name": "okta_org2org"
}
}
Org2OrgApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/Org2OrgApplicationSettingsApp"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/SamlApplicationSettings"
}
Org2OrgApplicationSettingsApp
{
"properties": {
"acsUrl": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"audRestriction": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
OrgContactType
{
"enum": [
"BILLING",
"TECHNICAL"
],
"type": "string",
"x-okta-tags": [
"Org"
]
}
OrgContactTypeObj
{
"type": "object",
"properties": {
"_links": {
"additionalProperties": {
"type": "object"
}
},
"contactType": {
"$ref": "#/components/schemas/OrgContactType"
}
},
"x-okta-tags": [
"Org"
]
}
OrgContactUser
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"userId": {
"type": "string"
}
},
"x-okta-tags": [
"Org"
],
"x-okta-operations": [
{
"alias": "updateContactUser",
"arguments": [
{
"src": "userId",
"dest": "userId"
}
],
"operationId": "updateOrgContactUser"
}
]
}
OrgListContactTypesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OrgContactTypeObj"
}
}
OrgOktaCommunicationSetting
{
"type": "object",
"properties": {
"_links": {
"additionalProperties": {
"type": "object"
}
},
"optOutEmailUsers": {
"type": "boolean",
"readOnly": true
}
},
"x-okta-tags": [
"Org"
],
"x-okta-operations": [
{
"alias": "optInUsersToOktaCommunicationEmails",
"operationId": "optInUsersToOktaCommunicationEmails"
},
{
"alias": "optOutUsersFromOktaCommunicationEmails",
"operationId": "optOutUsersFromOktaCommunicationEmails"
}
]
}
OrgOktaSupportSetting
{
"enum": [
"DISABLED",
"ENABLED"
],
"type": "string",
"x-okta-tags": [
"Org"
]
}
OrgOktaSupportSettingsObj
{
"type": "object",
"properties": {
"_links": {
"additionalProperties": {
"type": "object"
}
},
"support": {
"$ref": "#/components/schemas/OrgOktaSupportSetting"
},
"expiration": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-tags": [
"Org"
],
"x-okta-operations": [
{
"alias": "extendOktaSupport",
"operationId": "extendOktaSupport"
},
{
"alias": "grantOktaSupport",
"operationId": "grantOktaSupport"
},
{
"alias": "revokeOktaSupport",
"operationId": "revokeOktaSupport"
}
]
}
OrgPreferences
{
"type": "object",
"properties": {
"_links": {
"additionalProperties": {
"type": "object"
}
},
"showEndUserFooter": {
"type": "boolean",
"readOnly": true
}
},
"x-okta-tags": [
"Org"
],
"x-okta-operations": [
{
"alias": "hideEndUserFooter",
"operationId": "hideOktaUIFooter"
},
{
"alias": "showEndUserFooter",
"operationId": "showOktaUIFooter"
}
]
}
OrgSetting
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"_links": {
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string",
"readOnly": true
},
"country": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"website": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"subdomain": {
"type": "string",
"readOnly": true
},
"postalCode": {
"type": "string"
},
"companyName": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"phoneNumber": {
"type": "string"
},
"supportPhoneNumber": {
"type": "string"
},
"endUserSupportHelpURL": {
"type": "string"
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"dest": "orgSetting",
"self": true
}
],
"operationId": "getOrgSettings"
},
{
"alias": "update",
"arguments": [
{
"dest": "orgSetting",
"self": true
}
],
"operationId": "updateOrgSetting"
}
],
"x-okta-tags": [
"Org"
],
"x-okta-operations": [
{
"alias": "partialUpdate",
"arguments": [
{
"dest": "orgSetting",
"self": true
}
],
"operationId": "partialUpdateOrgSetting"
},
{
"alias": "getContactTypes",
"operationId": "getOrgContactTypes"
},
{
"alias": "getOrgContactUser",
"operationId": "getOrgContactUser"
},
{
"alias": "getSupportSettings",
"operationId": "getOrgOktaSupportSettings"
},
{
"alias": "communicationSettings",
"operationId": "getOktaCommunicationSettings"
},
{
"alias": "orgPreferences",
"operationId": "getOrgPreferences"
},
{
"alias": "showFooter",
"arguments": [
{
"dest": "orgSetting",
"self": true
}
],
"operationId": "showOktaUIFooter"
},
{
"alias": "hideFooter",
"arguments": [
{
"dest": "orgSetting",
"self": true
}
],
"operationId": "hideOktaUIFooter"
},
{
"alias": "updateOrgLogo",
"operationId": "updateOrgLogo"
}
]
}
PasswordCredential
{
"type": "object",
"properties": {
"hash": {
"$ref": "#/components/schemas/PasswordCredentialHash"
},
"hook": {
"$ref": "#/components/schemas/PasswordCredentialHook"
},
"value": {
"type": "string",
"format": "password"
}
},
"x-okta-tags": [
"User"
]
}
PasswordCredentialHash
{
"type": "object",
"properties": {
"salt": {
"type": "string"
},
"value": {
"type": "string"
},
"algorithm": {
"$ref": "#/components/schemas/PasswordCredentialHashAlgorithm"
},
"saltOrder": {
"type": "string"
},
"workFactor": {
"type": "integer"
}
},
"x-okta-tags": [
"User"
]
}
PasswordCredentialHashAlgorithm
{
"enum": [
"BCRYPT",
"SHA-512",
"SHA-256",
"SHA-1",
"MD5"
],
"type": "string",
"x-okta-tags": [
"User"
]
}
PasswordCredentialHook
{
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"x-okta-tags": [
"User"
]
}
PasswordDictionary
{
"type": "object",
"properties": {
"common": {
"$ref": "#/components/schemas/PasswordDictionaryCommon"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordDictionaryCommon
{
"type": "object",
"properties": {
"exclude": {
"type": "boolean",
"default": false
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordExpirationPolicyRuleCondition
{
"type": "object",
"properties": {
"unit": {
"type": "string"
},
"number": {
"type": "integer"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicy
{
"type": "object",
"properties": {
"settings": {
"$ref": "#/components/schemas/PasswordPolicySettings"
},
"conditions": {
"$ref": "#/components/schemas/PasswordPolicyConditions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
PasswordPolicyAuthenticationProviderCondition
{
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string"
}
},
"provider": {
"enum": [
"ACTIVE_DIRECTORY",
"ANY",
"LDAP",
"OKTA"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyConditions
{
"properties": {
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
},
"authProvider": {
"$ref": "#/components/schemas/PasswordPolicyAuthenticationProviderCondition"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleConditions"
}
PasswordPolicyDelegationSettings
{
"type": "object",
"properties": {
"options": {
"$ref": "#/components/schemas/PasswordPolicyDelegationSettingsOptions"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyDelegationSettingsOptions
{
"type": "object",
"properties": {
"skipUnlock": {
"type": "boolean"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyPasswordSettings
{
"type": "object",
"properties": {
"age": {
"$ref": "#/components/schemas/PasswordPolicyPasswordSettingsAge"
},
"lockout": {
"$ref": "#/components/schemas/PasswordPolicyPasswordSettingsLockout"
},
"complexity": {
"$ref": "#/components/schemas/PasswordPolicyPasswordSettingsComplexity"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyPasswordSettingsAge
{
"type": "object",
"properties": {
"maxAgeDays": {
"type": "integer",
"default": 0
},
"historyCount": {
"type": "integer",
"default": 0
},
"minAgeMinutes": {
"type": "integer",
"default": 0
},
"expireWarnDays": {
"type": "integer",
"default": 0
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyPasswordSettingsComplexity
{
"type": "object",
"properties": {
"minLength": {
"type": "integer",
"default": 8
},
"minNumber": {
"type": "integer",
"default": 1
},
"minSymbol": {
"type": "integer",
"default": 1
},
"dictionary": {
"$ref": "#/components/schemas/PasswordDictionary"
},
"minLowerCase": {
"type": "integer",
"default": 1
},
"minUpperCase": {
"type": "integer",
"default": 1
},
"excludeUsername": {
"type": "boolean",
"default": true
},
"excludeAttributes": {
"type": "array",
"items": {
"type": "string"
},
"default": 1
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyPasswordSettingsLockout
{
"type": "object",
"properties": {
"maxAttempts": {
"type": "integer"
},
"autoUnlockMinutes": {
"type": "integer"
},
"showLockoutFailures": {
"type": "boolean"
},
"userLockoutNotificationChannels": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryEmail
{
"type": "object",
"properties": {
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"readOnly": true
},
"properties": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryEmailProperties"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryEmailProperties
{
"type": "object",
"properties": {
"recoveryToken": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryEmailRecoveryToken"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryEmailRecoveryToken
{
"type": "object",
"properties": {
"tokenLifetimeMinutes": {
"type": "integer",
"default": 10080
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryFactorSettings
{
"type": "object",
"properties": {
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"default": "INACTIVE"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryFactors
{
"type": "object",
"properties": {
"okta_sms": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryFactorSettings"
},
"okta_call": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryFactorSettings"
},
"okta_email": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryEmail"
},
"recovery_question": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryQuestion"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryQuestion
{
"type": "object",
"properties": {
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"readOnly": true
},
"properties": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryQuestionProperties"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryQuestionComplexity
{
"type": "object",
"properties": {
"minLength": {
"type": "integer",
"readOnly": true
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryQuestionProperties
{
"type": "object",
"properties": {
"complexity": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryQuestionComplexity"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoverySettings
{
"type": "object",
"properties": {
"factors": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryFactors"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRule
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"actions": {
"$ref": "#/components/schemas/PasswordPolicyRuleActions"
},
"conditions": {
"$ref": "#/components/schemas/PasswordPolicyRuleConditions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRule"
}
PasswordPolicyRuleAction
{
"type": "object",
"properties": {
"access": {
"enum": [
"ALLOW",
"DENY"
],
"type": "string",
"readOnly": false
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRuleActions
{
"properties": {
"passwordChange": {
"$ref": "#/components/schemas/PasswordPolicyRuleAction"
},
"selfServiceUnlock": {
"$ref": "#/components/schemas/PasswordPolicyRuleAction"
},
"selfServicePasswordReset": {
"$ref": "#/components/schemas/PasswordPolicyRuleAction"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleActions"
}
PasswordPolicyRuleConditions
{
"properties": {
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
},
"network": {
"$ref": "#/components/schemas/PolicyNetworkCondition"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleConditions"
}
PasswordPolicySettings
{
"type": "object",
"properties": {
"password": {
"$ref": "#/components/schemas/PasswordPolicyPasswordSettings"
},
"recovery": {
"$ref": "#/components/schemas/PasswordPolicyRecoverySettings"
},
"delegation": {
"$ref": "#/components/schemas/PasswordPolicyDelegationSettings"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordSettingObject
{
"type": "object",
"properties": {
"seed": {
"$ref": "#/components/schemas/SeedEnum"
},
"change": {
"$ref": "#/components/schemas/ChangeEnum"
},
"status": {
"$ref": "#/components/schemas/EnabledStatus"
}
},
"x-okta-tags": [
"Application"
]
}
PlatformConditionEvaluatorPlatform
{
"type": "object",
"properties": {
"os": {
"$ref": "#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystem"
},
"type": {
"enum": [
"DESKTOP",
"MOBILE",
"OTHER",
"ANY"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
PlatformConditionEvaluatorPlatformOperatingSystem
{
"type": "object",
"properties": {
"type": {
"enum": [
"ANDROID",
"IOS",
"WINDOWS",
"OSX",
"OTHER",
"ANY"
],
"type": "string"
},
"version": {
"$ref": "#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystemVersion"
},
"expression": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
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"
]
}
ProvisioningDeprovisionedCondition
{
"type": "object",
"properties": {
"action": {
"enum": [
"NONE",
"REACTIVATE"
],
"type": "string"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProvisioningGroups
{
"type": "object",
"properties": {
"action": {
"enum": [
"NONE",
"APPEND",
"SYNC",
"ASSIGN"
],
"type": "string"
},
"filter": {
"type": "array",
"items": {
"type": "string"
}
},
"assignments": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceAttributeName": {
"type": "string"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
ProvisioningSuspendedCondition
{
"type": "object",
"properties": {
"action": {
"enum": [
"NONE",
"UNSUSPEND"
],
"type": "string"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
PushUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/PushUserFactorProfile"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"factorResult": {
"$ref": "#/components/schemas/FactorResultType"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
PushUserFactorProfile
{
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"platform": {
"type": "string"
},
"deviceType": {
"type": "string"
},
"deviceToken": {
"type": "string"
},
"credentialId": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
RecoveryQuestionCredential
{
"type": "object",
"properties": {
"answer": {
"type": "string"
},
"question": {
"type": "string"
}
},
"x-okta-tags": [
"User"
]
}
RequiredEnum
{
"enum": [
"ALWAYS",
"HIGH_RISK_ONLY",
"NEVER"
],
"type": "string",
"x-okta-tags": [
"Authenticator"
]
}
ResetPasswordToken
{
"type": "object",
"properties": {
"resetPasswordUrl": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"User"
]
}
ResponseLinks
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
}
},
"x-okta-tags": [
"User"
]
}
RiskPolicyRuleCondition
{
"type": "object",
"properties": {
"behaviors": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
},
"x-okta-tags": [
"Policy"
]
}
RiskScorePolicyRuleCondition
{
"type": "object",
"properties": {
"level": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
Role
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"$ref": "#/components/schemas/RoleType"
},
"label": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/RoleStatus"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"description": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"assignmentType": {
"$ref": "#/components/schemas/RoleAssignmentType"
}
},
"x-okta-tags": [
"User"
],
"x-okta-operations": [
{
"alias": "addAdminGroupTarget",
"arguments": [
{
"src": "id",
"dest": "roleId"
},
{
"dest": "groupId",
"parentSrc": "id"
}
],
"operationId": "addGroupTargetToGroupAdministratorRoleForGroup"
},
{
"alias": "addAppInstanceTargetToAdminRole",
"arguments": [
{
"src": "id",
"dest": "roleId"
},
{
"dest": "groupId",
"parentSrc": "id"
}
],
"operationId": "addApplicationInstanceTargetToAppAdminRoleGivenToGroup"
},
{
"alias": "addAppTargetToAdminRole",
"arguments": [
{
"src": "id",
"dest": "roleId"
},
{
"dest": "groupId",
"parentSrc": "id"
}
],
"operationId": "addApplicationTargetToAdminRoleGivenToGroup"
},
{
"alias": "addAllAppsAsTargetToRole",
"arguments": [
{
"src": "id",
"dest": "roleId"
},
{
"dest": "userId",
"parentSrc": "id"
}
],
"operationId": "addAllAppsAsTargetToRole"
},
{
"alias": "addAppTargetToAppAdminRoleForUser",
"arguments": [
{
"src": "id",
"dest": "roleId"
},
{
"dest": "userId",
"parentSrc": "id"
}
],
"operationId": "addApplicationTargetToAppAdminRoleForUser"
},
{
"alias": "addAppTargetToAdminRoleForUser",
"arguments": [
{
"src": "id",
"dest": "roleId"
},
{
"dest": "userId",
"parentSrc": "id"
}
],
"operationId": "addApplicationTargetToAdminRoleForUser"
}
]
}
RoleAssignmentType
{
"enum": [
"GROUP",
"USER"
],
"type": "string",
"x-okta-tags": [
"Role"
]
}
RoleStatus
{
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"x-okta-tags": [
"User"
]
}
RoleType
{
"enum": [
"SUPER_ADMIN",
"ORG_ADMIN",
"APP_ADMIN",
"USER_ADMIN",
"HELP_DESK_ADMIN",
"READ_ONLY_ADMIN",
"MOBILE_ADMIN",
"API_ACCESS_MANAGEMENT_ADMIN",
"REPORT_ADMIN",
"GROUP_MEMBERSHIP_ADMIN",
"CUSTOM"
],
"type": "string",
"x-okta-tags": [
"Role"
]
}
SamlApplication
{
"properties": {
"settings": {
"$ref": "#/components/schemas/SamlApplicationSettings"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-openapi-v3-discriminator": {
"mapping": {
"okta_org2org": "#/definitions/Org2OrgApplication"
},
"propertyName": "name"
}
}
SamlApplicationSettings
{
"properties": {
"signOn": {
"$ref": "#/components/schemas/SamlApplicationSettingsSignOn"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
SamlApplicationSettingsSignOn
{
"properties": {
"slo": {
"$ref": "#/components/schemas/SingleLogout"
},
"audience": {
"type": "string"
},
"spIssuer": {
"type": "string"
},
"idpIssuer": {
"type": "string"
},
"recipient": {
"type": "string"
},
"ssoAcsUrl": {
"type": "string"
},
"destination": {
"type": "string"
},
"inlineHooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignOnInlineHook"
}
},
"acsEndpoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AcsEndpoint"
}
},
"spCertificate": {
"$ref": "#/components/schemas/SpCertificate"
},
"responseSigned": {
"type": "boolean"
},
"assertionSigned": {
"type": "boolean"
},
"digestAlgorithm": {
"type": "string"
},
"honorForceAuthn": {
"type": "boolean"
},
"audienceOverride": {
"type": "string"
},
"defaultRelayState": {
"type": "string"
},
"recipientOverride": {
"type": "string"
},
"requestCompressed": {
"type": "boolean"
},
"ssoAcsUrlOverride": {
"type": "string"
},
"signatureAlgorithm": {
"type": "string"
},
"attributeStatements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SamlAttributeStatement"
}
},
"destinationOverride": {
"type": "string"
},
"subjectNameIdFormat": {
"type": "string"
},
"authnContextClassRef": {
"type": "string"
},
"subjectNameIdTemplate": {
"type": "string"
},
"samlSignedRequestEnabled": {
"type": "boolean"
},
"allowMultipleAcsEndpoints": {
"type": "boolean"
}
},
"x-okta-tags": [
"Application"
]
}
SamlAttributeStatement
{
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"namespace": {
"type": "string"
},
"filterType": {
"type": "string"
},
"filterValue": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
ScheduledUserLifecycleAction
{
"type": "object",
"properties": {
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"DELETED",
"EXPIRED_PASSWORD",
"ACTIVATING",
"SUSPENDED",
"DELETING"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
SchemeApplicationCredentials
{
"properties": {
"scheme": {
"$ref": "#/components/schemas/ApplicationCredentialsScheme"
},
"signing": {
"$ref": "#/components/schemas/ApplicationCredentialsSigning"
},
"password": {
"$ref": "#/components/schemas/PasswordCredential"
},
"userName": {
"type": "string"
},
"revealPassword": {
"type": "boolean"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationCredentials"
}
Scope
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/ScopeType"
},
"stringValue": {
"type": "string"
},
"allowedOktaApps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IframeEmbedScopeAllowedApps"
}
}
},
"x-okta-tags": [
"Role"
]
}
ScopeType
{
"enum": [
"CORS",
"REDIRECT",
"IFRAME_EMBED"
],
"type": "string",
"x-okta-tags": [
"Role"
]
}
SecurePasswordStoreApplication
{
"properties": {
"name": {
"default": "template_sps"
},
"settings": {
"$ref": "#/components/schemas/SecurePasswordStoreApplicationSettings"
},
"credentials": {
"$ref": "#/components/schemas/SchemeApplicationCredentials"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-okta-defined-as": {
"name": "template_sps"
}
}
SecurePasswordStoreApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/SecurePasswordStoreApplicationSettingsApplication"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
SecurePasswordStoreApplicationSettingsApplication
{
"properties": {
"url": {
"type": "string"
},
"passwordField": {
"type": "string"
},
"usernameField": {
"type": "string"
},
"optionalField1": {
"type": "string"
},
"optionalField2": {
"type": "string"
},
"optionalField3": {
"type": "string"
},
"optionalField1Value": {
"type": "string"
},
"optionalField2Value": {
"type": "string"
},
"optionalField3Value": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
SecurityQuestion
{
"properties": {
"answer": {
"type": "string"
},
"question": {
"type": "string"
},
"questionText": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
SecurityQuestionUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/SecurityQuestionUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
SecurityQuestionUserFactorProfile
{
"properties": {
"answer": {
"type": "string"
},
"question": {
"type": "string"
},
"questionText": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
SeedEnum
{
"enum": [
"OKTA",
"RANDOM"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
Session
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"amr": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionAuthenticationMethod"
},
"readOnly": true
},
"idp": {
"$ref": "#/components/schemas/SessionIdentityProvider"
},
"login": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/SessionStatus"
},
"userId": {
"type": "string",
"readOnly": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastFactorVerification": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastPasswordVerification": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"src": "id",
"dest": "sessionId"
}
],
"operationId": "getSession"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "sessionId"
}
],
"operationId": "endSession"
}
],
"x-okta-tags": [
"Session"
],
"x-okta-operations": [
{
"alias": "refresh",
"arguments": [
{
"src": "id",
"dest": "sessionId"
}
],
"operationId": "refreshSession"
}
]
}
SessionAuthenticationMethod
{
"enum": [
"pwd",
"swk",
"hwk",
"otp",
"sms",
"tel",
"geo",
"fpt",
"kba",
"mfa",
"mca",
"sc"
],
"type": "string",
"x-okta-tags": [
"Session"
]
}
SessionIdentityProvider
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"$ref": "#/components/schemas/SessionIdentityProviderType"
}
},
"x-okta-tags": [
"Session"
]
}
SessionIdentityProviderType
{
"enum": [
"ACTIVE_DIRECTORY",
"LDAP",
"OKTA",
"FEDERATION",
"SOCIAL"
],
"type": "string",
"x-okta-tags": [
"Session"
]
}
SessionStatus
{
"enum": [
"ACTIVE",
"MFA_ENROLL",
"MFA_REQUIRED"
],
"type": "string",
"x-okta-tags": [
"Session"
]
}
SignInPageTouchPointVariant
{
"enum": [
"OKTA_DEFAULT",
"BACKGROUND_SECONDARY_COLOR",
"BACKGROUND_IMAGE"
],
"type": "string",
"x-okta-tags": [
"Brand"
]
}
SignOnInlineHook
{
"properties": {
"id": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
SingleLogout
{
"properties": {
"issuer": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"logoutUrl": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
SmsTemplate
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SmsTemplateType"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"template": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"translations": {
"$ref": "#/components/schemas/SmsTemplateTranslations"
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "smsTemplate",
"self": true
}
],
"operationId": "createSmsTemplate"
},
{
"alias": "read",
"arguments": [],
"operationId": "getSmsTemplate"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "templateId"
},
{
"dest": "smsTemplate",
"self": true
}
],
"operationId": "updateSmsTemplate"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "templateId"
}
],
"operationId": "deleteSmsTemplate"
}
],
"x-okta-tags": [
"Template"
],
"x-okta-operations": [
{
"alias": "partialUpdate",
"arguments": [
{
"src": "id",
"dest": "templateId"
},
{
"dest": "smsTemplate",
"self": true
}
],
"operationId": "partialUpdateSmsTemplate"
}
]
}
SmsTemplateTranslations
{
"type": "object",
"x-okta-tags": [
"Template"
],
"x-okta-extensible": true
}
SmsTemplateType
{
"enum": [
"SMS_VERIFY_CODE"
],
"type": "string",
"x-okta-tags": [
"Template"
]
}
SmsUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/SmsUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
SmsUserFactorProfile
{
"properties": {
"phoneNumber": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
SocialAuthToken
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"token": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"tokenType": {
"type": "string"
},
"tokenAuthScheme": {
"type": "string"
}
},
"x-okta-tags": [
"IdentityProvider"
]
}
SpCertificate
{
"properties": {
"x5c": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": false
}
},
"x-okta-tags": [
"Application"
]
}
Subscription
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/SubscriptionStatus"
},
"channels": {
"type": "array",
"items": {
"type": "string"
}
},
"notificationType": {
"$ref": "#/components/schemas/NotificationType"
}
},
"x-okta-tags": [
"Role"
],
"x-okta-operations": [
{
"alias": "listRoleSubscriptions",
"operationId": "listRoleSubscriptions"
},
{
"alias": "getRoleSubscriptionByNotificationType",
"operationId": "getRoleSubscriptionByNotificationType"
},
{
"alias": "getUserSubscriptionByNotificationType",
"operationId": "getUserSubscriptionByNotificationType"
},
{
"alias": "listUserSubscriptions",
"operationId": "listUserSubscriptions"
},
{
"alias": "subscribeUserSubscriptionByNotificationType",
"operationId": "subscribeUserSubscriptionByNotificationType"
},
{
"alias": "unsubscribeRoleSubscriptionByNotificationType",
"operationId": "unsubscribeRoleSubscriptionByNotificationType"
},
{
"alias": "subscribeRoleSubscriptionByNotificationType",
"operationId": "subscribeRoleSubscriptionByNotificationType"
},
{
"alias": "unsubscribeUserSubscriptionByNotificationType",
"operationId": "unsubscribeUserSubscriptionByNotificationType"
}
]
}
SubscriptionListRoleSubscriptionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
}
SubscriptionStatus
{
"enum": [
"subscribed",
"unsubscribed"
],
"type": "string",
"x-okta-tags": [
"Role"
]
}
SwaApplication
{
"properties": {
"name": {
"default": "template_swa"
},
"settings": {
"$ref": "#/components/schemas/SwaApplicationSettings"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/BrowserPluginApplication",
"x-okta-defined-as": {
"name": "template_swa"
}
}
SwaApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/SwaApplicationSettingsApplication"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
SwaApplicationSettingsApplication
{
"properties": {
"url": {
"type": "string"
},
"checkbox": {
"type": "string"
},
"buttonField": {
"type": "string"
},
"redirectUrl": {
"type": "string"
},
"loginUrlRegex": {
"type": "string"
},
"passwordField": {
"type": "string"
},
"usernameField": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
SwaThreeFieldApplication
{
"properties": {
"name": {
"default": "template_swa3field"
},
"settings": {
"$ref": "#/components/schemas/SwaThreeFieldApplicationSettings"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/BrowserPluginApplication",
"x-okta-defined-as": {
"name": "template_swa3field"
}
}
SwaThreeFieldApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/SwaThreeFieldApplicationSettingsApplication"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
SwaThreeFieldApplicationSettingsApplication
{
"properties": {
"targetURL": {
"type": "string"
},
"loginUrlRegex": {
"type": "string"
},
"buttonSelector": {
"type": "string"
},
"extraFieldValue": {
"type": "string"
},
"passwordSelector": {
"type": "string"
},
"userNameSelector": {
"type": "string"
},
"extraFieldSelector": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
TempPassword
{
"properties": {
"tempPassword": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"User"
]
}
TemplateEnumerateSmsTemplatesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SmsTemplate"
}
}
Theme
{
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"backgroundImage": {
"type": "string",
"readOnly": true
},
"primaryColorHex": {
"type": "string"
},
"secondaryColorHex": {
"type": "string"
},
"primaryColorContrastHex": {
"type": "string"
},
"secondaryColorContrastHex": {
"type": "string"
},
"errorPageTouchPointVariant": {
"$ref": "#/components/schemas/ErrorPageTouchPointVariant"
},
"signInPageTouchPointVariant": {
"$ref": "#/components/schemas/SignInPageTouchPointVariant"
},
"emailTemplateTouchPointVariant": {
"$ref": "#/components/schemas/EmailTemplateTouchPointVariant"
},
"endUserDashboardTouchPointVariant": {
"$ref": "#/components/schemas/EndUserDashboardTouchPointVariant"
}
},
"x-okta-crud": [
{
"alias": "read",
"operationId": "getBrandTheme"
},
{
"alias": "update",
"operationId": "updateBrandTheme"
}
],
"x-okta-tags": [
"Brand"
],
"x-okta-operations": [
{
"alias": "uploadBrandThemeLogo",
"operationId": "uploadBrandThemeLogo"
},
{
"alias": "deleteBrandThemeLogo",
"operationId": "deleteBrandThemeLogo"
},
{
"alias": "updateBrandThemeFavicon",
"operationId": "uploadBrandThemeFavicon"
},
{
"alias": "deleteBrandThemeFavicon",
"operationId": "deleteBrandThemeFavicon"
},
{
"alias": "updateBrandThemeBackgroundImage",
"operationId": "uploadBrandThemeBackgroundImage"
},
{
"alias": "deleteBrandThemeBackgroundImage",
"operationId": "deleteBrandThemeBackgroundImage"
}
]
}
ThemeResponse
{
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"logo": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"favicon": {
"type": "string",
"readOnly": true
},
"backgroundImage": {
"type": "string",
"readOnly": true
},
"primaryColorHex": {
"type": "string"
},
"secondaryColorHex": {
"type": "string"
},
"primaryColorContrastHex": {
"type": "string"
},
"secondaryColorContrastHex": {
"type": "string"
},
"errorPageTouchPointVariant": {
"$ref": "#/components/schemas/ErrorPageTouchPointVariant"
},
"signInPageTouchPointVariant": {
"$ref": "#/components/schemas/SignInPageTouchPointVariant"
},
"emailTemplateTouchPointVariant": {
"$ref": "#/components/schemas/EmailTemplateTouchPointVariant"
},
"endUserDashboardTouchPointVariant": {
"$ref": "#/components/schemas/EndUserDashboardTouchPointVariant"
}
},
"x-okta-tags": [
"Brand"
]
}
ThreatInsightConfiguration
{
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"action": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"excludeZones": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [],
"operationId": "getCurrentConfiguration"
},
{
"alias": "update",
"arguments": [
{
"dest": "threatInsightConfiguration",
"self": true
}
],
"operationId": "updateConfiguration"
}
],
"x-okta-tags": [
"ThreatInsight"
]
}
TokenAuthorizationServerPolicyRuleAction
{
"type": "object",
"properties": {
"inlineHook": {
"$ref": "#/components/schemas/TokenAuthorizationServerPolicyRuleActionInlineHook"
},
"refreshTokenWindowMinutes": {
"type": "integer"
},
"accessTokenLifetimeMinutes": {
"type": "integer"
},
"refreshTokenLifetimeMinutes": {
"type": "integer"
}
},
"x-okta-tags": [
"AuthorizationServerPolicy"
]
}
TokenAuthorizationServerPolicyRuleActionInlineHook
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"x-okta-tags": [
"AuthorizationServerPolicy"
]
}
TokenUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/TokenUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
TokenUserFactorProfile
{
"properties": {
"credentialId": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
TotpUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/TotpUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
TotpUserFactorProfile
{
"properties": {
"credentialId": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
TrustedOrigin
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"origin": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Scope"
}
},
"status": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"createdBy": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastUpdatedBy": {
"type": "string"
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "trustedOrigin",
"self": true
}
],
"operationId": "createOrigin"
},
{
"alias": "read",
"arguments": [],
"operationId": "getOrigin"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "trustedOriginId"
},
{
"dest": "trustedOrigin",
"self": true
}
],
"operationId": "updateOrigin"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "trustedOriginId"
}
],
"operationId": "deleteOrigin"
}
],
"x-okta-tags": [
"TrustedOrigin"
]
}
TrustedOriginGetListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TrustedOrigin"
}
}
U2fUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/U2fUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
U2fUserFactorProfile
{
"properties": {
"credentialId": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
User
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"$ref": "#/components/schemas/UserType"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/UserStatus"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"profile": {
"$ref": "#/components/schemas/UserProfile"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"activated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastLogin": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"credentials": {
"$ref": "#/components/schemas/UserCredentials"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"statusChanged": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"passwordChanged": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"transitioningToStatus": {
"$ref": "#/components/schemas/UserStatus"
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "user",
"self": true
}
],
"operationId": "createUser"
},
{
"alias": "read",
"arguments": [],
"operationId": "getUser"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "userId"
},
{
"dest": "user",
"self": true
}
],
"operationId": "updateUser"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "userId"
},
{
"dest": "user",
"self": true
}
],
"operationId": "deactivateOrDeleteUser"
}
],
"x-okta-tags": [
"User"
],
"x-okta-operations": [
{
"alias": "listAppLinks",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listAppLinks"
},
{
"alias": "changePassword",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "changePassword"
},
{
"alias": "changeRecoveryQuestion",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "changeRecoveryQuestion"
},
{
"alias": "forgotPasswordSetNewPassword",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "forgotPasswordSetNewPassword"
},
{
"alias": "forgotPasswordGenerateOneTimeToken",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "forgotPasswordGenerateOneTimeToken"
},
{
"alias": "assignRole",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "assignRoleToUser"
},
{
"alias": "getRole",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "getUserRole"
},
{
"alias": "removeRole",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "removeRoleFromUser"
},
{
"alias": "listGroupTargets",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listGroupTargetsForRole"
},
{
"alias": "removeGroupTarget",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "removeGroupTargetFromRole"
},
{
"alias": "addGroupTarget",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "addGroupTargetToRole"
},
{
"alias": "listAssignedRoles",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listAssignedRolesForUser"
},
{
"alias": "addAllAppsAsTarget",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "addAllAppsAsTargetToRole"
},
{
"alias": "listGroups",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listUserGroups"
},
{
"alias": "listGrants",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listUserGrants"
},
{
"alias": "revokeGrants",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "revokeUserGrants"
},
{
"alias": "revokeGrant",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "revokeUserGrant"
},
{
"alias": "revokeGrantsForUserAndClient",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "revokeGrantsForUserAndClient"
},
{
"alias": "listRefreshTokensForUserAndClient",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listRefreshTokensForUserAndClient"
},
{
"alias": "revokeTokenForUserAndClient",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "revokeTokenForUserAndClient"
},
{
"alias": "getRefreshTokenForUserAndClient",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "getRefreshTokenForUserAndClient"
},
{
"alias": "revokeTokensForUserAndClient",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "revokeTokensForUserAndClient"
},
{
"alias": "listClients",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listUserClients"
},
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "activateUser"
},
{
"alias": "reactivate",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "reactivateUser"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "deactivateUser"
},
{
"alias": "suspend",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "suspendUser"
},
{
"alias": "unsuspend",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "unsuspendUser"
},
{
"alias": "resetPassword",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "resetPassword"
},
{
"alias": "expirePassword",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "expirePassword"
},
{
"alias": "expirePasswordAndGetTemporaryPassword",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "expirePasswordAndGetTemporaryPassword"
},
{
"alias": "unlock",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "unlockUser"
},
{
"alias": "resetFactors",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "resetFactors"
},
{
"alias": "deleteFactor",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "deleteFactor"
},
{
"alias": "addToGroup",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"description": "Adds a user to a group with 'OKTA_GROUP' type",
"operationId": "addUserToGroup"
},
{
"alias": "enrollFactor",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "enrollFactor"
},
{
"alias": "listSupportedFactors",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listSupportedFactors"
},
{
"alias": "listFactors",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listFactors"
},
{
"alias": "listSupportedSecurityQuestions",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listSupportedSecurityQuestions"
},
{
"alias": "getFactor",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "getFactor"
},
{
"alias": "setLinkedObject",
"arguments": [
{
"src": "id",
"dest": "associatedUserId"
}
],
"operationId": "setLinkedObjectForUser"
},
{
"alias": "listIdentityProviders",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listUserIdentityProviders"
},
{
"alias": "getLinkedObjects",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "getLinkedObjectsForUser"
},
{
"alias": "clearSessions",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "clearUserSessions"
},
{
"alias": "removeLinkedObject",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "removeLinkedObjectForUser"
}
]
}
UserActivationToken
{
"type": "object",
"properties": {
"activationUrl": {
"type": "string",
"readOnly": true
},
"activationToken": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"User"
]
}
UserCondition
{
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
UserCredentials
{
"type": "object",
"properties": {
"password": {
"$ref": "#/components/schemas/PasswordCredential"
},
"provider": {
"$ref": "#/components/schemas/AuthenticationProvider"
},
"recovery_question": {
"$ref": "#/components/schemas/RecoveryQuestionCredential"
}
},
"x-okta-tags": [
"User"
]
}
UserFactor
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/FactorStatus"
},
"verify": {
"$ref": "#/components/schemas/VerifyFactorRequest"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"provider": {
"$ref": "#/components/schemas/FactorProvider"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"factorType": {
"$ref": "#/components/schemas/FactorType"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "factorId"
},
{
"dest": "userId",
"parentSrc": "id"
}
],
"operationId": "deleteFactor"
}
],
"x-okta-tags": [
"UserFactor"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "factorId"
},
{
"dest": "userId",
"parentSrc": "id"
}
],
"operationId": "activateFactor"
},
{
"alias": "verify",
"arguments": [
{
"src": "id",
"dest": "factorId"
},
{
"dest": "userId",
"parentSrc": "id"
}
],
"operationId": "verifyFactor"
}
],
"x-openapi-v3-discriminator": {
"mapping": {
"sms": "#/definitions/SmsUserFactor",
"u2f": "#/definitions/U2fUserFactor",
"web": "#/definitions/WebUserFactor",
"call": "#/definitions/CallUserFactor",
"hotp": "#/definitions/CustomHotpUserFactor",
"push": "#/definitions/PushUserFactor",
"email": "#/definitions/EmailUserFactor",
"token": "#/definitions/TokenUserFactor",
"question": "#/definitions/SecurityQuestionUserFactor",
"webauthn": "#/definitions/WebAuthnUserFactor",
"token:hotp": "#/definitions/CustomHotpUserFactor",
"token:hardware": "#/definitions/HardwareUserFactor",
"token:software:totp": "#/definitions/TotpUserFactor"
},
"propertyName": "factorType"
}
}
UserFactorEnumerateEnrolledResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserFactor"
}
}
UserFactorEnumerateSecurityQuestionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityQuestion"
}
}
UserFactorEnumerateSupportedFactorsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserFactor"
}
}
UserGetLinkedObjectsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseLinks"
}
}
UserGetMemberGroupsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
UserIdString
{
"type": "object",
"properties": {
"userId": {
"type": "string"
}
},
"x-okta-tags": [
"Org"
],
"x-okta-parent": "#/definitions/OrgContactUser"
}
UserIdentifierConditionEvaluatorPattern
{
"type": "object",
"properties": {
"value": {
"type": "string"
},
"matchType": {
"enum": [
"SUFFIX",
"EXPRESSION",
"STARTS_WITH",
"EQUALS",
"CONTAINS"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
UserIdentifierPolicyRuleCondition
{
"type": "object",
"properties": {
"type": {
"enum": [
"IDENTIFIER",
"ATTRIBUTE"
],
"type": "string"
},
"patterns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserIdentifierConditionEvaluatorPattern"
}
},
"attribute": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
UserIdentityProviderLinkRequest
{
"type": "object",
"properties": {
"externalId": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
UserLifecycleAttributePolicyRuleCondition
{
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"matchingValue": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
UserListActiveUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
UserListAppTargetsForRoleResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CatalogApplication"
}
}
UserListAssignedAppLinksResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AppLink"
}
}
UserListAssignedRolesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
UserListClientsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2Client"
}
}
UserListGrantsForClientResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2ScopeConsentGrant"
}
}
UserListGrantsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2ScopeConsentGrant"
}
}
UserListIdpsForUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityProvider"
}
}
UserListRefreshTokensForUserAndClientResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2RefreshToken"
}
}
UserListRoleTargetsGroupsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
UserListSubscriptionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
}
UserNextLogin
{
"enum": [
"changePassword"
],
"type": "string",
"x-okta-tags": [
"User"
]
}
UserPolicyRuleCondition
{
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
},
"inactivity": {
"$ref": "#/components/schemas/InactivityPolicyRuleCondition"
},
"passwordExpiration": {
"$ref": "#/components/schemas/PasswordExpirationPolicyRuleCondition"
},
"lifecycleExpiration": {
"$ref": "#/components/schemas/LifecycleExpirationPolicyRuleCondition"
},
"userLifecycleAttribute": {
"$ref": "#/components/schemas/UserLifecycleAttributePolicyRuleCondition"
}
},
"x-okta-tags": [
"Policy"
]
}
UserProfile
{
"type": "object",
"properties": {
"city": {
"type": "string"
},
"email": {
"type": "string"
},
"login": {
"type": "string"
},
"state": {
"type": "string"
},
"title": {
"type": "string"
},
"locale": {
"type": "string"
},
"manager": {
"type": "string"
},
"zipCode": {
"type": "string"
},
"division": {
"type": "string"
},
"lastName": {
"type": "string"
},
"nickName": {
"type": "string"
},
"timezone": {
"type": "string"
},
"userType": {
"type": "string"
},
"firstName": {
"type": "string"
},
"managerId": {
"type": "string"
},
"costCenter": {
"type": "string"
},
"department": {
"type": "string"
},
"middleName": {
"type": "string"
},
"profileUrl": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"displayName": {
"type": "string"
},
"mobilePhone": {
"type": "string"
},
"secondEmail": {
"type": "string"
},
"organization": {
"type": "string"
},
"primaryPhone": {
"type": "string"
},
"postalAddress": {
"type": "string"
},
"streetAddress": {
"type": "string"
},
"employeeNumber": {
"type": "string"
},
"honorificPrefix": {
"type": "string"
},
"honorificSuffix": {
"type": "string"
},
"preferredLanguage": {
"type": "string"
}
},
"x-okta-tags": [
"User"
],
"x-okta-extensible": true
}
UserSchema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
},
"title": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"$schema": {
"type": "string",
"readOnly": true
},
"created": {
"type": "string",
"readOnly": true
},
"properties": {
"$ref": "#/components/schemas/UserSchemaProperties"
},
"definitions": {
"$ref": "#/components/schemas/UserSchemaDefinitions"
},
"lastUpdated": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttribute
{
"type": "object",
"properties": {
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"$ref": "#/components/schemas/UserSchemaAttributeType"
},
"items": {
"$ref": "#/components/schemas/UserSchemaAttributeItems"
},
"oneOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSchemaAttributeEnum"
}
},
"scope": {
"$ref": "#/components/schemas/UserSchemaAttributeScope"
},
"title": {
"type": "string"
},
"union": {
"$ref": "#/components/schemas/UserSchemaAttributeUnion"
},
"master": {
"$ref": "#/components/schemas/UserSchemaAttributeMaster"
},
"unique": {
"type": "string"
},
"pattern": {
"type": "string"
},
"required": {
"type": "boolean"
},
"maxLength": {
"type": "integer"
},
"minLength": {
"type": "integer"
},
"mutability": {
"type": "string"
},
"description": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSchemaAttributePermission"
}
},
"externalName": {
"type": "string"
},
"externalNamespace": {
"type": "string"
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttributeEnum
{
"type": "object",
"properties": {
"const": {
"type": "string"
},
"title": {
"type": "string"
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttributeItems
{
"type": "object",
"properties": {
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"type": "string"
},
"oneOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSchemaAttributeEnum"
}
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttributeMaster
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/UserSchemaAttributeMasterType"
},
"priority": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSchemaAttributeMasterPriority"
}
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttributeMasterPriority
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttributeMasterType
{
"enum": [
"PROFILE_MASTER",
"OKTA",
"OVERRIDE"
],
"type": "string",
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttributePermission
{
"type": "object",
"properties": {
"action": {
"type": "string"
},
"principal": {
"type": "string"
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttributeScope
{
"enum": [
"SELF",
"NONE"
],
"type": "object",
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttributeType
{
"enum": [
"string",
"boolean",
"number",
"integer",
"array"
],
"type": "string",
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttributeUnion
{
"enum": [
"DISABLE",
"ENABLE"
],
"type": "object",
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaBase
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string"
},
"required": {
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"$ref": "#/components/schemas/UserSchemaBaseProperties"
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaBaseProperties
{
"type": "object",
"properties": {
"city": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"email": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"login": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"state": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"title": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"locale": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"manager": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"zipCode": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"division": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"lastName": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"nickName": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"timezone": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"userType": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"firstName": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"managerId": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"costCenter": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"department": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"middleName": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"profileUrl": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"countryCode": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"displayName": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"mobilePhone": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"secondEmail": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"organization": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"primaryPhone": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"postalAddress": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"streetAddress": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"employeeNumber": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"honorificPrefix": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"honorificSuffix": {
"$ref": "#/components/schemas/UserSchemaAttribute"
},
"preferredLanguage": {
"$ref": "#/components/schemas/UserSchemaAttribute"
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaDefinitions
{
"type": "object",
"properties": {
"base": {
"$ref": "#/components/schemas/UserSchemaBase"
},
"custom": {
"$ref": "#/components/schemas/UserSchemaPublic"
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaProperties
{
"type": "object",
"properties": {
"profile": {
"$ref": "#/components/schemas/UserSchemaPropertiesProfile"
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaPropertiesProfile
{
"type": "object",
"properties": {
"allOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSchemaPropertiesProfileItem"
}
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaPropertiesProfileItem
{
"type": "object",
"properties": {
"$ref": {
"type": "string"
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaPublic
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string"
},
"required": {
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/UserSchemaAttribute"
}
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserStatus
{
"enum": [
"ACTIVE",
"DEPROVISIONED",
"LOCKED_OUT",
"PASSWORD_EXPIRED",
"PROVISIONED",
"RECOVERY",
"STAGED",
"SUSPENDED"
],
"type": "string",
"x-okta-tags": [
"User"
]
}
UserStatusPolicyRuleCondition
{
"type": "object",
"properties": {
"value": {
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"DELETED",
"EXPIRED_PASSWORD",
"ACTIVATING",
"SUSPENDED",
"DELETING"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
UserType
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"default": {
"type": "boolean",
"readOnly": true
},
"createdBy": {
"type": "string",
"readOnly": true
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastUpdatedBy": {
"type": "string",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "userType",
"self": true
}
],
"operationId": "createUserType"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "typeId"
},
{
"dest": "userType",
"self": true
}
],
"operationId": "updateUserType"
},
{
"alias": "read",
"arguments": [
{
"src": "id",
"dest": "typeId"
}
],
"operationId": "getUserType"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "typeId"
}
],
"operationId": "deleteUserType"
}
],
"x-okta-tags": [
"UserType"
],
"x-okta-operations": [
{
"alias": "replaceUserType",
"arguments": [
{
"src": "id",
"dest": "roleId"
}
],
"operationId": "replaceUserType"
}
]
}
UserTypeCondition
{
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
UserTypeGetAllUserTypesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserType"
}
}
UserVerificationEnum
{
"enum": [
"REQUIRED",
"PREFERRED"
],
"type": "string",
"x-okta-tags": [
"Authenticator"
]
}
VerificationMethod
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"factorMode": {
"type": "string"
},
"constraints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessPolicyConstraints"
}
},
"inactivityPeriod": {
"type": "string"
},
"reauthenticateIn": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
VerifyFactorRequest
{
"properties": {
"answer": {
"type": "string"
},
"passCode": {
"type": "string"
},
"clientData": {
"type": "string"
},
"stateToken": {
"type": "string"
},
"attestation": {
"type": "string"
},
"nextPassCode": {
"type": "string"
},
"activationToken": {
"type": "string"
},
"registrationData": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
VerifyUserFactorResponse
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"factorResult": {
"enum": [
"SUCCESS",
"EXPIRED",
"CHALLENGE",
"WAITING",
"FAILED",
"REJECTED",
"TIMEOUT",
"TIME_WINDOW_EXCEEDED",
"PASSCODE_REPLAYED",
"ERROR"
],
"type": "string"
},
"factorResultMessage": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
WebAuthnUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/WebAuthnUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
WebAuthnUserFactorProfile
{
"properties": {
"credentialId": {
"type": "string"
},
"authenticatorName": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
WebUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/WebUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
WebUserFactorProfile
{
"properties": {
"credentialId": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
WsFederationApplication
{
"properties": {
"name": {
"default": "template_wsfed"
},
"settings": {
"$ref": "#/components/schemas/WsFederationApplicationSettings"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-okta-defined-as": {
"name": "template_wsfed"
}
}
WsFederationApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/WsFederationApplicationSettingsApplication"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
WsFederationApplicationSettingsApplication
{
"properties": {
"realm": {
"type": "string"
},
"siteURL": {
"type": "string"
},
"groupName": {
"type": "string"
},
"wReplyURL": {
"type": "string"
},
"groupFilter": {
"type": "string"
},
"nameIDFormat": {
"type": "string"
},
"wReplyOverride": {
"type": "boolean"
},
"groupValueFormat": {
"type": "string"
},
"usernameAttribute": {
"type": "string"
},
"attributeStatements": {
"type": "string"
},
"audienceRestriction": {
"type": "string"
},
"authnContextClassRef": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}