Okta API

Identity and access management

developer.okta.com/docs/reference ↗

Version

2.16.0

OpenAPI

3.0.0

Endpoints

341

Schemas

532

91

Quality

Updated

3 days ago

Identity identity authentication security

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://your-subdomain.okta.com

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Application 8 endpoints

DELETE /api/v1/apps/{appId} Delete Application

Removes an inactive application.

operationId: Application_removeInactive

Parameters

Name	In	Required	Type	Description
appId	path	required	string	—

Responses

200

Success

DELETE /api/v1/apps/{appId}

DELETE /api/v1/apps/{appId}/credentials/csrs/{csrId}

operationId: Application_deleteCsrById

Parameters

Name	In	Required	Type	Description
appId	path	required	string	—
csrId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/apps/{appId}/credentials/csrs/{csrId}

DELETE /api/v1/apps/{appId}/credentials/secrets/{secretId}

Removes a secret from the client’s collection of secrets.

operationId: Application_removeSecret

Parameters

Name	In	Required	Type	Description
appId	path	required	string	—
secretId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/apps/{appId}/credentials/secrets/{secretId}

DELETE /api/v1/apps/{appId}/grants/{grantId}

Revokes permission for the application to request the given scope

operationId: Application_revokePermission

Parameters

Name	In	Required	Type	Description
appId	path	required	string	—
grantId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/apps/{appId}/grants/{grantId}

DELETE /api/v1/apps/{appId}/groups/{groupId} Remove Group from Application

Removes a group assignment from an application.

operationId: Application_removeGroupAssignment

Parameters

Name	In	Required	Type	Description
appId	path	required	string	—
groupId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/apps/{appId}/groups/{groupId}

DELETE /api/v1/apps/{appId}/tokens

Revokes all tokens for the specified application

operationId: Application_revokeAllTokens

Parameters

Name	In	Required	Type	Description
appId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/apps/{appId}/tokens

DELETE /api/v1/apps/{appId}/tokens/{tokenId}

Revokes the specified token for the specified application

operationId: Application_revokeToken

Parameters

Name	In	Required	Type	Description
appId	path	required	string	—
tokenId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/apps/{appId}/tokens/{tokenId}

DELETE /api/v1/apps/{appId}/users/{userId} Remove User from Application

Removes an assignment for a user from an application.

operationId: Application_removeUserFrom

Parameters

Name	In	Required	Type	Description
appId	path	required	string	—
userId	path	required	string	—
sendEmail	query	optional	boolean	—

Responses

204

No Content

DELETE /api/v1/apps/{appId}/users/{userId}

Authorizationserver 7 endpoints

DELETE /api/v1/authorizationServers/{authServerId}

Success

operationId: AuthorizationServer_deleteSuccess

Parameters

Name	In	Required	Type	Description
authServerId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/authorizationServers/{authServerId}

DELETE /api/v1/authorizationServers/{authServerId}/claims/{claimId}

Success

operationId: AuthorizationServer_deleteClaim

Parameters

Name	In	Required	Type	Description
authServerId	path	required	string	—
claimId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/authorizationServers/{authServerId}/claims/{claimId}

DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens

Success

operationId: AuthorizationServer_deleteClientToken

Parameters

Name	In	Required	Type	Description
authServerId	path	required	string	—
clientId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens

DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}

Success

operationId: AuthorizationServer_deleteAuthToken

Parameters

Name	In	Required	Type	Description
authServerId	path	required	string	—
clientId	path	required	string	—
tokenId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}

DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}

Success

operationId: AuthorizationServer_deletePolicyById

Parameters

Name	In	Required	Type	Description
authServerId	path	required	string	—
policyId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}

DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}

Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.

operationId: AuthorizationServer_deletePolicyRule

Parameters

Name	In	Required	Type	Description
authServerId	path	required	string	—
policyId	path	required	string	—
ruleId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}

DELETE /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}

Success

operationId: AuthorizationServer_deleteScope

Parameters

Name	In	Required	Type	Description
authServerId	path	required	string	—
scopeId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}

Brand 5 endpoints

DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations Delete Email Template Customization

Delete all customizations for an email template. Also known as “Reset to Default”.

operationId: Brand_deleteEmailTemplateCustomizations

Parameters

Name	In	Required	Type	Description
brandId	path	required	string	—
templateName	path	required	string	—

Responses

204

Success

DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations

DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId} Delete Email Customization

Delete an email customization

operationId: Brand_deleteEmailCustomization

Parameters

Name	In	Required	Type	Description
brandId	path	required	string	—
templateName	path	required	string	—
customizationId	path	required	string	—

Responses

204

No Content

409

Conflict

DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}

DELETE /api/v1/brands/{brandId}/themes/{themeId}/background-image Deletes a Theme background image

Deletes a Theme background image

operationId: Brand_deleteThemeBackgroundImage

Parameters

Name	In	Required	Type	Description
brandId	path	required	string	—
themeId	path	required	string	—

Responses

204

No Content

404

Not Found

DELETE /api/v1/brands/{brandId}/themes/{themeId}/background-image

DELETE /api/v1/brands/{brandId}/themes/{themeId}/favicon Deletes a Theme favicon. The org then uses the Okta default favicon.

Deletes a Theme favicon. The org then uses the Okta default favicon.

operationId: Brand_deleteThemeFavicon

Parameters

Name	In	Required	Type	Description
brandId	path	required	string	—
themeId	path	required	string	—

Responses

204

No Content

404

Not Found

DELETE /api/v1/brands/{brandId}/themes/{themeId}/favicon

DELETE /api/v1/brands/{brandId}/themes/{themeId}/logo Deletes a Theme logo. The org then uses the Okta default logo.

Deletes a Theme logo. The org then uses the Okta default logo.

operationId: Brand_deleteThemeLogo

Parameters

Name	In	Required	Type	Description
brandId	path	required	string	—
themeId	path	required	string	—

Responses

204

No Content

404

Not Found

DELETE /api/v1/brands/{brandId}/themes/{themeId}/logo

Domain 1 endpoints

DELETE /api/v1/domains/{domainId} Delete Domain

Deletes a Domain by id.

operationId: Domain_removeById

Parameters

Name	In	Required	Type	Description
domainId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/domains/{domainId}

Eventhook 1 endpoints

DELETE /api/v1/eventHooks/{eventHookId}

Success

operationId: EventHook_removeSuccessEvent

Parameters

Name	In	Required	Type	Description
eventHookId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/eventHooks/{eventHookId}

Group 7 endpoints

DELETE /api/v1/groups/rules/{ruleId} Delete a group Rule

Removes a specific group rule by id from your organization

operationId: Group_removeRuleById

Parameters

Name	In	Required	Type	Description
ruleId	path	required	string	—
removeUsers	query	optional	boolean	Indicates whether to keep or remove users from groups assigned by this rule.

Responses

202

Accepted

DELETE /api/v1/groups/rules/{ruleId}

DELETE /api/v1/groups/{groupId} Remove Group

Removes a group with OKTA_GROUP type from your organization.

operationId: Group_removeOperation

Parameters

Name	In	Required	Type	Description
groupId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/groups/{groupId}

DELETE /api/v1/groups/{groupId}/roles/{roleId}

Unassigns a Role from a Group

operationId: Group_unassignRole

Parameters

Name	In	Required	Type	Description
groupId	path	required	string	—
roleId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/groups/{groupId}/roles/{roleId}

DELETE /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}

Success

operationId: Group_deleteTargetGroupRolesCatalogApps

Parameters

Name	In	Required	Type	Description
groupId	path	required	string	—
roleId	path	required	string	—
appName	path	required	string	—

Responses

204

No Content

DELETE /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}

DELETE /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} Remove App Instance Target to App Administrator Role given to a Group

Remove App Instance Target to App Administrator Role given to a Group

operationId: Group_removeAppInstanceTargetToAppAdminRoleGivenToGroup

Parameters

Name	In	Required	Type	Description
groupId	path	required	string	—
roleId	path	required	string	—
appName	path	required	string	—
applicationId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}

DELETE /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}

operationId: Group_removeTargetGroup

Parameters

Name	In	Required	Type	Description
groupId	path	required	string	—
roleId	path	required	string	—
targetGroupId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}

DELETE /api/v1/groups/{groupId}/users/{userId} Remove User from Group

Removes a user from a group with ‘OKTA_GROUP’ type.

operationId: Group_removeUserFrom

Parameters

Name	In	Required	Type	Description
groupId	path	required	string	—
userId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/groups/{groupId}/users/{userId}

Identityprovider 4 endpoints

DELETE /api/v1/idps/credentials/keys/{keyId} Delete Key

Deletes a specific IdP Key Credential by kid if it is not currently being used by an Active or Inactive IdP.

operationId: IdentityProvider_deleteKeyCredential

Parameters

Name	In	Required	Type	Description
keyId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/idps/credentials/keys/{keyId}

DELETE /api/v1/idps/{idpId} Delete Identity Provider

Removes an IdP from your organization.

operationId: IdentityProvider_removeIdp

Parameters

Name	In	Required	Type	Description
idpId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/idps/{idpId}

DELETE /api/v1/idps/{idpId}/credentials/csrs/{csrId}

Revoke a Certificate Signing Request and delete the key pair from the IdP

operationId: IdentityProvider_revokeCsrForIdentityProvider

Parameters

Name	In	Required	Type	Description
idpId	path	required	string	—
csrId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/idps/{idpId}/credentials/csrs/{csrId}

DELETE /api/v1/idps/{idpId}/users/{userId} Unlink User from IdP

Removes the link between the Okta user and the IdP user.

operationId: IdentityProvider_unlinkUser

Parameters

Name	In	Required	Type	Description
idpId	path	required	string	—
userId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/idps/{idpId}/users/{userId}

Inlinehook 1 endpoints

DELETE /api/v1/inlineHooks/{inlineHookId}

Deletes the Inline Hook matching the provided id. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.

operationId: InlineHook_deleteMatchingById

Parameters

Name	In	Required	Type	Description
inlineHookId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/inlineHooks/{inlineHookId}

Linkedobject 1 endpoints

DELETE /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}

Success

operationId: LinkedObject_deleteUserLinkedObject

Parameters

Name	In	Required	Type	Description
linkedObjectName	path	required	string	—

Responses

204

No Content

DELETE /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}

Networkzone 1 endpoints

DELETE /api/v1/zones/{zoneId} Delete Network Zone

Removes network zone.

operationId: NetworkZone_removeZone

Parameters

Name	In	Required	Type	Description
zoneId	path	required	string	—

Responses

200

Success

DELETE /api/v1/zones/{zoneId}

Policy 2 endpoints

DELETE /api/v1/policies/{policyId}

Removes a policy.

operationId: Policy_removePolicyOperation

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—

Responses

200

Success

DELETE /api/v1/policies/{policyId}

DELETE /api/v1/policies/{policyId}/rules/{ruleId}

Removes a policy rule.

operationId: Policy_removeRule

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—
ruleId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/policies/{policyId}/rules/{ruleId}

Session 1 endpoints

DELETE /api/v1/sessions/{sessionId} Close Session

operationId: Session_close

Parameters

Name	In	Required	Type	Description
sessionId	path	required	string	—

Responses

204

No Content

400

Bad Request

404

Not Found

DELETE /api/v1/sessions/{sessionId}

Template 1 endpoints

DELETE /api/v1/templates/sms/{templateId} Remove SMS Template

Removes an SMS template.

operationId: Template_removeSms

Parameters

Name	In	Required	Type	Description
templateId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/templates/sms/{templateId}

Trustedorigin 1 endpoints

DELETE /api/v1/trustedOrigins/{trustedOriginId}

Success

operationId: TrustedOrigin_deleteSuccess

Parameters

Name	In	Required	Type	Description
trustedOriginId	path	required	string	—

Responses

200

Success

DELETE /api/v1/trustedOrigins/{trustedOriginId}

User 12 endpoints

DELETE /api/v1/users/{userId} Delete User

Deletes a user permanently. This operation can only be performed on users that have a DEPROVISIONED status. This action cannot be recovered!

operationId: User_deletePermanently

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
sendEmail	query	optional	boolean	—

Responses

202

ACCEPTED

DELETE /api/v1/users/{userId}

DELETE /api/v1/users/{userId}/clients/{clientId}/grants

Revokes all grants for the specified user and client

operationId: User_revokeGrantsForUserAndClient

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
clientId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/clients/{clientId}/grants

DELETE /api/v1/users/{userId}/clients/{clientId}/tokens

Revokes all refresh tokens issued for the specified User and Client.

operationId: User_revokeAllTokens

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
clientId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/clients/{clientId}/tokens

DELETE /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}

Revokes the specified refresh token.

operationId: User_revokeTokenForClient

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
clientId	path	required	string	—
tokenId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}

DELETE /api/v1/users/{userId}/grants

Revokes all grants for a specified user

operationId: User_revokeGrants

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/grants

DELETE /api/v1/users/{userId}/grants/{grantId}

Revokes one grant for a specified user

operationId: User_revokeGrant

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
grantId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/grants/{grantId}

DELETE /api/v1/users/{userId}/linkedObjects/{relationshipName}

Delete linked objects for a user, relationshipName can be ONLY a primary relationship name

operationId: User_deleteLinkedObjects

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
relationshipName	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/linkedObjects/{relationshipName}

DELETE /api/v1/users/{userId}/roles/{roleId}

Unassigns a role from a user.

operationId: User_unassignRole

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
roleId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/roles/{roleId}

DELETE /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}

Success

operationId: User_deleteTargetApp

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
roleId	path	required	string	—
appName	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}

DELETE /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} Remove App Instance Target to App Administrator Role given to a User

Remove App Instance Target to App Administrator Role given to a User

operationId: User_removeAppInstanceTargetToAppAdministratorRoleGivenTo

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
roleId	path	required	string	—
appName	path	required	string	—
applicationId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}

DELETE /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}

Success

operationId: User_removeTargetGroup

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
roleId	path	required	string	—
groupId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}

DELETE /api/v1/users/{userId}/sessions

Removes all active identity provider sessions. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.

operationId: User_revokeAllSessions

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
oauthTokens	query	optional	boolean	Revoke issued OpenID Connect and OAuth refresh and access tokens

Responses

204

No Content

DELETE /api/v1/users/{userId}/sessions

Userfactor 1 endpoints

DELETE /api/v1/users/{userId}/factors/{factorId}

Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.

operationId: UserFactor_unenrollFactor

Parameters

Name	In	Required	Type	Description
userId	path	required	string	—
factorId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/users/{userId}/factors/{factorId}

Usertype 1 endpoints

DELETE /api/v1/meta/types/user/{typeId}

Deletes a User Type permanently. This operation is not permitted for the default type, nor for any User Type that has existing users

operationId: UserType_deletePermanently

Parameters

Name	In	Required	Type	Description
typeId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/meta/types/user/{typeId}

Load more endpoints

Schemas

object AccessPolicy

{
  "x-okta-tags": [
    "Policy"
  ],
  "x-okta-parent": "#/definitions/Policy"
}

object AccessPolicyConstraint

{
  "type": "object",
  "properties": {
    "types": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "methods": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "reauthenticateIn": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object AccessPolicyConstraints

{
  "type": "object",
  "properties": {
    "knowledge": {
      "$ref": "#/components/schemas/KnowledgeConstraint"
    },
    "possession": {
      "$ref": "#/components/schemas/PossessionConstraint"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object 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"
}

object AccessPolicyRuleActions

{
  "type": "object",
  "properties": {
    "appSignOn": {
      "$ref": "#/components/schemas/AccessPolicyRuleApplicationSignOn"
    }
  },
  "x-okta-tags": [
    "Policy"
  ],
  "x-okta-parent": "#/definitions/PolicyRuleActions"
}

object AccessPolicyRuleApplicationSignOn

{
  "type": "object",
  "properties": {
    "access": {
      "type": "string"
    },
    "verificationMethod": {
      "$ref": "#/components/schemas/VerificationMethod"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object 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"
}

object AccessPolicyRuleCustomCondition

{
  "properties": {
    "condition": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object AcsEndpoint

{
  "properties": {
    "url": {
      "type": "string"
    },
    "index": {
      "type": "integer"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object ActivateFactorRequest

{
  "properties": {
    "passCode": {
      "type": "string"
    },
    "clientData": {
      "type": "string"
    },
    "stateToken": {
      "type": "string"
    },
    "attestation": {
      "type": "string"
    },
    "registrationData": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ]
}

string AllowedForEnum

{
  "enum": [
    "recovery",
    "sso",
    "any",
    "none"
  ],
  "type": "string",
  "x-okta-tags": [
    "Authenticator"
  ]
}

object AppAndInstanceConditionEvaluatorAppOrInstance

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "type": {
      "enum": [
        "APP_TYPE",
        "APP"
      ],
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object AppAndInstancePolicyRuleCondition

{
  "type": "object",
  "properties": {
    "exclude": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance"
      }
    },
    "include": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance"
      }
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object AppInstancePolicyRuleCondition

{
  "type": "object",
  "properties": {
    "exclude": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "include": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object 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"
  ]
}

object 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"
  ]
}

object AppUserCredentials

{
  "type": "object",
  "properties": {
    "password": {
      "$ref": "#/components/schemas/AppUserPasswordCredential"
    },
    "userName": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object AppUserPasswordCredential

{
  "properties": {
    "value": {
      "type": "string",
      "format": "password"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object 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"
  }
}

object ApplicationAccessibility

{
  "type": "object",
  "properties": {
    "selfService": {
      "type": "boolean"
    },
    "errorRedirectUrl": {
      "type": "string"
    },
    "loginRedirectUrl": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object ApplicationCredentials

{
  "type": "object",
  "properties": {
    "signing": {
      "$ref": "#/components/schemas/ApplicationCredentialsSigning"
    },
    "userNameTemplate": {
      "$ref": "#/components/schemas/ApplicationCredentialsUsernameTemplate"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object 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"
  ]
}

string 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"
  ]
}

object 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"
  ]
}

string ApplicationCredentialsSigningUse

{
  "enum": [
    "sig"
  ],
  "type": "string",
  "x-okta-tags": [
    "AuthorizationServer"
  ]
}

object ApplicationCredentialsUsernameTemplate

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "suffix": {
      "type": "string"
    },
    "template": {
      "type": "string"
    },
    "pushStatus": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object 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"
    }
  ]
}

object 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"
  ]
}

object ApplicationLicensing

{
  "type": "object",
  "properties": {
    "seatCount": {
      "type": "integer"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

array ApplicationListAppsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Application"
  }
}

array ApplicationListAssignedUsersResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AppUser"
  }
}

array ApplicationListClientSecretsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ClientSecret"
  }
}

array ApplicationListCsrsForApplicationResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Csr"
  }
}

array ApplicationListFeaturesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ApplicationFeature"
  }
}

array ApplicationListGroupsAssignedResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ApplicationGroupAssignment"
  }
}

array ApplicationListKeyCredentialsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/JsonWebKey"
  }
}

array ApplicationListScopeConsentGrantsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/OAuth2ScopeConsentGrant"
  }
}

array ApplicationListTokensResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/OAuth2Token"
  }
}

object 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"
            }
          }
        }
      }
    }
  }
}

object 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"
  ]
}

object 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"
  ]
}

object ApplicationSettingsNotes

{
  "type": "object",
  "properties": {
    "admin": {
      "type": "string"
    },
    "enduser": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object ApplicationSettingsNotifications

{
  "type": "object",
  "properties": {
    "vpn": {
      "$ref": "#/components/schemas/ApplicationSettingsNotificationsVpn"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object ApplicationSettingsNotificationsVpn

{
  "type": "object",
  "properties": {
    "helpUrl": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "network": {
      "$ref": "#/components/schemas/ApplicationSettingsNotificationsVpnNetwork"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object ApplicationSettingsNotificationsVpnNetwork

{
  "type": "object",
  "properties": {
    "exclude": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "include": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "connection": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

string 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"
  ]
}

object ApplicationUpdateLogoRequest

{
  "type": "object",
  "required": [
    "file"
  ],
  "properties": {
    "file": {
      "type": "string",
      "format": "binary"
    }
  }
}

object 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"
  ]
}

object ApplicationVisibilityHide

{
  "type": "object",
  "properties": {
    "iOS": {
      "type": "boolean"
    },
    "web": {
      "type": "boolean"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object AssignRoleRequest

{
  "properties": {
    "type": {
      "$ref": "#/components/schemas/RoleType"
    }
  },
  "x-okta-tags": [
    "Role"
  ]
}

Load more schemas

Versions

Version	Endpoints	Schemas	Ingested	Status
2.16.0	341	532	2026-05-25	current
2.16.0	341	532	2026-04-16