{ "openapi": "3.1.0", "info": { "title": "IdRa management API", "version": "2026-10-31", "description": "Compatible with core Okta resources, not all of Okta's API. Limits of this file: Responses aren't described. They follow the shape of the matching Okta resource: check the [differences](/docs/admin-api#differences-from-okta). Request bodies aren't described for `POST /policies`, `PUT /policies/{id}`, `POST /policies/{id}/rules`, `PUT /policies/{id}/rules/{ruleId}`, because they're validated inside the handler. Query parameters are listed in the summary, or come from the route's schema where it has one. Paging and filters are in the [conventions](/docs/admin-api#conventions). Only `/api/v1`. The console's `/api/admin`, the OIDC and SAML endpoints under `/api/auth` and `/sso/saml`, the Okta path aliases under the issuer, and SCIM aren't here." }, "servers": [ { "url": "https://{org}/api/v1", "variables": { "org": { "default": "your-org.idra.team" } } } ], "components": { "securitySchemes": { "ssws": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "`SSWS `, with a token from Security → API → Tokens" }, "oauth": { "type": "http", "scheme": "bearer", "description": "A service app's OAuth access token" } } }, "paths": { "/users": { "get": { "summary": "List people. Query: `q`, `filter`, `search`, `limit`, `after`", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.read" ] } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create a person. Query: `activate`", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "firstName", "lastName", "email" ], "additionalProperties": {} }, "credentials": { "type": "object", "properties": { "password": { "type": "object", "properties": { "value": { "type": "string" } } } } }, "groupIds": { "default": [], "type": "array", "items": { "type": "string" } } }, "required": [ "profile" ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}": { "get": { "summary": "Get a person by ID or login", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Update a person, changing only the fields sent", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "credentials": { "type": "object", "properties": { "password": { "type": "object", "properties": { "value": { "type": "string" } } } } } } } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Replace a person's profile", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "credentials": { "type": "object", "properties": { "password": { "type": "object", "properties": { "value": { "type": "string" } } } } } } } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Deactivate a person. A second call deletes them", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/lifecycle/activate": { "post": { "summary": "Activate a person", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/lifecycle/reactivate": { "post": { "summary": "Reactivate a person", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/lifecycle/deactivate": { "post": { "summary": "Deactivate a person", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/lifecycle/suspend": { "post": { "summary": "Suspend a person", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/lifecycle/unsuspend": { "post": { "summary": "Unsuspend a person", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/lifecycle/unlock": { "post": { "summary": "Unlock a person", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/lifecycle/reset_password": { "post": { "summary": "Send a password reset to a person", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/lifecycle/reset_factors": { "post": { "summary": "Reset the factors of a person", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/credentials/change_password": { "post": { "summary": "Change a password, given the old one", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "oldPassword": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] }, "newPassword": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "required": [ "oldPassword", "newPassword" ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/groups": { "get": { "summary": "List a person's groups", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/appLinks": { "get": { "summary": "List a person's app links", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/factors": { "get": { "summary": "List a person's factors", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/factors/{factorId}": { "delete": { "summary": "Remove a factor", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "factorId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/sessions": { "delete": { "summary": "End a person's sessions", "security": [ { "ssws": [] }, { "oauth": [ "okta.users.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/roles": { "get": { "summary": "List a person's admin roles", "security": [ { "ssws": [] }, { "oauth": [ "okta.roles.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Assign an admin role", "security": [ { "ssws": [] }, { "oauth": [ "okta.roles.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/roles/{roleId}": { "delete": { "summary": "Remove an admin role", "security": [ { "ssws": [] }, { "oauth": [ "okta.roles.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/users/{id}/risk": { "get": { "summary": "Get a person's risk level", "security": [ { "ssws": [] }, { "oauth": [ "okta.userRisk.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Set a person's risk level", "security": [ { "ssws": [] }, { "oauth": [ "okta.userRisk.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "riskLevel": { "type": "string", "enum": [ "HIGH", "LOW" ] } }, "required": [ "riskLevel" ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/groups/rules": { "get": { "summary": "List group rules", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.read" ] } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create a group rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.manage" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "conditions": { "type": "object", "properties": { "expression": { "type": "object", "properties": { "value": { "type": "string", "maxLength": 4000 }, "type": { "type": "string" } }, "required": [ "value" ] }, "people": { "type": "object", "properties": { "users": { "type": "object", "properties": { "exclude": { "maxItems": 0, "type": "array", "items": { "type": "string" } } } }, "groups": { "type": "object", "properties": { "exclude": { "maxItems": 0, "type": "array", "items": { "type": "string" } } } } } } }, "required": [ "expression" ] }, "actions": { "type": "object", "properties": { "assignUserToGroups": { "type": "object", "properties": { "groupIds": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "groupIds" ] } }, "required": [ "assignUserToGroups" ] } }, "required": [ "name", "conditions", "actions" ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/groups/rules/{ruleId}": { "get": { "summary": "Get a group rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.read" ] } ], "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update a group rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.manage" ] } ], "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "conditions": { "type": "object", "properties": { "expression": { "type": "object", "properties": { "value": { "type": "string", "maxLength": 4000 }, "type": { "type": "string" } }, "required": [ "value" ] }, "people": { "type": "object", "properties": { "users": { "type": "object", "properties": { "exclude": { "maxItems": 0, "type": "array", "items": { "type": "string" } } } }, "groups": { "type": "object", "properties": { "exclude": { "maxItems": 0, "type": "array", "items": { "type": "string" } } } } } } }, "required": [ "expression" ] }, "actions": { "type": "object", "properties": { "assignUserToGroups": { "type": "object", "properties": { "groupIds": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "groupIds" ] } }, "required": [ "assignUserToGroups" ] } }, "required": [ "name", "conditions", "actions" ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete a group rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.manage" ] } ], "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/groups/rules/{ruleId}/lifecycle/activate": { "post": { "summary": "Activate a group rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.manage" ] } ], "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/groups/rules/{ruleId}/lifecycle/deactivate": { "post": { "summary": "Deactivate a group rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.manage" ] } ], "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/groups": { "get": { "summary": "List groups. Query: `q`, `filter`, `search`, `limit`, `after`", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.read" ] } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create a group", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.manage" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "name" ] } }, "required": [ "profile" ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/groups/{id}": { "get": { "summary": "Get a group", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update a group", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "name" ] } }, "required": [ "profile" ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete a group", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/groups/{id}/users": { "get": { "summary": "List a group's members", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/groups/{id}/users/{userId}": { "put": { "summary": "Add a member", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Remove a member", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/groups/{id}/apps": { "get": { "summary": "List apps assigned to a group", "security": [ { "ssws": [] }, { "oauth": [ "okta.groups.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/logs": { "get": { "summary": "Read the System Log. Query: `since`, `until`, `filter`, `q`, `sortOrder`, `limit`", "security": [ { "ssws": [] }, { "oauth": [ "okta.logs.read" ] } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}/grants": { "get": { "summary": "List a service app's `okta.*` scope grants", "security": [ { "ssws": [] }, { "oauth": [ "okta.appGrants.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Grant a service app an `okta.*` scope", "security": [ { "ssws": [] }, { "oauth": [ "okta.appGrants.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "issuer": { "type": "string" }, "scopeId": { "type": "string", "enum": [ "okta.users.read", "okta.users.manage", "okta.groups.read", "okta.groups.manage", "okta.logs.read", "okta.apps.read", "okta.apps.manage", "okta.authorizationServers.read", "okta.authorizationServers.manage", "okta.policies.read", "okta.policies.manage", "okta.networkZones.read", "okta.networkZones.manage", "okta.eventHooks.read", "okta.eventHooks.manage", "okta.devices.read", "okta.devices.manage", "okta.roles.read", "okta.roles.manage", "okta.userRisk.read", "okta.userRisk.manage", "okta.appGrants.read", "okta.appGrants.manage" ] } }, "required": [ "scopeId" ], "additionalProperties": {} } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}/grants/{scopeId}": { "delete": { "summary": "Remove a scope grant", "security": [ { "ssws": [] }, { "oauth": [ "okta.appGrants.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scopeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps": { "get": { "summary": "List apps", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.read" ] } ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create a bookmark, OIDC (web, browser, native, service) or SAML app", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.manage" ] } ], "parameters": [ { "name": "activate", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "_links": {}, "_embedded": {}, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "accessibility": { "type": "object", "properties": { "selfService": { "type": "boolean", "const": false } }, "additionalProperties": false }, "visibility": { "type": "object", "properties": { "autoSubmitToolbar": { "type": "boolean", "const": false }, "autoLaunch": { "type": "boolean", "const": false }, "hide": { "type": "object", "properties": { "iOS": { "type": "boolean" }, "web": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, "signOnMode": { "type": "string", "const": "BOOKMARK" }, "name": { "type": "string", "const": "bookmark" }, "settings": { "type": "object", "properties": { "app": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "requestIntegration": { "type": "boolean", "const": false } }, "required": [ "url" ], "additionalProperties": false }, "notes": { "type": "object", "properties": { "admin": { "type": "null" }, "enduser": { "type": "null" } }, "additionalProperties": false }, "implicitAssignment": { "type": "boolean", "const": false } }, "required": [ "app" ], "additionalProperties": false }, "credentials": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "label", "signOnMode", "name", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "_links": {}, "_embedded": {}, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "accessibility": { "type": "object", "properties": { "selfService": { "type": "boolean", "const": false } }, "additionalProperties": false }, "visibility": { "type": "object", "properties": { "autoSubmitToolbar": { "type": "boolean", "const": false }, "autoLaunch": { "type": "boolean", "const": false }, "hide": { "type": "object", "properties": { "iOS": { "type": "boolean" }, "web": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, "signOnMode": { "type": "string", "const": "OPENID_CONNECT" }, "name": { "type": "string", "const": "oidc_client" }, "settings": { "type": "object", "properties": { "oauthClient": { "type": "object", "properties": { "application_type": { "type": "string", "enum": [ "web", "browser", "native", "service" ] }, "redirect_uris": { "type": "array", "items": { "type": "string", "maxLength": 2048, "format": "uri" } }, "post_logout_redirect_uris": { "type": "array", "items": { "type": "string", "format": "uri" } }, "jwks": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "keys" ], "additionalProperties": false }, "jwks_uri": { "type": "string", "format": "uri" }, "refresh_token": { "type": "object", "properties": { "rotation_type": { "type": "string", "enum": [ "ROTATE", "STATIC" ] }, "leeway": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false }, "grant_types": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials", "urn:ietf:params:oauth:grant-type:device_code", "urn:ietf:params:oauth:grant-type:token-exchange", "urn:ietf:params:oauth:grant-type:jwt-bearer" ] } }, "response_types": { "type": "array", "items": { "type": "string", "enum": [ "code", "token" ] } }, "consent_method": { "type": "string", "enum": [ "REQUIRED", "TRUSTED" ] }, "initiate_login_uri": { "type": "string", "format": "uri" }, "issuer_mode": { "type": "string", "const": "ORG_URL" }, "wildcard_redirect": { "type": "string", "const": "DISABLED" }, "idp_initiated_login": { "type": "object", "properties": { "mode": { "type": "string", "const": "DISABLED" }, "default_scope": { "maxItems": 0, "type": "array", "items": { "type": "string" } } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "grant_types" ], "additionalProperties": false }, "app": { "type": "object", "properties": {}, "additionalProperties": false }, "notes": { "type": "object", "properties": { "admin": { "type": "null" }, "enduser": { "type": "null" } }, "additionalProperties": false }, "implicitAssignment": { "type": "boolean", "const": false } }, "required": [ "oauthClient" ], "additionalProperties": false }, "credentials": { "type": "object", "properties": { "oauthClient": { "type": "object", "properties": { "client_id": { "type": "string" }, "token_endpoint_auth_method": { "type": "string", "enum": [ "client_secret_basic", "client_secret_post", "private_key_jwt", "none" ] }, "autoKeyRotation": { "type": "boolean", "const": true }, "pkce_required": { "type": "boolean" } }, "additionalProperties": false }, "userNameTemplate": { "type": "object", "properties": { "template": { "type": "string", "const": "${source.login}" }, "type": { "type": "string", "const": "BUILT_IN" } }, "required": [ "template", "type" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "label", "signOnMode", "name", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "_links": {}, "_embedded": {}, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "accessibility": { "type": "object", "properties": { "selfService": { "type": "boolean", "const": false } }, "additionalProperties": false }, "visibility": { "type": "object", "properties": { "autoSubmitToolbar": { "type": "boolean", "const": false }, "autoLaunch": { "type": "boolean", "const": false }, "hide": { "type": "object", "properties": { "iOS": { "type": "boolean" }, "web": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, "signOnMode": { "type": "string", "const": "SAML_2_0" }, "name": { "type": "string" }, "settings": { "type": "object", "properties": { "signOn": { "type": "object", "properties": { "ssoAcsUrl": { "type": "string", "format": "uri" }, "audience": { "type": "string", "minLength": 1, "maxLength": 1024 }, "recipient": { "type": "string" }, "destination": { "type": "string" }, "spIssuer": { "type": "string", "minLength": 1, "maxLength": 1024 }, "ssoAcsUrlOverride": { "type": "string", "const": "" }, "recipientOverride": { "type": "string", "const": "" }, "destinationOverride": { "type": "string", "const": "" }, "audienceOverride": { "type": "string", "const": "" }, "subjectNameIdFormat": { "type": "string", "enum": [ "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent", "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", "urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName", "urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName", "urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos" ] }, "subjectNameIdTemplate": { "type": "string" }, "attributeStatements": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "type": { "default": "EXPRESSION", "type": "string", "enum": [ "EXPRESSION", "GROUP" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "namespace": { "type": "string", "const": "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified" }, "values": { "type": "array", "items": { "type": "string" } }, "filterType": { "type": "string", "const": "REGEX" }, "filterValue": { "type": "string", "const": ".*" } }, "required": [ "name" ], "additionalProperties": false } }, "defaultRelayState": { "type": "string", "maxLength": 1024 }, "responseSigned": { "type": "boolean" }, "assertionSigned": { "type": "boolean", "const": true }, "signatureAlgorithm": { "type": "string", "enum": [ "RSA_SHA256", "RSA_SHA512" ] }, "digestAlgorithm": { "type": "string", "enum": [ "SHA256", "SHA512" ] }, "honorForceAuthn": { "type": "boolean" }, "requestCompressed": { "type": "boolean", "const": false }, "allowMultipleAcsEndpoints": { "type": "boolean" }, "acsEndpoints": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "index": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "url", "index" ], "additionalProperties": false } }, "samlSignedRequestEnabled": { "type": "boolean" }, "authnContextClassRef": { "type": "string", "const": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport" }, "slo": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "logoutUrl": { "type": "string", "format": "uri" }, "issuer": { "type": "string" } }, "required": [ "enabled" ], "additionalProperties": false }, "spCertificate": { "type": "object", "properties": { "x5c": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "x5c" ], "additionalProperties": false } }, "required": [ "ssoAcsUrl", "audience" ], "additionalProperties": false }, "app": { "type": "object", "properties": {}, "additionalProperties": false }, "notes": { "type": "object", "properties": { "admin": { "type": "null" }, "enduser": { "type": "null" } }, "additionalProperties": false }, "implicitAssignment": { "type": "boolean", "const": false } }, "required": [ "signOn" ], "additionalProperties": false }, "credentials": { "type": "object", "properties": { "userNameTemplate": { "type": "object", "properties": { "template": { "type": "string", "const": "${source.login}" }, "type": { "type": "string", "const": "BUILT_IN" } }, "required": [ "template", "type" ], "additionalProperties": false }, "signing": { "type": "object", "properties": { "kid": { "type": "string", "const": "" } }, "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "label", "signOnMode", "settings" ], "additionalProperties": false } ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}": { "get": { "summary": "Get an app", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update an app", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "_links": {}, "_embedded": {}, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "accessibility": { "type": "object", "properties": { "selfService": { "type": "boolean", "const": false } }, "additionalProperties": false }, "visibility": { "type": "object", "properties": { "autoSubmitToolbar": { "type": "boolean", "const": false }, "autoLaunch": { "type": "boolean", "const": false }, "hide": { "type": "object", "properties": { "iOS": { "type": "boolean" }, "web": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, "signOnMode": { "type": "string", "const": "BOOKMARK" }, "name": { "type": "string", "const": "bookmark" }, "settings": { "type": "object", "properties": { "app": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "requestIntegration": { "type": "boolean", "const": false } }, "required": [ "url" ], "additionalProperties": false }, "notes": { "type": "object", "properties": { "admin": { "type": "null" }, "enduser": { "type": "null" } }, "additionalProperties": false }, "implicitAssignment": { "type": "boolean", "const": false } }, "required": [ "app" ], "additionalProperties": false }, "credentials": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "label", "signOnMode", "name", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "_links": {}, "_embedded": {}, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "accessibility": { "type": "object", "properties": { "selfService": { "type": "boolean", "const": false } }, "additionalProperties": false }, "visibility": { "type": "object", "properties": { "autoSubmitToolbar": { "type": "boolean", "const": false }, "autoLaunch": { "type": "boolean", "const": false }, "hide": { "type": "object", "properties": { "iOS": { "type": "boolean" }, "web": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, "signOnMode": { "type": "string", "const": "OPENID_CONNECT" }, "name": { "type": "string", "const": "oidc_client" }, "settings": { "type": "object", "properties": { "oauthClient": { "type": "object", "properties": { "application_type": { "type": "string", "enum": [ "web", "browser", "native", "service" ] }, "redirect_uris": { "type": "array", "items": { "type": "string", "maxLength": 2048, "format": "uri" } }, "post_logout_redirect_uris": { "type": "array", "items": { "type": "string", "format": "uri" } }, "jwks": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "keys" ], "additionalProperties": false }, "jwks_uri": { "type": "string", "format": "uri" }, "refresh_token": { "type": "object", "properties": { "rotation_type": { "type": "string", "enum": [ "ROTATE", "STATIC" ] }, "leeway": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false }, "grant_types": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials", "urn:ietf:params:oauth:grant-type:device_code", "urn:ietf:params:oauth:grant-type:token-exchange", "urn:ietf:params:oauth:grant-type:jwt-bearer" ] } }, "response_types": { "type": "array", "items": { "type": "string", "enum": [ "code", "token" ] } }, "consent_method": { "type": "string", "enum": [ "REQUIRED", "TRUSTED" ] }, "initiate_login_uri": { "type": "string", "format": "uri" }, "issuer_mode": { "type": "string", "const": "ORG_URL" }, "wildcard_redirect": { "type": "string", "const": "DISABLED" }, "idp_initiated_login": { "type": "object", "properties": { "mode": { "type": "string", "const": "DISABLED" }, "default_scope": { "maxItems": 0, "type": "array", "items": { "type": "string" } } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "grant_types" ], "additionalProperties": false }, "app": { "type": "object", "properties": {}, "additionalProperties": false }, "notes": { "type": "object", "properties": { "admin": { "type": "null" }, "enduser": { "type": "null" } }, "additionalProperties": false }, "implicitAssignment": { "type": "boolean", "const": false } }, "required": [ "oauthClient" ], "additionalProperties": false }, "credentials": { "type": "object", "properties": { "oauthClient": { "type": "object", "properties": { "client_id": { "type": "string" }, "token_endpoint_auth_method": { "type": "string", "enum": [ "client_secret_basic", "client_secret_post", "private_key_jwt", "none" ] }, "autoKeyRotation": { "type": "boolean", "const": true }, "pkce_required": { "type": "boolean" } }, "additionalProperties": false }, "userNameTemplate": { "type": "object", "properties": { "template": { "type": "string", "const": "${source.login}" }, "type": { "type": "string", "const": "BUILT_IN" } }, "required": [ "template", "type" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "label", "signOnMode", "name", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "_links": {}, "_embedded": {}, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "accessibility": { "type": "object", "properties": { "selfService": { "type": "boolean", "const": false } }, "additionalProperties": false }, "visibility": { "type": "object", "properties": { "autoSubmitToolbar": { "type": "boolean", "const": false }, "autoLaunch": { "type": "boolean", "const": false }, "hide": { "type": "object", "properties": { "iOS": { "type": "boolean" }, "web": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, "signOnMode": { "type": "string", "const": "SAML_2_0" }, "name": { "type": "string" }, "settings": { "type": "object", "properties": { "signOn": { "type": "object", "properties": { "ssoAcsUrl": { "type": "string", "format": "uri" }, "audience": { "type": "string", "minLength": 1, "maxLength": 1024 }, "recipient": { "type": "string" }, "destination": { "type": "string" }, "spIssuer": { "type": "string", "minLength": 1, "maxLength": 1024 }, "ssoAcsUrlOverride": { "type": "string", "const": "" }, "recipientOverride": { "type": "string", "const": "" }, "destinationOverride": { "type": "string", "const": "" }, "audienceOverride": { "type": "string", "const": "" }, "subjectNameIdFormat": { "type": "string", "enum": [ "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent", "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", "urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName", "urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName", "urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos" ] }, "subjectNameIdTemplate": { "type": "string" }, "attributeStatements": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "type": { "default": "EXPRESSION", "type": "string", "enum": [ "EXPRESSION", "GROUP" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "namespace": { "type": "string", "const": "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified" }, "values": { "type": "array", "items": { "type": "string" } }, "filterType": { "type": "string", "const": "REGEX" }, "filterValue": { "type": "string", "const": ".*" } }, "required": [ "name" ], "additionalProperties": false } }, "defaultRelayState": { "type": "string", "maxLength": 1024 }, "responseSigned": { "type": "boolean" }, "assertionSigned": { "type": "boolean", "const": true }, "signatureAlgorithm": { "type": "string", "enum": [ "RSA_SHA256", "RSA_SHA512" ] }, "digestAlgorithm": { "type": "string", "enum": [ "SHA256", "SHA512" ] }, "honorForceAuthn": { "type": "boolean" }, "requestCompressed": { "type": "boolean", "const": false }, "allowMultipleAcsEndpoints": { "type": "boolean" }, "acsEndpoints": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "index": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "url", "index" ], "additionalProperties": false } }, "samlSignedRequestEnabled": { "type": "boolean" }, "authnContextClassRef": { "type": "string", "const": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport" }, "slo": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "logoutUrl": { "type": "string", "format": "uri" }, "issuer": { "type": "string" } }, "required": [ "enabled" ], "additionalProperties": false }, "spCertificate": { "type": "object", "properties": { "x5c": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "x5c" ], "additionalProperties": false } }, "required": [ "ssoAcsUrl", "audience" ], "additionalProperties": false }, "app": { "type": "object", "properties": {}, "additionalProperties": false }, "notes": { "type": "object", "properties": { "admin": { "type": "null" }, "enduser": { "type": "null" } }, "additionalProperties": false }, "implicitAssignment": { "type": "boolean", "const": false } }, "required": [ "signOn" ], "additionalProperties": false }, "credentials": { "type": "object", "properties": { "userNameTemplate": { "type": "object", "properties": { "template": { "type": "string", "const": "${source.login}" }, "type": { "type": "string", "const": "BUILT_IN" } }, "required": [ "template", "type" ], "additionalProperties": false }, "signing": { "type": "object", "properties": { "kid": { "type": "string", "const": "" } }, "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "label", "signOnMode", "settings" ], "additionalProperties": false } ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete an inactive app", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}/credentials/keys": { "get": { "summary": "List a SAML app's signing certificates, shared across the tenant", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}/lifecycle/activate": { "post": { "summary": "Activate an app", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}/lifecycle/deactivate": { "post": { "summary": "Deactivate an app", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}/users": { "get": { "summary": "List people assigned to an app", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Assign a person to an app", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "scope": { "type": "string", "const": "USER" }, "credentials": { "type": "object", "properties": { "userName": { "type": "string" }, "password": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "profile": { "type": "object", "properties": {}, "additionalProperties": false }, "created": {}, "lastUpdated": {}, "status": {}, "_links": {} }, "required": [ "id" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}/users/{userId}": { "get": { "summary": "Get a person's assignment", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Remove a person's assignment", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}/groups": { "get": { "summary": "List groups assigned to an app", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}/groups/{groupId}": { "put": { "summary": "Assign a group to an app", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "get": { "summary": "Get a group's assignment", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Remove a group's assignment", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/apps/{id}/policies/{policyId}": { "put": { "summary": "Set an app's sign-on policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.apps.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers": { "get": { "summary": "List authorization servers", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.read" ] } ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create an authorization server", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "system": { "type": "boolean", "const": false }, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 1000 }, "audiences": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string" } }, "issuerMode": { "type": "string", "const": "ORG_URL" }, "issuer": {}, "credentials": {} }, "required": [ "name", "audiences" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}": { "get": { "summary": "Get an authorization server", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update an authorization server", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "system": { "type": "boolean", "const": false }, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 1000 }, "audiences": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string" } }, "issuerMode": { "type": "string", "const": "ORG_URL" }, "issuer": {}, "credentials": {} }, "required": [ "name", "audiences" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete an authorization server", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/lifecycle/activate": { "post": { "summary": "Activate an authorization server", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/lifecycle/deactivate": { "post": { "summary": "Deactivate an authorization server", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/scopes": { "get": { "summary": "List scopes", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create a scope", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "system": { "type": "boolean", "const": false }, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "description": { "type": "string", "maxLength": 1000 }, "displayName": { "type": "string", "maxLength": 300 }, "consent": { "type": "string", "const": "IMPLICIT" }, "metadataPublish": { "type": "string", "const": "ALL_CLIENTS" }, "default": { "type": "boolean", "const": false }, "optional": { "type": "boolean", "const": false } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/scopes/{scopeId}": { "get": { "summary": "Get a scope", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scopeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update a scope", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scopeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "system": { "type": "boolean", "const": false }, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "description": { "type": "string", "maxLength": 1000 }, "displayName": { "type": "string", "maxLength": 300 }, "consent": { "type": "string", "const": "IMPLICIT" }, "metadataPublish": { "type": "string", "const": "ALL_CLIENTS" }, "default": { "type": "boolean", "const": false }, "optional": { "type": "boolean", "const": false } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete a scope", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scopeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/claims": { "get": { "summary": "List claims", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create a claim", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": { "type": "string", "const": "ACTIVE" }, "system": { "type": "boolean", "const": false }, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "claimType": { "type": "string", "const": "RESOURCE" }, "valueType": { "type": "string", "const": "EXPRESSION" }, "value": { "type": "string", "minLength": 1, "maxLength": 1000 }, "alwaysIncludeInToken": { "type": "boolean", "const": true }, "conditions": { "type": "object", "properties": { "scopes": { "maxItems": 0, "type": "array", "items": { "type": "string" } } }, "required": [ "scopes" ], "additionalProperties": false } }, "required": [ "name", "claimType", "valueType", "value" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/claims/{claimId}": { "get": { "summary": "Get a claim", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update a claim", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": { "type": "string", "const": "ACTIVE" }, "system": { "type": "boolean", "const": false }, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "claimType": { "type": "string", "const": "RESOURCE" }, "valueType": { "type": "string", "const": "EXPRESSION" }, "value": { "type": "string", "minLength": 1, "maxLength": 1000 }, "alwaysIncludeInToken": { "type": "boolean", "const": true }, "conditions": { "type": "object", "properties": { "scopes": { "maxItems": 0, "type": "array", "items": { "type": "string" } } }, "required": [ "scopes" ], "additionalProperties": false } }, "required": [ "name", "claimType", "valueType", "value" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete a claim", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/policies": { "get": { "summary": "List access policies", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create an access policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": { "type": "string", "const": "ACTIVE" }, "system": { "type": "boolean", "const": false }, "_links": {}, "type": { "type": "string", "const": "OAUTH_AUTHORIZATION_POLICY" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 1000 }, "priority": { "type": "number", "const": 1 }, "conditions": { "type": "object", "properties": { "clients": { "type": "object", "properties": { "include": { "minItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "include" ], "additionalProperties": false } }, "required": [ "clients" ], "additionalProperties": false } }, "required": [ "type", "name", "conditions" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/policies/{policyId}": { "get": { "summary": "Get an access policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update an access policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": { "type": "string", "const": "ACTIVE" }, "system": { "type": "boolean", "const": false }, "_links": {}, "type": { "type": "string", "const": "OAUTH_AUTHORIZATION_POLICY" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 1000 }, "priority": { "type": "number", "const": 1 }, "conditions": { "type": "object", "properties": { "clients": { "type": "object", "properties": { "include": { "minItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "include" ], "additionalProperties": false } }, "required": [ "clients" ], "additionalProperties": false } }, "required": [ "type", "name", "conditions" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete an access policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/policies/{policyId}/lifecycle/activate": { "post": { "summary": "Activate an access policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/policies/{policyId}/lifecycle/deactivate": { "post": { "summary": "Deactivate an access policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/policies/{policyId}/rules": { "get": { "summary": "List access rules", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create an access rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "system": { "type": "boolean", "const": false }, "_links": {}, "type": { "type": "string", "const": "RESOURCE_ACCESS" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "priority": { "type": "integer", "minimum": 0, "maximum": 10000 }, "conditions": { "type": "object", "properties": { "people": { "type": "object", "properties": { "groups": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ], "additionalProperties": false }, "users": { "type": "object", "properties": { "include": { "maxItems": 0, "type": "array", "items": { "type": "string" } } }, "required": [ "include" ], "additionalProperties": false } }, "additionalProperties": false }, "grantTypes": { "type": "object", "properties": { "include": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials", "urn:ietf:params:oauth:grant-type:device_code", "urn:ietf:params:oauth:grant-type:token-exchange", "urn:ietf:params:oauth:grant-type:jwt-bearer" ] } } }, "required": [ "include" ], "additionalProperties": false }, "scopes": { "type": "object", "properties": { "include": { "minItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "include" ], "additionalProperties": false } }, "required": [ "grantTypes", "scopes" ], "additionalProperties": false }, "actions": { "type": "object", "properties": { "token": { "type": "object", "properties": { "accessTokenLifetimeMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "type", "name", "conditions" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/policies/{policyId}/rules/{ruleId}": { "get": { "summary": "Get an access rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update an access rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "system": { "type": "boolean", "const": false }, "_links": {}, "type": { "type": "string", "const": "RESOURCE_ACCESS" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "priority": { "type": "integer", "minimum": 0, "maximum": 10000 }, "conditions": { "type": "object", "properties": { "people": { "type": "object", "properties": { "groups": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ], "additionalProperties": false }, "users": { "type": "object", "properties": { "include": { "maxItems": 0, "type": "array", "items": { "type": "string" } } }, "required": [ "include" ], "additionalProperties": false } }, "additionalProperties": false }, "grantTypes": { "type": "object", "properties": { "include": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials", "urn:ietf:params:oauth:grant-type:device_code", "urn:ietf:params:oauth:grant-type:token-exchange", "urn:ietf:params:oauth:grant-type:jwt-bearer" ] } } }, "required": [ "include" ], "additionalProperties": false }, "scopes": { "type": "object", "properties": { "include": { "minItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "include" ], "additionalProperties": false } }, "required": [ "grantTypes", "scopes" ], "additionalProperties": false }, "actions": { "type": "object", "properties": { "token": { "type": "object", "properties": { "accessTokenLifetimeMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "type", "name", "conditions" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete an access rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/policies/{policyId}/rules/{ruleId}/lifecycle/activate": { "post": { "summary": "Activate an access rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/authorizationServers/{id}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate": { "post": { "summary": "Deactivate an access rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.authorizationServers.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/policies/simulate": { "post": { "summary": "Simulate which rules a person matches at an app", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "appInstance": { "type": "string", "minLength": 1 }, "policyTypes": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "OKTA_SIGN_ON", "ACCESS_POLICY", "MFA_ENROLL", "PROFILE_ENROLLMENT" ] } }, "policyContext": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ], "additionalProperties": false }, "groups": { "type": "object", "properties": { "ids": { "maxItems": 0, "type": "array", "items": { "type": "string" } } }, "required": [ "ids" ], "additionalProperties": false }, "risk": { "type": "object", "properties": { "level": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] } }, "required": [ "level" ], "additionalProperties": false }, "zones": { "type": "object", "properties": { "ids": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "ids" ], "additionalProperties": false }, "device": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "ANDROID", "IOS", "WINDOWS", "MACOS", "CHROMEOS", "LINUX" ] }, "registered": { "type": "boolean" }, "managed": { "type": "boolean" }, "assuranceId": { "type": "string", "minLength": 1 } }, "additionalProperties": false } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "appInstance", "policyContext" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/policies": { "get": { "summary": "List policies of a `type`: `OKTA_SIGN_ON`, `ACCESS_POLICY` or `PASSWORD`", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.read" ] } ], "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "OKTA_SIGN_ON", "ACCESS_POLICY", "PASSWORD", "MFA_ENROLL", "IDP_DISCOVERY", "PROFILE_ENROLLMENT", "POST_AUTH_SESSION", "ENTITY_RISK", "SESSION_VIOLATION_DETECTION", "DEVICE_SIGNAL_COLLECTION" ] } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] } }, { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "after", "in": "query", "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create a `PASSWORD` policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "parameters": [ { "name": "activate", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/policies/{id}": { "get": { "summary": "Get a policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update a policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete a policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/policies/{id}/lifecycle/activate": { "post": { "summary": "Activate a policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/policies/{id}/lifecycle/deactivate": { "post": { "summary": "Deactivate a policy", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/policies/{id}/rules": { "get": { "summary": "List a policy's rules", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create a rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "activate", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/policies/{id}/rules/{ruleId}": { "get": { "summary": "Get a rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update a rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete a rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/policies/{id}/rules/{ruleId}/lifecycle/activate": { "post": { "summary": "Activate a rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/policies/{id}/rules/{ruleId}/lifecycle/deactivate": { "post": { "summary": "Deactivate a rule", "security": [ { "ssws": [] }, { "oauth": [ "okta.policies.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/zones": { "get": { "summary": "List network zones", "security": [ { "ssws": [] }, { "oauth": [ "okta.networkZones.read" ] } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create an `IP` or `DYNAMIC` zone", "security": [ { "ssws": [] }, { "oauth": [ "okta.networkZones.manage" ] } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "system": { "type": "boolean", "const": false }, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "usage": { "default": "POLICY", "type": "string", "enum": [ "POLICY", "BLOCKLIST" ] }, "type": { "type": "string", "const": "IP" }, "gateways": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CIDR", "RANGE" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "proxies": { "anyOf": [ { "maxItems": 0, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CIDR", "RANGE" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ], "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "name", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "system": { "type": "boolean", "const": false }, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "usage": { "default": "POLICY", "type": "string", "enum": [ "POLICY", "BLOCKLIST" ] }, "type": { "type": "string", "const": "DYNAMIC" }, "locations": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "region": { "type": "null" } }, "required": [ "country" ], "additionalProperties": false } }, { "type": "null" } ] }, "asns": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "proxyType": { "type": "null" } }, "required": [ "name", "type" ], "additionalProperties": false } ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/zones/{id}": { "get": { "summary": "Get a zone", "security": [ { "ssws": [] }, { "oauth": [ "okta.networkZones.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update a zone", "security": [ { "ssws": [] }, { "oauth": [ "okta.networkZones.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "system": { "type": "boolean", "const": false }, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "usage": { "default": "POLICY", "type": "string", "enum": [ "POLICY", "BLOCKLIST" ] }, "type": { "type": "string", "const": "IP" }, "gateways": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CIDR", "RANGE" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "proxies": { "anyOf": [ { "maxItems": 0, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CIDR", "RANGE" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ], "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "name", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "id": {}, "created": {}, "lastUpdated": {}, "status": {}, "system": { "type": "boolean", "const": false }, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "usage": { "default": "POLICY", "type": "string", "enum": [ "POLICY", "BLOCKLIST" ] }, "type": { "type": "string", "const": "DYNAMIC" }, "locations": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "region": { "type": "null" } }, "required": [ "country" ], "additionalProperties": false } }, { "type": "null" } ] }, "asns": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "proxyType": { "type": "null" } }, "required": [ "name", "type" ], "additionalProperties": false } ] } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete a zone", "security": [ { "ssws": [] }, { "oauth": [ "okta.networkZones.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/zones/{id}/lifecycle/activate": { "post": { "summary": "Answers 200. Zones are always active", "security": [ { "ssws": [] }, { "oauth": [ "okta.networkZones.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/zones/{id}/lifecycle/deactivate": { "post": { "summary": "Answers 200 and changes nothing. Zones are always active", "security": [ { "ssws": [] }, { "oauth": [ "okta.networkZones.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/eventHooks": { "get": { "summary": "List event hooks", "security": [ { "ssws": [] }, { "oauth": [ "okta.eventHooks.read" ] } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "post": { "summary": "Create an event hook", "security": [ { "ssws": [] }, { "oauth": [ "okta.eventHooks.manage" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "createdBy": {}, "lastUpdated": {}, "status": {}, "verificationStatus": {}, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "anyOf": [ { "type": "string", "maxLength": 0 }, { "type": "null" } ] }, "events": { "type": "object", "properties": { "type": { "type": "string", "const": "EVENT_TYPE" }, "items": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "filter": { "type": "null" } }, "required": [ "type", "items" ], "additionalProperties": false }, "channel": { "type": "object", "properties": { "type": { "type": "string", "const": "HTTP" }, "version": { "type": "string", "const": "1.0.0" }, "config": { "type": "object", "properties": { "uri": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "authScheme": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "HEADER" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type", "key", "value" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "uri" ], "additionalProperties": false } }, "required": [ "type", "version", "config" ], "additionalProperties": false } }, "required": [ "name", "events", "channel" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/eventHooks/{id}": { "get": { "summary": "Get an event hook", "security": [ { "ssws": [] }, { "oauth": [ "okta.eventHooks.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "put": { "summary": "Update an event hook", "security": [ { "ssws": [] }, { "oauth": [ "okta.eventHooks.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": {}, "created": {}, "createdBy": {}, "lastUpdated": {}, "status": {}, "verificationStatus": {}, "_links": {}, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "anyOf": [ { "type": "string", "maxLength": 0 }, { "type": "null" } ] }, "events": { "type": "object", "properties": { "type": { "type": "string", "const": "EVENT_TYPE" }, "items": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "filter": { "type": "null" } }, "required": [ "type", "items" ], "additionalProperties": false }, "channel": { "type": "object", "properties": { "type": { "type": "string", "const": "HTTP" }, "version": { "type": "string", "const": "1.0.0" }, "config": { "type": "object", "properties": { "uri": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "authScheme": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "HEADER" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type", "key", "value" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "uri" ], "additionalProperties": false } }, "required": [ "type", "version", "config" ], "additionalProperties": false } }, "required": [ "name", "events", "channel" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete an inactive event hook", "security": [ { "ssws": [] }, { "oauth": [ "okta.eventHooks.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/eventHooks/{id}/lifecycle/activate": { "post": { "summary": "Activate an event hook", "security": [ { "ssws": [] }, { "oauth": [ "okta.eventHooks.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/eventHooks/{id}/lifecycle/deactivate": { "post": { "summary": "Deactivate an event hook", "security": [ { "ssws": [] }, { "oauth": [ "okta.eventHooks.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/eventHooks/{id}/lifecycle/verify": { "post": { "summary": "Verify the endpoint of an event hook", "security": [ { "ssws": [] }, { "oauth": [ "okta.eventHooks.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/devices": { "get": { "summary": "List devices. Query: `search`, `limit`, `after`", "security": [ { "ssws": [] }, { "oauth": [ "okta.devices.read" ] } ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "schema": { "not": {} } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/devices/{id}": { "get": { "summary": "Get a device", "security": [ { "ssws": [] }, { "oauth": [ "okta.devices.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } }, "delete": { "summary": "Delete a deactivated device", "security": [ { "ssws": [] }, { "oauth": [ "okta.devices.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/devices/{id}/users": { "get": { "summary": "List a device's user", "security": [ { "ssws": [] }, { "oauth": [ "okta.devices.read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/devices/{id}/lifecycle/activate": { "post": { "summary": "Activate a device", "security": [ { "ssws": [] }, { "oauth": [ "okta.devices.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/devices/{id}/lifecycle/deactivate": { "post": { "summary": "Deactivate a device", "security": [ { "ssws": [] }, { "oauth": [ "okta.devices.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/devices/{id}/lifecycle/suspend": { "post": { "summary": "Suspend a device", "security": [ { "ssws": [] }, { "oauth": [ "okta.devices.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } }, "/devices/{id}/lifecycle/unsuspend": { "post": { "summary": "Unsuspend a device", "security": [ { "ssws": [] }, { "oauth": [ "okta.devices.manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "The matching Okta resource, or an Okta error body. Not described here." } } } } } }