The Schemas API provides operations to manage custom User profiles as well as endpoints to discover the structure of the Log Stream configuration.
Okta's Universal Directory allows administrators to define custom User profiles for Okta Users and Applications. Okta adopts a subset of JSON Schema Draft 4 as the schema language to describe and validate extensible User profiles. For Log Stream Schemas, Okta uses JSON Schema Draft 2020-12. JSON Schema is a lightweight declarative format for describing the structure, constraints, and validation of JSON documents.
Note: Okta implements only a subset of JSON Schema Draft 4 and JSON Schema Draft 2020-12. This document describes which parts apply to Okta, and any extensions Okta has made to JSON Schema Draft 4 and JSON Schema Draft 2020-12.
okta.schemas.read
Retrieves the Schema for an App User
successful operation
Forbidden
Not Found
Too Many Requests
{- "$schema": "string",
- "created": "string",
- "definitions": {
- "base": {
- "id": "string",
- "properties": {
- "city": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "costCenter": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "countryCode": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "department": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "displayName": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "division": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "email": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "employeeNumber": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "firstName": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "honorificPrefix": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "honorificSuffix": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "lastName": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "locale": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "login": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "manager": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "managerId": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "middleName": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "mobilePhone": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "nickName": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "organization": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "postalAddress": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "preferredLanguage": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "primaryPhone": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "profileUrl": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "secondEmail": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "state": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "streetAddress": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "timezone": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "title": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "userType": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "zipCode": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}
}, - "required": [
- "string"
], - "type": "string"
}, - "custom": {
- "id": "string",
- "properties": {
- "property1": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}, - "property2": {
- "description": "string",
- "enum": [
- "string"
], - "externalName": "string",
- "externalNamespace": "string",
- "items": {
- "enum": [
- "string"
], - "oneOf": [
- {
- "const": null,
- "title": null
}
], - "type": "string"
}, - "master": {
- "priority": [
- {
- "type": null,
- "value": null
}
], - "type": "OKTA"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "oneOf": [
- {
- "const": "string",
- "title": "string"
}
], - "pattern": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "NONE",
- "title": "string",
- "type": "array",
- "union": "DISABLE",
- "unique": "string"
}
}, - "required": [
- "string"
], - "type": "string"
}
}, - "id": "string",
- "lastUpdated": "string",
- "name": "string",
- "properties": {
- "profile": {
- "allOf": [
- {
- "$ref": "string"
}
]
}
}, - "title": "string",
- "type": "string",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.schemas.manage
Partially updates on the User Profile properties of the Application User Schema
successful operation
Bad Request
Forbidden
Not Found
Too Many Requests
{- "definitions": {
- "custom": {
- "id": "#custom",
- "type": "object",
- "properties": {
- "twitterUserName": {
- "title": "Twitter username",
- "description": "User's username for twitter.com",
- "type": "string",
- "required": false,
- "minLength": 1,
- "maxLength": 20
}
}, - "required": [ ]
}
}
}
{- "name": "Example App",
- "title": "Example App User",
- "lastUpdated": "2017-07-18T23:18:43.000Z",
- "created": "2017-07-18T22:35:30.000Z",
- "definitions": {
- "base": {
- "id": "#base",
- "type": "object",
- "properties": {
- "userName": {
- "title": "Username",
- "type": "string",
- "required": true,
- "scope": "NONE",
- "maxLength": 100
}
}, - "required": [
- "userName"
]
}, - "custom": {
- "id": "#custom",
- "type": "object",
- "properties": {
- "twitterUserName": {
- "title": "Twitter username",
- "description": "User's username for twitter.com",
- "type": "string",
- "scope": "NONE",
- "minLength": 1,
- "maxLength": 20
}
}, - "required": [ ]
}
}, - "type": "object",
- "properties": {
- "profile": {
- "allOf": [
- {
- "$ref": "#/definitions/base"
}, - {
- "$ref": "#/definitions/custom"
}
]
}
}
}
okta.schemas.read
Retrieves the group schema
successful operation
Forbidden
Too Many Requests
{- "_links": {
- "self": {
- "method": "GET",
- "rel": "self"
}
}, - "created": "2021-01-30T00:18:24.000Z",
- "definitions": {
- "base": {
- "id": "#base",
- "properties": { },
- "required": [
- "name"
], - "type": "object"
}, - "custom": {
- "id": "#custom",
- "properties": {
- "groupContact": {
- "description": "Group administrative contact",
- "master": {
- "type": "PROFILE_MASTER"
}, - "mutability": "READ_WRITE",
- "permissions": [
- {
- "action": "READ_WRITE",
- "principal": "SELF"
}
], - "scope": "NONE",
- "title": "Group administrative contact",
- "type": "string"
}
}, - "required": [ ],
- "type": "object"
}
}, - "description": "Okta group profile template",
- "lastUpdated": "2021-02-25T23:05:31.000Z",
- "name": "group",
- "properties": {
- "profile": {
- "allOf": [
- {
- "$ref": "#/definitions/custom"
}, - {
- "$ref": "#/definitions/base"
}
]
}
}, - "title": "Okta group",
- "type": "object"
}
okta.schemas.manage
Updates the default group schema. This updates, adds, or removes one or more custom Group Profile properties in the schema.
successful operation
Bad Request
Forbidden
Too Many Requests
{- "definitions": {
- "custom": {
- "id": "#custom",
- "type": "object",
- "properties": {
- "groupContact": {
- "title": "Group administrative contact",
- "description": "Group administrative contact",
- "type": "string",
- "required": false,
- "minLength": 1,
- "maxLength": 20,
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}
}, - "required": [ ]
}
}
}
{- "Response with a subset of properties for brevity": {
- "$ref": "#/components/examples/GroupSchemaResponse"
}
}
okta.logStreams.read
Lists the schema for all log stream types visible for this org
successful operation
Forbidden
Too Many Requests
[- {
- "title": "AWS EventBridge",
- "type": "object",
- "properties": {
- "settings": {
- "description": "Configuration properties specific to AWS EventBridge",
- "type": "object",
- "properties": {
- "accountId": {
- "title": "AWS Account ID",
- "description": "Your Amazon AWS Account ID.",
- "type": "string",
- "writeOnce": true,
- "pattern": "^\\d{12}$"
}, - "eventSourceName": {
- "title": "AWS Event Source Name",
- "description": "An alphanumeric name (no spaces) to identify this event source in AWS EventBridge.",
- "type": "string",
- "writeOnce": true,
- "pattern": "^[\\.\\-_A-Za-z0-9]{1,75}$"
}, - "region": {
- "title": "AWS Region",
- "description": "The destination AWS region for your system log events.",
- "type": "string",
- "writeOnce": true,
- "oneOf": [
- {
- "title": "US East (Ohio)",
- "const": "us-east-2"
}, - {
- "title": "US East (N. Virginia)",
- "const": "us-east-1"
}, - {
- "title": "US West (N. California)",
- "const": "us-west-1"
}, - {
- "title": "US West (Oregon)",
- "const": "us-west-2"
}, - {
- "title": "Canada (Central)",
- "const": "ca-central-1"
}, - {
- "title": "Europe (Frankfurt)",
- "const": "eu-central-1"
}, - {
- "title": "Europe (Ireland)",
- "const": "eu-west-1"
}, - {
- "title": "Europe (London)",
- "const": "eu-west-2"
}, - {
- "title": "Europe (Paris)",
- "const": "eu-west-3"
}, - {
- "title": "Europe (Milan)",
- "const": "eu-south-1"
}, - {
- "title": "Europe (Stockholm)",
- "const": "eu-north-1"
}
]
}
}, - "required": [
- "eventSourceName",
- "accountId",
- "region"
], - "errorMessage": {
- "properties": {
- "accountId": "Account number must be 12 digits.",
- "eventSourceName": "Event source name can use numbers, letters, the symbols \".\", \"-\" or \"_\". It must use fewer than 76 characters."
}
}
}, - "name": {
- "title": "Name",
- "description": "A name for this log stream in Okta",
- "type": "string",
- "writeOnce": false,
- "pattern": "^.{1,100}$"
}
}, - "required": [
- "name",
- "settings"
], - "errorMessage": {
- "properties": {
- "name": "Name can't exceed 100 characters."
}
}
}, - {
- "title": "Splunk Cloud",
- "type": "object",
- "properties": {
- "settings": {
- "description": "Configuration properties specific to Splunk Cloud",
- "type": "object",
- "properties": {
- "host": {
- "title": "Host",
- "description": "The domain for your Splunk Cloud instance without http or https. For example: acme.splunkcloud.com",
- "type": "string",
- "writeOnce": false,
- "pattern": "^([a-z0-9]+(-[a-z0-9]+)*){1,100}\\.splunkcloud(gc|fed)?\\.com$"
}, - "token": {
- "title": "HEC Token",
- "description": "The token from your Splunk Cloud HTTP Event Collector (HEC).",
- "type": "string",
- "writeOnce": false,
- "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"
}
}, - "required": [
- "host",
- "token"
], - "errorMessage": {
- "properties": {
- "host": "Host should be a domain without http or https. For example: acme.splunkcloud.com"
}
}
}, - "name": {
- "title": "Name",
- "description": "A name for this log stream in Okta",
- "type": "string",
- "writeOnce": false,
- "pattern": "^.{1,100}$"
}
}, - "required": [
- "name",
- "settings"
], - "errorMessage": {
- "properties": {
- "name": "Name can't exceed 100 characters."
}
}
}
]
okta.logStreams.read
Retrieves the schema for a Log Stream type. The logStreamType
element in the URL specifies the Log Stream type, which is either aws_eventbridge
or splunk_cloud_logstreaming
. Use the aws_eventbridge
literal to retrieve the AWS EventBridge type schema, and use the splunk_cloud_logstreaming
literal retrieve the Splunk Cloud type schema.
logStreamType required | string (LogStreamType) Specifies the streaming provider used Supported providers:
Select the provider type to see provider-specific configurations in the |
successful operation
Forbidden
Not Found
Too Many Requests
{- "title": "AWS EventBridge",
- "type": "object",
- "properties": {
- "settings": {
- "description": "Configuration properties specific to AWS EventBridge",
- "type": "object",
- "properties": {
- "accountId": {
- "title": "AWS Account ID",
- "description": "Your Amazon AWS Account ID.",
- "type": "string",
- "writeOnce": true,
- "pattern": "^\\d{12}$"
}, - "eventSourceName": {
- "title": "AWS Event Source Name",
- "description": "An alphanumeric name (no spaces) to identify this event source in AWS EventBridge.",
- "type": "string",
- "writeOnce": true,
- "pattern": "^[\\.\\-_A-Za-z0-9]{1,75}$"
}, - "region": {
- "title": "AWS Region",
- "description": "The destination AWS region for your system log events.",
- "type": "string",
- "writeOnce": true,
- "oneOf": [
- {
- "title": "US East (Ohio)",
- "const": "us-east-2"
}, - {
- "title": "US East (N. Virginia)",
- "const": "us-east-1"
}, - {
- "title": "US West (N. California)",
- "const": "us-west-1"
}, - {
- "title": "US West (Oregon)",
- "const": "us-west-2"
}, - {
- "title": "Canada (Central)",
- "const": "ca-central-1"
}, - {
- "title": "Europe (Frankfurt)",
- "const": "eu-central-1"
}, - {
- "title": "Europe (Ireland)",
- "const": "eu-west-1"
}, - {
- "title": "Europe (London)",
- "const": "eu-west-2"
}, - {
- "title": "Europe (Paris)",
- "const": "eu-west-3"
}, - {
- "title": "Europe (Milan)",
- "const": "eu-south-1"
}, - {
- "title": "Europe (Stockholm)",
- "const": "eu-north-1"
}
]
}
}, - "required": [
- "eventSourceName",
- "accountId",
- "region"
], - "errorMessage": {
- "properties": {
- "accountId": "Account number must be 12 digits.",
- "eventSourceName": "Event source name can use numbers, letters, the symbols \".\", \"-\" or \"_\". It must use fewer than 76 characters."
}
}
}, - "name": {
- "title": "Name",
- "description": "A name for this log stream in Okta",
- "type": "string",
- "writeOnce": false,
- "pattern": "^.{1,100}$"
}
}, - "required": [
- "name",
- "settings"
], - "errorMessage": {
- "properties": {
- "name": "Name can't exceed 100 characters."
}
}
}
okta.schemas.read
Retrieves the schema for a Schema Id
Success
Forbidden
Not Found
Too Many Requests
{- "name": "user",
- "title": "Default Okta User",
- "lastUpdated": "2015-09-05T10:40:45.000Z",
- "created": "2015-02-02T10:27:36.000Z",
- "definitions": {
- "base": {
- "id": "#base",
- "type": "object",
- "properties": {
- "login": {
- "title": "Username",
- "type": "string",
- "required": true,
- "minLength": 5,
- "maxLength": 100,
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}, - "firstName": {
- "title": "First name",
- "type": "string",
- "required": true,
- "minLength": 1,
- "maxLength": 50,
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}, - "lastName": {
- "title": "Last name",
- "type": "string",
- "required": true,
- "minLength": 1,
- "maxLength": 50,
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}, - "email": {
- "title": "Primary email",
- "type": "string",
- "required": true,
- "format": "email",
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}
}, - "required": [
- "login",
- "firstName",
- "lastName",
- "email"
]
}, - "custom": {
- "id": "#custom",
- "type": "object",
- "properties": {
- "twitterUserName": {
- "title": "Twitter username",
- "description": "User's username for twitter.com",
- "type": "string",
- "required": false,
- "minLength": 1,
- "maxLength": 20,
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}
}, - "required": [ ]
}
}, - "type": "object",
- "properties": {
- "profile": {
- "allOf": [
- {
- "$ref": "#/definitions/base"
}, - {
- "$ref": "#/definitions/custom"
}
]
}
}
}
okta.schemas.manage
Partially updates on the User Profile properties of the user schema
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "definitions": {
- "custom": {
- "id": "#custom",
- "type": "object",
- "properties": {
- "twitterUserName": {
- "title": "Twitter username",
- "description": "Twitter Username",
- "type": "string",
- "required": false,
- "minLength": 1,
- "maxLength": 20,
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}
}, - "required": [ ]
}
}
}
{- "name": "user",
- "title": "Default Okta User",
- "lastUpdated": "2015-09-05T10:40:45.000Z",
- "created": "2015-02-02T10:27:36.000Z",
- "definitions": {
- "base": {
- "id": "#base",
- "type": "object",
- "properties": {
- "login": {
- "title": "Username",
- "type": "string",
- "required": true,
- "minLength": 5,
- "maxLength": 100,
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}, - "firstName": {
- "title": "First name",
- "type": "string",
- "required": true,
- "minLength": 1,
- "maxLength": 50,
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}, - "lastName": {
- "title": "Last name",
- "type": "string",
- "required": true,
- "minLength": 1,
- "maxLength": 50,
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}, - "email": {
- "title": "Primary email",
- "type": "string",
- "required": true,
- "format": "email",
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}
}, - "required": [
- "login",
- "firstName",
- "lastName",
- "email"
]
}, - "custom": {
- "id": "#custom",
- "type": "object",
- "properties": {
- "twitterUserName": {
- "title": "Twitter username",
- "description": "User's username for twitter.com",
- "type": "string",
- "required": false,
- "minLength": 1,
- "maxLength": 20,
- "permissions": [
- {
- "principal": "SELF",
- "action": "READ_WRITE"
}
]
}
}, - "required": [ ]
}
}, - "type": "object",
- "properties": {
- "profile": {
- "allOf": [
- {
- "$ref": "#/definitions/base"
}, - {
- "$ref": "#/definitions/custom"
}
]
}
}
}