commit 32a091211f0129bd8b9ca1167da71dbecd98bc15 Author: a2a-platform Date: Sat Jun 27 01:03:51 2026 +0000 deploy diff --git a/README.md b/README.md new file mode 100644 index 0000000..fe1251d --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# okta-management-openapi-agent + +Generated A2APack agent for Okta Admin Management API. + +- Source OpenAPI: https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml +- Generated operations: 500 +- Main skill: `auto` +- Routing mode: DeepAgents subagents across 33 route groups + +The generated code is intentionally editable. Tune prompts, operation +grouping, auth names, and safety policy before publishing serious agents. diff --git a/a2a.yaml b/a2a.yaml new file mode 100644 index 0000000..af0b75e --- /dev/null +++ b/a2a.yaml @@ -0,0 +1,12 @@ +name: okta-management-openapi-agent +version: 2026.06.2 +entrypoint: agent:OktaManagementOpenapiAgent +description: Identity management API for users, groups, apps, orgs, and admin workflows. +runtime: + resources: + cpu: 200m + memory: 512Mi + egress: + allow_hosts: + - '{youroktadomain}' + deny_internet_by_default: true diff --git a/agent.py b/agent.py new file mode 100644 index 0000000..1d95dcf --- /dev/null +++ b/agent.py @@ -0,0 +1,435 @@ +from __future__ import annotations + +import base64 +import json +import re +from pathlib import Path +from typing import Any + +import httpx +from a2a_pack.deepagents import create_a2a_deep_agent +from langchain_core.messages import BaseMessage +from langchain_core.tools import StructuredTool +from pydantic import BaseModel, Field + +from a2a_pack import ( + A2AAgent, + ConsumerSetup, + ConsumerSetupField, + ConsumerSetupMissing, + EgressPolicy, + LLMProvisioning, + Pricing, + Resources, + RunContext, + skill, +) + + +DEFAULT_BASE_URL = "https://{yourOktaDomain}" +OPERATIONS = json.loads("{\n \"activate_agent_pools_update\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates a scheduled agent pool update\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_agent_pools_update\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the update\",\n \"in\": \"path\",\n \"name\": \"updateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/{updateId}/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_agent_pools_update\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate an agent pool update\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"activate_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates an inactive application\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate an application\",\n \"tags\": [\n \"Application\"\n ]\n },\n \"activate_authenticator\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates an authenticator by `authenticatorId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_authenticator\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_authenticator\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate an authenticator\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"activate_authenticator_method\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates a method for an authenticator identified by `authenticatorId` and `methodType`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_authenticator_method\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Type of authenticator method\",\n \"in\": \"path\",\n \"name\": \"methodType\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/components/schemas/AuthenticatorMethodType\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_authenticator_method\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate an authenticator method\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"activate_authorization_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates an authorization server\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_authorization_server\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_authorization_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate an authorization server\",\n \"tags\": [\n \"AuthorizationServer\"\n ]\n },\n \"activate_authorization_server_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates an authorization server policy\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_authorization_server_policy\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_authorization_server_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate a policy\",\n \"tags\": [\n \"AuthorizationServerPolicies\"\n ]\n },\n \"activate_authorization_server_policy_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates an authorization server policy rule\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_authorization_server_policy_rule\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy rule\",\n \"in\": \"path\",\n \"name\": \"ruleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"ruld3hJ7jZh4fn0st0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_authorization_server_policy_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate a policy rule\",\n \"tags\": [\n \"AuthorizationServerRules\"\n ]\n },\n \"activate_behavior_detection_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates a behavior detection rule\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_behavior_detection_rule\",\n \"parameters\": [\n {\n \"description\": \"ID of the Behavior Detection Rule\",\n \"in\": \"path\",\n \"name\": \"behaviorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"abcd1234\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/behaviors/{behaviorId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.behaviors.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_behavior_detection_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate a behavior detection rule\",\n \"tags\": [\n \"Behavior\"\n ]\n },\n \"activate_default_provisioning_connection_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates the default provisioning connection for an app\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_default_provisioning_connection_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/connections/default/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_default_provisioning_connection_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate the default provisioning connection\",\n \"tags\": [\n \"ApplicationConnections\"\n ]\n },\n \"activate_device\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates a device by setting its status to `ACTIVE` by `deviceId`.\\nActivated devices are used to create and delete device user links.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_device\",\n \"parameters\": [\n {\n \"description\": \"`id` of the device\",\n \"in\": \"path\",\n \"name\": \"deviceId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"guo4a5u7JHHhjXrMK0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/devices/{deviceId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devices.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_device\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate a device\",\n \"tags\": [\n \"Device\"\n ]\n },\n \"activate_device_integration\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates a device integration and populates the related configurations by `deviceIntegrationId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_device_integration\",\n \"parameters\": [\n {\n \"description\": \"The ID of the device integration\",\n \"in\": \"path\",\n \"name\": \"deviceIntegrationId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/device-integrations/{deviceIntegrationId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.deviceIntegrations.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_device_integration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate a device integration\",\n \"tags\": [\n \"DeviceIntegrations\"\n ]\n },\n \"activate_event_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates the event hook that matches the provided `id`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_event_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Event Hook\",\n \"in\": \"path\",\n \"name\": \"eventHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"who8vt36qfNpCGz9H1e6\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/eventHooks/{eventHookId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.eventHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_event_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate an event hook\",\n \"tags\": [\n \"EventHook\"\n ]\n },\n \"activate_group_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates a specific group rule by ID from your org\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_group_rule\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group rule\",\n \"in\": \"path\",\n \"name\": \"groupRuleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0pr3f7zMZZHPgUoWO0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/rules/{groupRuleId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_group_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate a group rule\",\n \"tags\": [\n \"GroupRule\"\n ]\n },\n \"activate_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates an inactive identity provider (IdP)\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate an IdP\",\n \"tags\": [\n \"IdentityProvider\"\n ]\n },\n \"activate_inline_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates the inline hook by `inlineHookId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_inline_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the inline hook\",\n \"in\": \"path\",\n \"name\": \"inlineHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"Y7Rzrd4g4xj6WdKzrBHH\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/inlineHooks/{inlineHookId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_inline_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate an inline hook\",\n \"tags\": [\n \"InlineHook\"\n ]\n },\n \"activate_log_stream\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates a log stream by `logStreamId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_log_stream\",\n \"parameters\": [\n {\n \"description\": \"Unique identifier for the log stream\",\n \"in\": \"path\",\n \"name\": \"logStreamId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa1orzg0CHSgPcjZ0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/logStreams/{logStreamId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.logStreams.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_log_stream\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate a log stream\",\n \"tags\": [\n \"LogStream\"\n ]\n },\n \"activate_o_auth2_client_json_web_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates an OAuth 2.0 client JSON Web Key by `keyId`\\n> **Note:** You can have only one active encryption key at any given time for an app. When you activate an inactive key, the current active key is automatically deactivated.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_o_auth2_client_json_web_key\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the OAuth 2.0 client JSON Web Key\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/jwks/{keyId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_o_auth2_client_json_web_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate an OAuth 2.0 client JSON Web Key\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"activate_o_auth2_client_secret\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates an OAuth 2.0 client secret by `secretId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_o_auth2_client_secret\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the OAuth 2.0 client secret\",\n \"in\": \"path\",\n \"name\": \"secretId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/secrets/{secretId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_o_auth2_client_secret\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate an OAuth 2.0 client secret\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"activate_o_auth2_resource_server_json_web_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Activates a custom authorization server public JSON web key by key `id`.\\n> **Note:** You can have only one active key at any given time for the authorization server. When you activate an inactive key, Okta automatically deactivates the current active key.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"activate_o_auth2_resource_server_json_web_key\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the Custom Authorization Server JSON Web Key\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}/lifecycle/activate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"activate_o_auth2_resource_server_json_web_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Activate a Custom Authorization Server Public JSON Web Key\",\n \"tags\": [\n \"OAuth2ResourceServerCredentialsKeys\"\n ]\n },\n \"add_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds a new group with the `OKTA_GROUP` type to your org.\\n> **Note:** App import operations are responsible for syncing groups with `APP_GROUP` type such as Active Directory groups. See\\n[About groups](https://help.okta.com/okta_help.htm?id=Directory_Groups) in the help documentation.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"add_group\",\n \"parameters\": [],\n \"path\": \"/api/v1/groups\",\n \"request_body\": {\n \"properties\": {\n \"profile\": {\n \"$ref\": \"#/components/schemas/OktaUserGroupProfile\"\n }\n }\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"add_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Add a group\",\n \"tags\": [\n \"Group\"\n ]\n },\n \"add_jwk\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds a new JSON Web Key to the client`s JSON Web Keys.\\n> **Note:** This API doesn't allow you to add a key if the existing key doesn't have a `kid`. This is also consistent with how the [Dynamic Client Registration](/openapi/okta-oauth/oauth/client) or [Applications](/openapi/okta-management/management/tags/application) APIs behave, as they don't allow the creation of multiple keys without `kids`. Use the [Replace an Application](/openapi/okta-management/management/application/replaceapplication) or the [Replace a Client Application](/openapi/okta-oauth/oauth/client/replaceclient) operation to update the JWKS or [Delete an OAuth 2.0 Client JSON Web Key](/openapi/okta-management/management/applicationssopublickeys/deletejwk) and re-add the key with a `kid`.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"add_jwk\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/jwks\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"$ref\": \"#/components/schemas/OAuth2ClientJsonSigningKeyRequest\"\n },\n {\n \"$ref\": \"#/components/schemas/OAuth2ClientJsonEncryptionKeyRequest\"\n }\n ],\n \"x-okta-ignore-redocly-rules-for-sdk\": true\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"add_jwk\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Add a JSON Web Key\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"add_members_to_binding\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds more members to a role resource set binding\",\n \"destructive\": true,\n \"method\": \"PATCH\",\n \"operation_id\": \"add_members_to_binding\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ResourceSetBindingAddMembersRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"add_members_to_binding\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Add more role resource set binding members\",\n \"tags\": [\n \"RoleDResourceSetBindingMember\"\n ]\n },\n \"add_o_auth2_resource_server_json_web_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds a new JSON Web Key to the custom authorization server`s JSON web keys.\\n> **Note:** This API doesn't allow you to add a key if the existing key doesn't have a `kid`. Use the [Replace an Authorization Server](/openapi/okta-management/management/authorizationserver/replaceauthorizationserver) operation to update the JWKS or [Delete a Custom Authorization Server Public JSON Web Key](/openapi/okta-management/management/oauth2resourceservercredentialskeys/deleteoauth2resourceserverjsonwebkey) and re-add the key with a `kid`.\\n> **Note:** This API doesn't allow you to add a key with an ACTIVE status. You need to add an INACTIVE key first, and then ACTIVATE the key.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"add_o_auth2_resource_server_json_web_key\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OAuth2ResourceServerJsonWebKeyRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"add_o_auth2_resource_server_json_web_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Add a JSON Web Key\",\n \"tags\": [\n \"OAuth2ResourceServerCredentialsKeys\"\n ]\n },\n \"add_resource_set_resource\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds a resource with conditions for a resource set\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"add_resource_set_resource\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ResourceSetResourcePostRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"add_resource_set_resource\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Add a resource set resource with conditions\",\n \"tags\": [\n \"RoleCResourceSetResource\"\n ]\n },\n \"add_resource_set_resources\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds more resources to a resource set\",\n \"destructive\": true,\n \"method\": \"PATCH\",\n \"operation_id\": \"add_resource_set_resources\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ResourceSetResourcePatchRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"add_resource_set_resources\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Add more resources to a resource set\",\n \"tags\": [\n \"RoleCResourceSetResource\"\n ]\n },\n \"assign_app_instance_target_to_app_admin_role_for_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Assigns an app instance target to an `APP_ADMIN` role assignment to a group. When you assign the first OIN app or app instance target, you reduce the scope of the role assignment.\\nThe role no longer applies to all app targets, but applies only to the specified target.\\n\\n> **Note:** You can target a mixture of both OIN app and app instance targets, but you can't assign permissions to manage all instances of an OIN app and then assign a subset of permissions to the same app.\\n> For example, you can't specify that an admin has access to manage all instances of the Salesforce app and then also manage specific configurations of the Salesforce app.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"assign_app_instance_target_to_app_admin_role_for_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the role assignment\",\n \"in\": \"path\",\n \"name\": \"roleAssignmentId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"JBCUYUC7IRCVGS27IFCE2SKO\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Name of the app definition (the OIN catalog app key name)\",\n \"in\": \"path\",\n \"name\": \"appName\",\n \"required\": true,\n \"schema\": {\n \"example\": \"google\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"assign_app_instance_target_to_app_admin_role_for_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Assign a group role app instance target\",\n \"tags\": [\n \"RoleBTargetBGroup\"\n ]\n },\n \"assign_app_target_to_admin_role_for_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Assigns an OIN app target to an `APP_ADMIN` role assignment to a group. When you assign the first OIN app target, you reduce the scope of the role assignment. The role no longer applies to all app targets, but applies only to the specified target. An OIN app target that's assigned to the role overrides any existing instance targets of the OIN app. For example, if a user is assigned to administer a specific Facebook instance, a successful request to add an OIN app with `facebook` for `appName` makes that user the administrator for all Facebook instances.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"assign_app_target_to_admin_role_for_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the role assignment\",\n \"in\": \"path\",\n \"name\": \"roleAssignmentId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"JBCUYUC7IRCVGS27IFCE2SKO\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Name of the app definition (the OIN catalog app key name)\",\n \"in\": \"path\",\n \"name\": \"appName\",\n \"required\": true,\n \"schema\": {\n \"example\": \"google\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"assign_app_target_to_admin_role_for_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Assign a group role app target\",\n \"tags\": [\n \"RoleBTargetBGroup\"\n ]\n },\n \"assign_application_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Assigns an app to an [app sign-in policy](/openapi/okta-management/management/tags/policy/), identified by `policyId`.\\nIf the app was previously assigned to another policy, this operation replaces that assignment with the updated policy identified by `policyId`.\\n\\n> **Note:** When you [merge duplicate app sign-in policies](https://help.okta.com/okta_help.htm?type=oie&id=ext-merge-auth-policies),\\nthe policy and mapping CRUD operations may be unavailable during the consolidation. When the consolidation is complete, you receive an email with merged results.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"assign_application_policy\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/policies/{policyId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"assign_application_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Assign an app sign-in policy\",\n \"tags\": [\n \"ApplicationPolicies\"\n ]\n },\n \"assign_group_owner\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Assigns a group owner\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"assign_group_owner\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/owners\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AssignGroupOwnerRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"assign_group_owner\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Assign a group owner\",\n \"tags\": [\n \"GroupOwner\"\n ]\n },\n \"assign_group_target_to_group_admin_role\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Assigns a group target to a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a group.\\nWhen you assign the first group target, you reduce the scope of the role assignment. The role no longer applies to all targets but applies only to the specified target.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"assign_group_target_to_group_admin_role\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the role assignment\",\n \"in\": \"path\",\n \"name\": \"roleAssignmentId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"JBCUYUC7IRCVGS27IFCE2SKO\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"targetGroupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1e9dfjHeLAsdX983d\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups/{targetGroupId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"assign_group_target_to_group_admin_role\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Assign a group role group target\",\n \"tags\": [\n \"RoleBTargetBGroup\"\n ]\n },\n \"assign_group_to_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Assigns a [Group](/openapi/okta-management/management/tags/group) to an app, which in turn assigns the app to each [User](/openapi/okta-management/management/tags/user) that belongs to the group.\\nThe resulting application user [scope](/openapi/okta-management/management/applicationusers/listapplicationusers#applicationusers/listapplicationusers/t=response&c=200&path=scope) is `GROUP` since the assignment was from the group membership.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"assign_group_to_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/groups/{groupId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ApplicationGroupAssignment\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"assign_group_to_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Assign an application group\",\n \"tags\": [\n \"ApplicationGroups\"\n ]\n },\n \"assign_role_to_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a group.\\n\\nYou can also assign a custom role to a group, but the preferred method to assign a custom role to a group is to create a binding between the custom role, the resource set, and the group. See [Create a role resource set binding](/openapi/okta-management/management/roledresourcesetbinding/createresourcesetbinding).\\n\\n> **Notes:**\\n> * The request payload is different for standard and custom role assignments.\\n> * For IAM-based standard role assignments, use the request payload for standard roles. However, the response payload for IAM-based role assignments is similar to the custom role's assignment response.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"assign_role_to_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Grants the group third-party admin status when set to `true`\",\n \"in\": \"query\",\n \"name\": \"disableNotifications\",\n \"required\": false,\n \"schema\": {\n \"default\": false,\n \"type\": \"boolean\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles\",\n \"request_body\": {\n \"discriminator\": {\n \"mapping\": {\n \"ACCESS_CERTIFICATIONS_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"ACCESS_REQUESTS_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"API_ACCESS_MANAGEMENT_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"APP_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"CUSTOM\": \"#/components/schemas/CustomRoleAssignmentSchema\",\n \"GROUP_MEMBERSHIP_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"HELP_DESK_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"ORG_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"READ_ONLY_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"REPORT_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"SUPER_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"USER_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\",\n \"WORKFLOWS_ADMIN\": \"#/components/schemas/StandardRoleAssignmentSchema\"\n },\n \"propertyName\": \"type\"\n },\n \"oneOf\": [\n {\n \"$ref\": \"#/components/schemas/StandardRoleAssignmentSchema\"\n },\n {\n \"$ref\": \"#/components/schemas/CustomRoleAssignmentSchema\"\n }\n ]\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"assign_role_to_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Assign a role to a group\",\n \"tags\": [\n \"RoleAssignmentBGroup\"\n ]\n },\n \"assign_user_to_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Assigns a user to an app for:\\n\\n * SSO only
\\n Assignments to SSO apps typically don't include a user profile.\\n However, if your SSO app requires a profile but doesn't have provisioning enabled, you can add profile attributes in the request body.\\n\\n * SSO and provisioning
\\n Assignments to SSO and provisioning apps typically include credentials and an app-specific profile.\\n Profile mappings defined for the app are applied first before applying any profile properties that are specified in the request body.\\n > **Notes:**\\n > * When Universal Directory is enabled, you can only specify profile properties that aren't defined in profile mappings.\\n > * Omit mapped properties during assignment to minimize assignment errors.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"assign_user_to_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/users\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AppUserAssignRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"assign_user_to_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Assign an application user\",\n \"tags\": [\n \"ApplicationUsers\"\n ]\n },\n \"assign_user_to_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Assigns a user to a group with the `OKTA_GROUP` type.\\n> **Note:** You only can modify memberships for groups of the `OKTA_GROUP` type. App imports are responsible for managing group memberships for groups of the `APP_GROUP` type, such as Active Directory groups.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"assign_user_to_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of an existing Okta user\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00ub0oNGTSWTBKOLGLNR\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/users/{userId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"assign_user_to_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Assign a user to a group\",\n \"tags\": [\n \"Group\"\n ]\n },\n \"bulk_remove_email_address_bounces\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Removes emails from an email service bounce list.\\n\\nThe emails submitted in this operation are removed from the bounce list by an asynchronous job.\\nAny email address that passes validation is accepted for the removal process, even if there are other email addresses in the request that failed validation.\\n\\n> **Note:** If there are validation errors for all email addresses, a `200 OK` HTTP status is still returned.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"bulk_remove_email_address_bounces\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/email/bounces/remove-list\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BouncesRemoveListObj\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"bulk_remove_email_address_bounces\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Remove bounced emails\",\n \"tags\": [\n \"EmailCustomization\"\n ]\n },\n \"clone_application_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Clones an X.509 certificate for an application key credential from a source app to a target app.\\n\\nFor step-by-step instructions to clone a credential, see [Share application key credentials for IdPs across apps](https://developer.okta.com/docs/guides/sharing-cert/main/).\\n> **Note:** Sharing certificates isn't a recommended security practice.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"clone_application_key\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the Key Credential for the application\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"sjP9eiETijYz110VkhHN\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique key of the target app\",\n \"in\": \"query\",\n \"name\": \"targetAid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0ouuytCAJSSDELFTUIDS\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/keys/{keyId}/clone\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"clone_application_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Clone a key credential\",\n \"tags\": [\n \"ApplicationSSOCredentialKey\"\n ]\n },\n \"clone_identity_provider_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Clones an X.509 certificate for an identity provider (IdP) signing key credential from a source IdP to target IdP\\n> **Caution:** Sharing certificates isn't a recommended security practice.\\n\\n> **Note:** If the key is already present in the list of key credentials for the target IdP, you receive a 400 error response.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"clone_identity_provider_key\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the IdP key credential\",\n \"in\": \"path\",\n \"name\": \"kid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"KmMo85SSsU7TZzOShcGb\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the target IdP\",\n \"in\": \"query\",\n \"name\": \"targetIdpId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/credentials/keys/{kid}/clone\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"clone_identity_provider_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Clone a signing key credential for IdP\",\n \"tags\": [\n \"IdentityProviderSigningKeys\"\n ]\n },\n \"create_agent_pools_update\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates an agent pool update\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_agent_pools_update\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AgentPoolUpdate\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_agent_pools_update\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an agent pool update\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"create_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates an app instance in your Okta org.\\n\\nYou can either create an OIN app instance or a custom app instance:\\n* OIN app instances have prescribed `name` (key app definition) and `signOnMode` options. See the [OIN schemas](/openapi/okta-management/management/application/googleapplication) for the request body.\\n* For custom app instances, select the [signOnMode](/openapi/okta-management/management/tags/application/other/createapplication#application/createapplication/t=request&path=&d=0/signonmode) that pertains to your app and specify the required parameters in the request body.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_application\",\n \"parameters\": [\n {\n \"description\": \"Executes activation lifecycle operation when creating the app\",\n \"in\": \"query\",\n \"name\": \"activate\",\n \"required\": false,\n \"schema\": {\n \"default\": true,\n \"type\": \"boolean\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"header\",\n \"name\": \"OktaAccessGateway-Agent\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/Application\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an application\",\n \"tags\": [\n \"Application\"\n ]\n },\n \"create_associated_servers\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates trusted relationships between the given authorization server and other authorization servers\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_associated_servers\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/associatedServers\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AssociatedServerMediated\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_associated_servers\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an associated authorization server\",\n \"tags\": [\n \"AuthorizationServerAssoc\"\n ]\n },\n \"create_authenticator\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates an authenticator\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_authenticator\",\n \"parameters\": [\n {\n \"description\": \"Whether to execute the activation lifecycle operation when Okta creates the authenticator\",\n \"in\": \"query\",\n \"name\": \"activate\",\n \"required\": false,\n \"schema\": {\n \"default\": true,\n \"type\": \"boolean\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators\",\n \"request_body\": {\n \"properties\": {},\n \"type\": \"object\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_authenticator\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an authenticator\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"create_authorization_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates an authorization server\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_authorization_server\",\n \"parameters\": [],\n \"path\": \"/api/v1/authorizationServers\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AuthorizationServer\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_authorization_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an authorization server\",\n \"tags\": [\n \"AuthorizationServer\"\n ]\n },\n \"create_authorization_server_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a policy\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_authorization_server_policy\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AuthorizationServerPolicy\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_authorization_server_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a policy\",\n \"tags\": [\n \"AuthorizationServerPolicies\"\n ]\n },\n \"create_authorization_server_policy_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a policy rule for the specified Custom Authorization Server and Policy\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_authorization_server_policy_rule\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AuthorizationServerPolicyRuleRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_authorization_server_policy_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a policy rule\",\n \"tags\": [\n \"AuthorizationServerRules\"\n ]\n },\n \"create_behavior_detection_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new behavior detection rule\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_behavior_detection_rule\",\n \"parameters\": [],\n \"path\": \"/api/v1/behaviors\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BehaviorRule\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.behaviors.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_behavior_detection_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a behavior detection rule\",\n \"tags\": [\n \"Behavior\"\n ]\n },\n \"create_brand\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new brand in your org\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_brand\",\n \"parameters\": [],\n \"path\": \"/api/v1/brands\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CreateBrandRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_brand\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a brand\",\n \"tags\": [\n \"Brands\"\n ]\n },\n \"create_captcha_instance\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new CAPTCHA instance. Currently, an org can only configure a single CAPTCHA instance.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_captcha_instance\",\n \"parameters\": [],\n \"path\": \"/api/v1/captchas\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CAPTCHAInstance\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.captchas.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_captcha_instance\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a CAPTCHA instance\",\n \"tags\": [\n \"CAPTCHA\"\n ]\n },\n \"create_cross_app_access_connection\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a Cross App Access connection\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_cross_app_access_connection\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/cwo/connections\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OrgCrossAppAccessConnection\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_cross_app_access_connection\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a Cross App Access connection\",\n \"tags\": [\n \"ApplicationCrossAppAccessConnections\"\n ]\n },\n \"create_custom_aaguid\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a custom AAGUID for the Passkey (FIDO2 WebAuthn) authenticator\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_custom_aaguid\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/aaguids\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CustomAAGUIDCreateRequestObject\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_custom_aaguid\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a custom AAGUID\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"create_custom_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates your custom domain\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_custom_domain\",\n \"parameters\": [],\n \"path\": \"/api/v1/domains\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/DomainRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.domains.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_custom_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a custom domain\",\n \"tags\": [\n \"CustomDomain\"\n ]\n },\n \"create_device_assurance_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new device assurance policy\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_device_assurance_policy\",\n \"parameters\": [],\n \"path\": \"/api/v1/device-assurances\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/DeviceAssurance\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.deviceAssurance.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_device_assurance_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a device assurance policy\",\n \"tags\": [\n \"DeviceAssurance\"\n ]\n },\n \"create_device_posture_check\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a device posture check\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_device_posture_check\",\n \"parameters\": [],\n \"path\": \"/api/v1/device-posture-checks\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/DevicePostureCheck\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devicePostureChecks.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_device_posture_check\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a device posture check\",\n \"tags\": [\n \"DevicePostureCheck\"\n ]\n },\n \"create_email_customization\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new Email Customization\\n\\n If Custom languages for Okta Email Templates is enabled, you can create a customization for any BCP47 language in addition to the Okta-supported languages.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_email_customization\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/EmailCustomization\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_email_customization\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an email customization\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"create_email_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates an Email Domain in your org\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_email_domain\",\n \"parameters\": [\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"brands\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/email-domains\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/EmailDomain\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailDomains.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_email_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an email domain\",\n \"tags\": [\n \"EmailDomain\"\n ]\n },\n \"create_email_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a custom email SMTP server configuration for your org.\\n\\nFor more information about configuring the OAuth 2.0 authentication methods, see [Custom email providers with OAuth 2.0](https://developer.okta.com/docs/guides/custom-smtp/main/).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_email_server\",\n \"parameters\": [],\n \"path\": \"/api/v1/email-servers\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BaseEmailServerCreate\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_email_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a custom SMTP server\",\n \"tags\": [\n \"EmailServer\"\n ]\n },\n \"create_event_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new event hook for your organization in `ACTIVE` status. You pass an event hook object in the JSON payload\\nof your request. That object represents the set of required information about the event hook you're registering, including:\\n * The URI of your external service\\n * The [events](https://developer.okta.com/docs/reference/api/event-types/) in Okta you want to subscribe to\\n * An optional event hook filter that can reduce the number of event hook calls. This is a self-service Early Access (EA) feature.\\n See [Create an event hook filter](https://developer.okta.com/docs/concepts/event-hooks/#create-an-event-hook-filter).\\n\\n Additionally, you can specify a secret API key for Okta to pass to your external service endpoint for security verification. Note that the API key you set here is unrelated to the Okta API token\\nyou must supply when making calls to Okta APIs. Optionally, you can specify extra headers that Okta passes to your external\\nservice with each call.\\nYour external service must use a valid HTTPS endpoint.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_event_hook\",\n \"parameters\": [],\n \"path\": \"/api/v1/eventHooks\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/EventHook\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.eventHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_event_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an event hook\",\n \"tags\": [\n \"EventHook\"\n ]\n },\n \"create_federated_claim\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_federated_claim\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/federated-claims\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/FederatedClaimRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_federated_claim\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a federated claim\",\n \"tags\": [\n \"ApplicationSSOFederatedClaims\"\n ]\n },\n \"create_governance_bundle\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a governance bundle of entitlements for the Admin Console\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_governance_bundle\",\n \"parameters\": [],\n \"path\": \"/api/v1/iam/governance/bundles\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/GovernanceBundleCreateRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_governance_bundle\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a governance bundle\",\n \"tags\": [\n \"GovernanceBundle\"\n ]\n },\n \"create_group_push_mapping\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates or links a group push mapping.\\n\\n**Note:** Either `targetGroupId` or `targetGroupName` must be provided, but not both. If `targetGroupId` is provided, it links to an existing group. If `targetGroupName` is provided, it creates a new group.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_group_push_mapping\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/group-push/mappings\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CreateGroupPushMappingRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\",\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_group_push_mapping\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a group push mapping\",\n \"tags\": [\n \"GroupPushMapping\"\n ]\n },\n \"create_group_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a group rule to dynamically add users to the specified group if they match the condition.\\n> **Note:** Group rules are created with the status set to `'INACTIVE'`.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_group_rule\",\n \"parameters\": [],\n \"path\": \"/api/v1/groups/rules\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CreateGroupRuleRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_group_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a group rule\",\n \"tags\": [\n \"GroupRule\"\n ]\n },\n \"create_hook_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a key for use with other parts of the application, such as inline hooks\\n\\n> **Note:** Use the key name to access this key for inline hook operations.\\n\\nThe total number of keys that you can create in an Okta org is limited to 50.\\n\\n The response is a [Key object](https://developer.okta.com/docs/reference/api/hook-keys/#key-object) that represents the\\n key that you create. The `id` property in the response serves as the unique ID for the key, which you can specify when\\n invoking other CRUD operations. The `keyId` provided in the response is the alias of the public key that you can use to get\\n details of the public key data in a separate call.\\n\\n> **Note:** The keyId is the alias of the public key that you can use to retrieve the public key.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_hook_key\",\n \"parameters\": [],\n \"path\": \"/api/v1/hook-keys\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/KeyRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_hook_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a key\",\n \"tags\": [\n \"HookKey\"\n ]\n },\n \"create_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new identity provider (IdP) integration.\\n\\n#### SAML 2.0 IdP\\n\\nYou must first add the IdP's signature certificate to the IdP key store before you can add a SAML 2.0 IdP with a `kid` credential reference.\\n\\nDon't use `fromURI` to automatically redirect a user to a particular app after successfully authenticating with a third-party IdP. Instead, use SAML deep links. Using `fromURI` isn't tested or supported. For more information about using deep links when signing users in using an SP-initiated flow, see [Understanding SP-Initiated Login flow](https://developer.okta.com/docs/concepts/saml/#understanding-sp-initiated-login-flow).\\n\\nUse SAML deep links to automatically redirect the user to an app after successfully authenticating with a third-party IdP. To use deep links, assemble these three parts into a URL:\\n\\n* SP ACS URL
\\nFor example: `https://${yourOktaDomain}/sso/saml2/:idpId`\\n* The app to which the user is automatically redirected after successfully authenticating with the IdP
\\nFor example: `/app/:app-location/:appId/sso/saml`\\n* Optionally, if the app is an outbound SAML app, you can specify the `relayState` passed to it.
\\nFor example: `?RelayState=:anyUrlEncodedValue`\\n\\nThe deep link for the above three parts is:
\\n`https://${yourOktaDomain}/sso/saml2/:idpId/app/:app-location/:appId/sso/saml?RelayState=:anyUrlEncodedValue`\\n\\n#### Smart Card X509 IdP\\n\\nYou must first add the IdP's server certificate to the IdP key store before you can add a Smart Card `X509` IdP with a `kid` credential reference.\\nYou need to upload the whole trust chain as a single key using the [Key Store API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProviderKeys/#tag/IdentityProviderKeys/operation/createIdentityProviderKey).\\nDepending on the information stored in the smart card, select the proper [template](https://developer.okta.com/docs/reference/okta-expression-language/#idp-user-profile) `idpuser.subjectAltNameEmail` or `idpuser.subjectAltNameUpn`.\\n\\n#### Identity verification vendors as identity providers\\n\\nIdentity verification (IDV) vendors work like IdPs, with a few key differences. IDV vendors verify your user's identities by requiring them to submit a proof of identity. There are many ways to verify user identities. For example, a proof of identity can be a selfie to determine liveliness or it can be requiring users to submit a photo of their driver's license and matching that information with a database.\\n\\nThere are three IDV vendors (Persona, CLEAR Verified, and Incode) with specific configuration settings and another IDV vendor type (Custom IDV) that lets you create a custom IDV vendor, using a [standardized IDV process](https://developer.okta.com/docs/guides/idv-integration/main/). You can configure each of the IDV vendors as IdPs in your org by creating an account with the vendor, and then creating an IdP integration. Control how the IDVs verify your users by using [Okta account management policy rules](https://developer.okta.com/docs/guides/okta-account-management-policy/main/).\\n\\n* [Persona](https://withpersona.com/)\\n\\n* [CLEAR Verified](https://www.clearme.com/)\\n\\n* [Incode](https://incode.com/)\\n\\n* [Custom IDV](https://help.okta.com/okta_help.htm?type=oie&id=idp-add-custom-idv-vendor)\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_identity_provider\",\n \"parameters\": [],\n \"path\": \"/api/v1/idps\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/IdentityProvider\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an IdP\",\n \"tags\": [\n \"IdentityProvider\"\n ]\n },\n \"create_identity_provider_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new X.509 certificate credential in the identity provider (IdP) key store\\n> **Note:** RSA-based certificates are supported for all IdP types. Okta currently supports EC-based certificates only for the `X509` IdP type. For EC-based certificates we support only P-256, P-384, and P-521 curves.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_identity_provider_key\",\n \"parameters\": [],\n \"path\": \"/api/v1/idps/credentials/keys\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/IdPCertificateCredential\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_identity_provider_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an IdP key credential\",\n \"tags\": [\n \"IdentityProviderKeys\"\n ]\n },\n \"create_identity_source_groups\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a group in an identity source for the given identity source instance\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_identity_source_groups\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/groups\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/GroupsRequestSchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_identity_source_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an identity source group\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"create_identity_source_groups_memberships\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates the group memberships for the given identity source group\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_identity_source_groups_memberships\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The Okta group ID or external ID of the identity source group\",\n \"in\": \"path\",\n \"name\": \"groupOrExternalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/MembershipRequestSchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_identity_source_groups_memberships\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create the memberships for the given identity source group\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"create_identity_source_session\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates an identity source session for the given identity source instance\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_identity_source_session\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_identity_source_session\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an identity source session\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"create_identity_source_user\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a user in an identity source for the given identity source instance\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_identity_source_user\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/users\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UserRequestSchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_identity_source_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an identity source user\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"create_inline_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates an inline hook\\n\\nThis endpoint creates an inline hook for your org in an `ACTIVE` status. You need to pass an inline hooks object in the JSON payload of your request.\\nThat object represents the set of required information about the inline hook that you're registering, including:\\n\\n* The URI of your external service endpoint\\n* The type of inline hook you're registering\\n* The type of authentication you're registering\\n\\nThere are two authentication options that you can configure for your inline hook: HTTP headers and OAuth 2.0 tokens.\\n\\nHTTP headers let you specify a secret API key that you want Okta to pass to your external service endpoint (so that your external service can check for its presence as a security measure).\\n\\n>**Note:** The API key that you set here is unrelated to the Okta API token you must supply when making calls to Okta APIs.\\n\\nYou can also optionally specify extra headers that you want Okta to pass to your external service with each call.\\n\\nTo configure HTTP header authentication, see parameters for the `config` object.\\n\\nOAuth 2.0 tokens provide enhanced security between Okta and your external service. You can configure these tokens for the following types—client secret and private key.\\n\\n>**Note:** Your external service's endpoint needs to be a valid HTTPS endpoint. The URI you specify should always begin with `https://`.\\n\\nThe total number of inline hooks that you can create in an Okta org is limited to 50, which is a combined total for any combination of inline hook types.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_inline_hook\",\n \"parameters\": [],\n \"path\": \"/api/v1/inlineHooks\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/InlineHookCreate\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_inline_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an inline hook\",\n \"tags\": [\n \"InlineHook\"\n ]\n },\n \"create_interclient_trust_mapping\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a mapping between the target app and an allowed app for interclient SSO using the interclient token\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_interclient_trust_mapping\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/interclient-allowed-apps\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/InterclientTrustMappingRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.interclientTrust.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_interclient_trust_mapping\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an allowed app mapping for a target app\",\n \"tags\": [\n \"ApplicationInterclientTrustMappings\"\n ]\n },\n \"create_linked_object_definition\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a Linked Object definition\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_linked_object_definition\",\n \"parameters\": [],\n \"path\": \"/api/v1/meta/schemas/user/linkedObjects\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/LinkedObject\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.linkedObjects.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_linked_object_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a linked object definition\",\n \"tags\": [\n \"LinkedObject\"\n ]\n },\n \"create_log_stream\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new log stream object\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_log_stream\",\n \"parameters\": [],\n \"path\": \"/api/v1/logStreams\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/LogStream\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.logStreams.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_log_stream\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a log stream\",\n \"tags\": [\n \"LogStream\"\n ]\n },\n \"create_o_auth2_claim\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a custom token Claim for a custom authorization server\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_o_auth2_claim\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/claims\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OAuth2Claim\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_o_auth2_claim\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a custom token claim\",\n \"tags\": [\n \"AuthorizationServerClaims\"\n ]\n },\n \"create_o_auth2_client_secret\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates an OAuth 2.0 client secret object with a new active client secret. You can create up to two secret objects. An error is returned if you attempt to create more than two secret objects.\\n> **Note:** This API lets you bring your own secret. If [token_endpoint_auth_method](/openapi/okta-oauth/oauth/client/createclient#client/createclient/t=request&path=token_endpoint_auth_method) of the app is `client_secret_jwt`, then the minimum length of `client_secret` is 32 characters. If no secret is specified in the request, Okta adds a new system-generated secret.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_o_auth2_client_secret\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/secrets\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OAuth2ClientSecretRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_o_auth2_client_secret\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create an OAuth 2.0 client secret\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"create_o_auth2_scope\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a custom token scope\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_o_auth2_scope\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/scopes\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OAuth2Scope\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_o_auth2_scope\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a custom token scope\",\n \"tags\": [\n \"AuthorizationServerScopes\"\n ]\n },\n \"create_resource_set\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new resource set. See [Supported resources](/openapi/okta-management/guides/roles/#supported-resources).\\n\\n> **Note:** The maximum number of `resources` allowed in a resource set object is 1000. Resources are identified by either an Okta Resource Name (ORN) or by a REST URL format. See [Okta Resource Name](/openapi/okta-management/guides/roles/#okta-resource-name-orn).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_resource_set\",\n \"parameters\": [],\n \"path\": \"/api/v1/iam/resource-sets\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CreateResourceSetRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_resource_set\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a resource set\",\n \"tags\": [\n \"RoleCResourceSet\"\n ]\n },\n \"create_resource_set_binding\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a binding for the resource set, custom role, and members (users or groups)\\n\\n> **Note:** If you use a custom role with permissions that don't apply to the resources in the resource set, it doesn't affect the admin role. For example,\\n the `okta.users.userprofile.manage` permission gives the admin no privileges if it's granted to a resource set that only includes `https://{yourOktaDomain}/api/v1/groups/{targetGroupId}`\\n resources. If you want the admin to be able to manage the users within the group, the resource set must include the corresponding `https://{yourOktaDomain}/api/v1/groups/{targetGroupId}/users` resource.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_resource_set_binding\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ResourceSetBindingCreateRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_resource_set_binding\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a role resource set binding\",\n \"tags\": [\n \"RoleDResourceSetBinding\"\n ]\n },\n \"create_role\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a custom role\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_role\",\n \"parameters\": [],\n \"path\": \"/api/v1/iam/roles\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CreateIamRoleRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_role\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a custom role\",\n \"tags\": [\n \"RoleECustom\"\n ]\n },\n \"create_role_permission\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a permission (specified by `permissionType`) for a custom role\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_role_permission\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An Okta [permission](/openapi/okta-management/guides/permissions)\",\n \"in\": \"path\",\n \"name\": \"permissionType\",\n \"required\": true,\n \"schema\": {\n \"example\": \"okta.users.manage\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CreateUpdateIamRolePermissionRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_role_permission\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a custom role permission\",\n \"tags\": [\n \"RoleECustomPermission\"\n ]\n },\n \"create_ui_schema\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates an input for an enrollment form\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_ui_schema\",\n \"parameters\": [],\n \"path\": \"/api/v1/meta/uischemas\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CreateUISchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.uischemas.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_ui_schema\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a UI schema\",\n \"tags\": [\n \"UISchema\"\n ]\n },\n \"create_user_type\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a new user type. Okta automatically creates a `default` user type for your org. You may add up to nine additional user types.\\n> **Note**: New user types are based on the current default schema template. Modifications to this schema do not automatically propagate to previously created user types.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_user_type\",\n \"parameters\": [],\n \"path\": \"/api/v1/meta/types/user\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UserType\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.userTypes.manage\"\n ]\n }\n ],\n \"skill_name\": \"create_user_type\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Create a user type\",\n \"tags\": [\n \"UserType\"\n ]\n },\n \"deactivate_agent_pools_update\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates scheduled agent pool update\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_agent_pools_update\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the update\",\n \"in\": \"path\",\n \"name\": \"updateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/{updateId}/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_agent_pools_update\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate an agent pool update\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"deactivate_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates an active application\\n\\n> **Note:** Deactivating an app triggers a full reconciliation of all users assigned to the app by groups. This reconcile process removes the app assignment for the deactivated app, and might also correct assignments that were supposed to be removed but failed previously.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate an application\",\n \"tags\": [\n \"Application\"\n ]\n },\n \"deactivate_authenticator\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates an authenticator by `authenticatorId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_authenticator\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_authenticator\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate an authenticator\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"deactivate_authenticator_method\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates a method for an authenticator identified by `authenticatorId` and `methodType`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_authenticator_method\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Type of authenticator method\",\n \"in\": \"path\",\n \"name\": \"methodType\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/components/schemas/AuthenticatorMethodType\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_authenticator_method\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate an authenticator method\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"deactivate_authorization_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates an authorization server\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_authorization_server\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_authorization_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate an authorization server\",\n \"tags\": [\n \"AuthorizationServer\"\n ]\n },\n \"deactivate_authorization_server_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates an authorization server policy\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_authorization_server_policy\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_authorization_server_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate a policy\",\n \"tags\": [\n \"AuthorizationServerPolicies\"\n ]\n },\n \"deactivate_authorization_server_policy_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates an authorization server policy rule\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_authorization_server_policy_rule\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy rule\",\n \"in\": \"path\",\n \"name\": \"ruleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"ruld3hJ7jZh4fn0st0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_authorization_server_policy_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate a policy rule\",\n \"tags\": [\n \"AuthorizationServerRules\"\n ]\n },\n \"deactivate_behavior_detection_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates a behavior detection rule\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_behavior_detection_rule\",\n \"parameters\": [\n {\n \"description\": \"ID of the Behavior Detection Rule\",\n \"in\": \"path\",\n \"name\": \"behaviorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"abcd1234\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/behaviors/{behaviorId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.behaviors.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_behavior_detection_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate a behavior detection rule\",\n \"tags\": [\n \"Behavior\"\n ]\n },\n \"deactivate_default_provisioning_connection_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates the default provisioning connection for an app\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_default_provisioning_connection_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/connections/default/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_default_provisioning_connection_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate the default provisioning connection\",\n \"tags\": [\n \"ApplicationConnections\"\n ]\n },\n \"deactivate_device\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates a device by setting its status to `DEACTIVATED` by `deviceId`.\\nDeactivation causes a device to lose all device user links. Set the device status to `DEACTIVATED` before deleting it.\\n> **Note:** When deactivating a Device, keep in mind the following:\\n - Device deactivation is a destructive operation for device factors and client certificates. Device reenrollment using Okta Verify allows end users to set up new factors on the device.\\n - Device deletion removes the device record from Okta. Reenrollment creates a new device record.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_device\",\n \"parameters\": [\n {\n \"description\": \"`id` of the device\",\n \"in\": \"path\",\n \"name\": \"deviceId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"guo4a5u7JHHhjXrMK0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/devices/{deviceId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devices.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_device\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate a device\",\n \"tags\": [\n \"Device\"\n ]\n },\n \"deactivate_device_integration\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates a device integration by `deviceIntegrationId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_device_integration\",\n \"parameters\": [\n {\n \"description\": \"The ID of the device integration\",\n \"in\": \"path\",\n \"name\": \"deviceIntegrationId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/device-integrations/{deviceIntegrationId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.deviceIntegrations.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_device_integration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate a device integration\",\n \"tags\": [\n \"DeviceIntegrations\"\n ]\n },\n \"deactivate_event_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates the event hook that matches the provided `id`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_event_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Event Hook\",\n \"in\": \"path\",\n \"name\": \"eventHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"who8vt36qfNpCGz9H1e6\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/eventHooks/{eventHookId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.eventHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_event_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate an event hook\",\n \"tags\": [\n \"EventHook\"\n ]\n },\n \"deactivate_group_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates a specific group rule by ID from your org\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_group_rule\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group rule\",\n \"in\": \"path\",\n \"name\": \"groupRuleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0pr3f7zMZZHPgUoWO0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/rules/{groupRuleId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_group_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate a group rule\",\n \"tags\": [\n \"GroupRule\"\n ]\n },\n \"deactivate_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates an active identity provider (IdP)\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate an IdP\",\n \"tags\": [\n \"IdentityProvider\"\n ]\n },\n \"deactivate_inline_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates the inline hook by `inlineHookId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_inline_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the inline hook\",\n \"in\": \"path\",\n \"name\": \"inlineHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"Y7Rzrd4g4xj6WdKzrBHH\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_inline_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate an inline hook\",\n \"tags\": [\n \"InlineHook\"\n ]\n },\n \"deactivate_log_stream\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates a log stream by `logStreamId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_log_stream\",\n \"parameters\": [\n {\n \"description\": \"Unique identifier for the log stream\",\n \"in\": \"path\",\n \"name\": \"logStreamId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa1orzg0CHSgPcjZ0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/logStreams/{logStreamId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.logStreams.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_log_stream\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate a log stream\",\n \"tags\": [\n \"LogStream\"\n ]\n },\n \"deactivate_o_auth2_client_json_web_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates an OAuth 2.0 client JSON Web Key by `keyId`\\n> **Note:** You can only deactivate signing keys. Deactivating the active encryption key isn't allowed if the client has ID token encryption enabled. You can activate another encryption key, which makes the current key inactive.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_o_auth2_client_json_web_key\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the OAuth 2.0 client JSON Web Key\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/jwks/{keyId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_o_auth2_client_json_web_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate an OAuth 2.0 client JSON Web Key\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"deactivate_o_auth2_client_secret\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates an OAuth 2.0 client secret by `secretId`. You can't deactivate a secret if it's the only secret of the client.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_o_auth2_client_secret\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the OAuth 2.0 client secret\",\n \"in\": \"path\",\n \"name\": \"secretId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/secrets/{secretId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_o_auth2_client_secret\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate an OAuth 2.0 client secret\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"deactivate_o_auth2_resource_server_json_web_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deactivates a custom authorization server public JSON web key by key `id`.\\n> **Note:** Deactivating the active key isn't allowed if the authorization server has access token encryption enabled. You can activate another key, which makes the current key inactive.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"deactivate_o_auth2_resource_server_json_web_key\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the Custom Authorization Server JSON Web Key\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}/lifecycle/deactivate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"deactivate_o_auth2_resource_server_json_web_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Deactivate a Custom Authorization Server Public JSON Web Key\",\n \"tags\": [\n \"OAuth2ResourceServerCredentialsKeys\"\n ]\n },\n \"delete_agent_pools_update\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes agent pool update\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_agent_pools_update\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the update\",\n \"in\": \"path\",\n \"name\": \"updateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/{updateId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_agent_pools_update\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an agent pool update\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"delete_all_customizations\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes all customizations for an email template\\n\\n If Custom languages for Okta Email Templates is enabled, all customizations are deleted, including customizations for additional languages. If disabled, only customizations in Okta-supported languages are deleted.\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_all_customizations\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_all_customizations\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete all email customizations\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"delete_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an inactive application\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an application\",\n \"tags\": [\n \"Application\"\n ]\n },\n \"delete_associated_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an associated Authorization Server\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_associated_server\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the associated Authorization Server\",\n \"in\": \"path\",\n \"name\": \"associatedServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aus6xt9jKPmCyn6kg0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/associatedServers/{associatedServerId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_associated_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an associated authorization server\",\n \"tags\": [\n \"AuthorizationServerAssoc\"\n ]\n },\n \"delete_authorization_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an authorization server\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_authorization_server\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_authorization_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an authorization server\",\n \"tags\": [\n \"AuthorizationServer\"\n ]\n },\n \"delete_authorization_server_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a policy\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_authorization_server_policy\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_authorization_server_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a policy\",\n \"tags\": [\n \"AuthorizationServerPolicies\"\n ]\n },\n \"delete_authorization_server_policy_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_authorization_server_policy_rule\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy rule\",\n \"in\": \"path\",\n \"name\": \"ruleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"ruld3hJ7jZh4fn0st0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_authorization_server_policy_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a policy rule\",\n \"tags\": [\n \"AuthorizationServerRules\"\n ]\n },\n \"delete_behavior_detection_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a Behavior Detection Rule by `behaviorId`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_behavior_detection_rule\",\n \"parameters\": [\n {\n \"description\": \"ID of the Behavior Detection Rule\",\n \"in\": \"path\",\n \"name\": \"behaviorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"abcd1234\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/behaviors/{behaviorId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.behaviors.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_behavior_detection_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a behavior detection rule\",\n \"tags\": [\n \"Behavior\"\n ]\n },\n \"delete_binding\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a binding of a role (identified by `roleIdOrLabel`) and a resource set (identified by `resourceSetIdOrLabel`)\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_binding\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_binding\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a role resource set binding\",\n \"tags\": [\n \"RoleDResourceSetBinding\"\n ]\n },\n \"delete_brand\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a brand by `brandId`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_brand\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_brand\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a brand\",\n \"tags\": [\n \"Brands\"\n ]\n },\n \"delete_brand_theme_background_image\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a theme background image\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_brand_theme_background_image\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the theme\",\n \"in\": \"path\",\n \"name\": \"themeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/themes/{themeId}/background-image\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_brand_theme_background_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete the background image\",\n \"tags\": [\n \"Themes\"\n ]\n },\n \"delete_brand_theme_favicon\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a theme favicon. The theme will use the default Okta favicon.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_brand_theme_favicon\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the theme\",\n \"in\": \"path\",\n \"name\": \"themeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/themes/{themeId}/favicon\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_brand_theme_favicon\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete the favicon\",\n \"tags\": [\n \"Themes\"\n ]\n },\n \"delete_brand_theme_logo\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a Theme logo. The theme will use the default Okta logo.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_brand_theme_logo\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the theme\",\n \"in\": \"path\",\n \"name\": \"themeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/themes/{themeId}/logo\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_brand_theme_logo\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete the logo\",\n \"tags\": [\n \"Themes\"\n ]\n },\n \"delete_captcha_instance\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a specified CAPTCHA instance\\n> **Note:** If your CAPTCHA instance is still associated with your org, the request fails. You must first update your Org-wide CAPTCHA settings to remove the CAPTCHA instance.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_captcha_instance\",\n \"parameters\": [\n {\n \"description\": \"The unique key used to identify your CAPTCHA instance\",\n \"in\": \"path\",\n \"name\": \"captchaId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/captchas/{captchaId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.captchas.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_captcha_instance\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a CAPTCHA instance\",\n \"tags\": [\n \"CAPTCHA\"\n ]\n },\n \"delete_cross_app_access_connection\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a Cross App Access connection with the specified ID\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_cross_app_access_connection\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Connection ID\",\n \"in\": \"path\",\n \"name\": \"connectionId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/cwo/connections/{connectionId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_cross_app_access_connection\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a Cross App Access connection\",\n \"tags\": [\n \"ApplicationCrossAppAccessConnections\"\n ]\n },\n \"delete_custom_aaguid\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a custom AAGUID\\n\\nYou can only delete custom AAGUIDs that an admin has created.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_custom_aaguid\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique ID of a custom AAGUID\",\n \"in\": \"path\",\n \"name\": \"aaguid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cb69481e-8ff7-4039-93ec-0a272911111\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_custom_aaguid\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a custom AAGUID\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"delete_custom_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a custom domain by `domainId`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_custom_domain\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Domain\",\n \"in\": \"path\",\n \"name\": \"domainId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"OmWNeywfTzElSLOBMZsL\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/domains/{domainId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.domains.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_custom_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a custom domain\",\n \"tags\": [\n \"CustomDomain\"\n ]\n },\n \"delete_customized_error_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the customized error page. As a result, the default error page appears in your live environment.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_customized_error_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/error/customized\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_customized_error_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete the customized error page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"delete_customized_sign_in_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the customized sign-in page. As a result, the default sign-in page appears in your live environment.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_customized_sign_in_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-in/customized\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_customized_sign_in_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete the customized sign-in page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"delete_device\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes (permanently) a device by `deviceId` if it has a status of `DEACTIVATED`. You can transition the device to `DEACTIVATED` status using the [Deactivate a Device](/openapi/okta-management/management/tags/device/other/deactivatedevice) endpoint.\\nThis request is destructive and deletes all of the profile data related to the device. Once deleted, device data can't be recovered. However, reenrollment creates a new device record.\\n> **Note:** Attempts to delete a device that isn't in a `DEACTIVATED` state raise an error.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_device\",\n \"parameters\": [\n {\n \"description\": \"`id` of the device\",\n \"in\": \"path\",\n \"name\": \"deviceId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"guo4a5u7JHHhjXrMK0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/devices/{deviceId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devices.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_device\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a device\",\n \"tags\": [\n \"Device\"\n ]\n },\n \"delete_device_assurance_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a device assurance policy by `deviceAssuranceId`. If the device assurance policy is currently being used in the org Authentication Policies, the delete will not be allowed.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_device_assurance_policy\",\n \"parameters\": [\n {\n \"description\": \"Id of the device assurance policy\",\n \"in\": \"path\",\n \"name\": \"deviceAssuranceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/device-assurances/{deviceAssuranceId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.deviceAssurance.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_device_assurance_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a device assurance policy\",\n \"tags\": [\n \"DeviceAssurance\"\n ]\n },\n \"delete_device_posture_check\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a device posture check by `postureCheckId`. You can't delete the device posture check if it's used in a device assurance policy.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_device_posture_check\",\n \"parameters\": [\n {\n \"description\": \"ID of the device posture check\",\n \"in\": \"path\",\n \"name\": \"postureCheckId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/device-posture-checks/{postureCheckId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devicePostureChecks.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_device_posture_check\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a device posture check\",\n \"tags\": [\n \"DevicePostureCheck\"\n ]\n },\n \"delete_email_customization\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an Email Customization by its unique identifier\\n\\n If Custom languages for Okta Email Templates is disabled, deletion of an existing additional language customization by ID doesn't register.\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_email_customization\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the email customization\",\n \"in\": \"path\",\n \"name\": \"customizationId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_email_customization\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an email customization\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"delete_email_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an Email Domain by `emailDomainId`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_email_domain\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"emailDomainId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The ID of the email domain.\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"brands\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/email-domains/{emailDomainId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailDomains.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_email_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an email domain\",\n \"tags\": [\n \"EmailDomain\"\n ]\n },\n \"delete_email_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the specified custom SMTP server configuration\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_email_server\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"emailServerId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"ID of your SMTP server configuration\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/email-servers/{emailServerId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_email_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an SMTP server configuration\",\n \"tags\": [\n \"EmailServer\"\n ]\n },\n \"delete_event_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the event hook that matches the provided `id`. After deletion, the event hook is unrecoverable.\\nAs a safety precaution, you can only delete event hooks with a status of `INACTIVE`.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_event_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Event Hook\",\n \"in\": \"path\",\n \"name\": \"eventHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"who8vt36qfNpCGz9H1e6\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/eventHooks/{eventHookId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.eventHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_event_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an event hook\",\n \"tags\": [\n \"EventHook\"\n ]\n },\n \"delete_federated_claim\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a federated claim by `claimId`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_federated_claim\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique `id` of the federated claim\",\n \"in\": \"path\",\n \"name\": \"claimId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/federated-claims/{claimId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_federated_claim\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a federated claim\",\n \"tags\": [\n \"ApplicationSSOFederatedClaims\"\n ]\n },\n \"delete_governance_bundle\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an Admin Console governance bundle\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_governance_bundle\",\n \"parameters\": [\n {\n \"description\": \"The `id` of a bundle\",\n \"in\": \"path\",\n \"name\": \"bundleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"enbllojq9J9J105DL1d6\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/governance/bundles/{bundleId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_governance_bundle\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a governance bundle\",\n \"tags\": [\n \"GovernanceBundle\"\n ]\n },\n \"delete_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a group of the `OKTA_GROUP` or `APP_GROUP` type from your org.\\n> **Note:** You can't remove groups of type `APP_GROUP` if they are used in a group push mapping.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a group\",\n \"tags\": [\n \"Group\"\n ]\n },\n \"delete_group_owner\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a group owner from a specific group\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_group_owner\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the group owner\",\n \"in\": \"path\",\n \"name\": \"ownerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00u1emaK22TWRYd3TtG\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/owners/{ownerId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_group_owner\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a group owner\",\n \"tags\": [\n \"GroupOwner\"\n ]\n },\n \"delete_group_push_mapping\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a specific group push mapping. The group push mapping must be in an `INACTIVE` state.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_group_push_mapping\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Group push mapping ID\",\n \"in\": \"path\",\n \"name\": \"mappingId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"gPm00000000000000000\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"If set to `true`, the target group is also deleted. If set to `false`, the target group isn't deleted.\",\n \"in\": \"query\",\n \"name\": \"deleteTargetGroup\",\n \"required\": true,\n \"schema\": {\n \"default\": false,\n \"type\": \"boolean\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/group-push/mappings/{mappingId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\",\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_group_push_mapping\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a group push mapping\",\n \"tags\": [\n \"GroupPushMapping\"\n ]\n },\n \"delete_group_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a specific group rule by `groupRuleId`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_group_rule\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group rule\",\n \"in\": \"path\",\n \"name\": \"groupRuleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0pr3f7zMZZHPgUoWO0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"If set to `true`, removes users from groups assigned by this rule\",\n \"in\": \"query\",\n \"name\": \"removeUsers\",\n \"required\": false,\n \"schema\": {\n \"default\": false,\n \"type\": \"boolean\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/rules/{groupRuleId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_group_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a group rule\",\n \"tags\": [\n \"GroupRule\"\n ]\n },\n \"delete_hook_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a key by `id`. After being deleted, the key is unrecoverable.\\n\\nAs a safety precaution, only keys that aren't being used are eligible for deletion.\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_hook_key\",\n \"parameters\": [\n {\n \"description\": \"ID of the Hook Key\",\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"schema\": {\n \"example\": \"XreKU5laGwBkjOTehusG\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/hook-keys/{id}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_hook_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a key\",\n \"tags\": [\n \"HookKey\"\n ]\n },\n \"delete_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an identity provider (IdP) integration by `idpId`\\n* All existing IdP users are unlinked with the highest order profile source taking precedence for each IdP user.\\n* Unlinked users keep their existing authentication provider such as `FEDERATION` or `SOCIAL`.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an IdP\",\n \"tags\": [\n \"IdentityProvider\"\n ]\n },\n \"delete_identity_provider_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a specific identity provider (IdP) key credential by `kid` if it isn't currently being used by an active or inactive IdP\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_identity_provider_key\",\n \"parameters\": [\n {\n \"description\": \"Unique `id` of the IdP key credential\",\n \"in\": \"path\",\n \"name\": \"kid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"KmMo85SSsU7TZzOShcGb\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/credentials/keys/{kid}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_identity_provider_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an IdP key credential\",\n \"tags\": [\n \"IdentityProviderKeys\"\n ]\n },\n \"delete_identity_source_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a group in an identity source for a given identity source ID and group ID\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_identity_source_group\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The Okta group ID or external ID of the identity source group\",\n \"in\": \"path\",\n \"name\": \"groupOrExternalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_identity_source_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an identity source group\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"delete_identity_source_group_memberships\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes group memberships for the specified identity source group using member external IDs\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_identity_source_group_memberships\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The Okta group ID or external ID of the identity source group\",\n \"in\": \"path\",\n \"name\": \"groupOrExternalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The external ID of the identity source user\",\n \"in\": \"path\",\n \"name\": \"memberExternalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership/{memberExternalId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_identity_source_group_memberships\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete the memberships for the specified identity source group\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"delete_identity_source_session\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an identity source session for a given identity source ID and session Id\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_identity_source_session\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the identity source session\",\n \"in\": \"path\",\n \"name\": \"sessionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_identity_source_session\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an identity source session\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"delete_identity_source_user\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a user in an identity source for the given identity source instance and external ID\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_identity_source_user\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The external ID of the user\",\n \"in\": \"path\",\n \"name\": \"externalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/users/{externalId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_identity_source_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an identity source user\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"delete_inline_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an inline hook by `inlineHookId`. After it's deleted, the inline hook is unrecoverable. As a safety precaution, only inline hooks with a status of `INACTIVE` are eligible for deletion.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_inline_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the inline hook\",\n \"in\": \"path\",\n \"name\": \"inlineHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"Y7Rzrd4g4xj6WdKzrBHH\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/inlineHooks/{inlineHookId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_inline_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an inline hook\",\n \"tags\": [\n \"InlineHook\"\n ]\n },\n \"delete_interclient_trust_mapping\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the mapping between the target app and an allowed app\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_interclient_trust_mapping\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"App ID of the allowed app instance to delete mapping from the target app.\",\n \"in\": \"path\",\n \"name\": \"allowedAppId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/interclient-allowed-apps/{allowedAppId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.interclientTrust.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_interclient_trust_mapping\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an interclient trust mapping\",\n \"tags\": [\n \"ApplicationInterclientTrustMappings\"\n ]\n },\n \"delete_linked_object_definition\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the Linked Object definition specified by either the `primary` or `associated` name. The entire definition is removed, regardless of which name that you specify.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_linked_object_definition\",\n \"parameters\": [\n {\n \"description\": \"Primary or Associated name\",\n \"in\": \"path\",\n \"name\": \"linkedObjectName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.linkedObjects.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_linked_object_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a linked object definition\",\n \"tags\": [\n \"LinkedObject\"\n ]\n },\n \"delete_log_stream\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a log stream object from your org by ID\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_log_stream\",\n \"parameters\": [\n {\n \"description\": \"Unique identifier for the log stream\",\n \"in\": \"path\",\n \"name\": \"logStreamId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa1orzg0CHSgPcjZ0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/logStreams/{logStreamId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.logStreams.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_log_stream\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a log stream\",\n \"tags\": [\n \"LogStream\"\n ]\n },\n \"delete_o_auth2_claim\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a custom token Claim specified by the `claimId`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_o_auth2_claim\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of Claim\",\n \"in\": \"path\",\n \"name\": \"claimId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"hNJ3Uk76xLagWkGx5W3N\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/claims/{claimId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_o_auth2_claim\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a custom token claim\",\n \"tags\": [\n \"AuthorizationServerClaims\"\n ]\n },\n \"delete_o_auth2_client_secret\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an OAuth 2.0 client secret by `secretId`. You can only delete an inactive secret.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_o_auth2_client_secret\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the OAuth 2.0 client secret\",\n \"in\": \"path\",\n \"name\": \"secretId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/secrets/{secretId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_o_auth2_client_secret\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an OAuth 2.0 client secret\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"delete_o_auth2_resource_server_json_web_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a custom authorization server public JSON web key by key `id`. You can only delete an inactive key.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_o_auth2_resource_server_json_web_key\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the Custom Authorization Server JSON Web Key\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_o_auth2_resource_server_json_web_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a Custom Authorization Server Public JSON Web Key\",\n \"tags\": [\n \"OAuth2ResourceServerCredentialsKeys\"\n ]\n },\n \"delete_o_auth2_scope\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a custom token scope\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_o_auth2_scope\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of Scope\",\n \"in\": \"path\",\n \"name\": \"scopeId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0TMRpCWXRKFjP7HiPFNM\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/scopes/{scopeId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_o_auth2_scope\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a custom token scope\",\n \"tags\": [\n \"AuthorizationServerScopes\"\n ]\n },\n \"delete_org_captcha_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the CAPTCHA settings object for your organization\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_org_captcha_settings\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/captcha\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.captchas.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_org_captcha_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete the org-wide CAPTCHA settings\",\n \"tags\": [\n \"CAPTCHA\"\n ]\n },\n \"delete_preview_error_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_preview_error_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/error/preview\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_preview_error_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete the preview error page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"delete_preview_sign_in_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_preview_sign_in_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-in/preview\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_preview_sign_in_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete the preview sign-in page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"delete_resource_set\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a resource set by `resourceSetIdOrLabel`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_resource_set\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_resource_set\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a resource set\",\n \"tags\": [\n \"RoleCResourceSet\"\n ]\n },\n \"delete_resource_set_resource\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a resource (identified by `resourceId`) from a resource set\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_resource_set_resource\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the resource\",\n \"in\": \"path\",\n \"name\": \"resourceId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"ire106sQKoHoXXsAe0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_resource_set_resource\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a resource set resource\",\n \"tags\": [\n \"RoleCResourceSetResource\"\n ]\n },\n \"delete_role\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a custom role by `roleIdOrLabel`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_role\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/roles/{roleIdOrLabel}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_role\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a custom role\",\n \"tags\": [\n \"RoleECustom\"\n ]\n },\n \"delete_role_permission\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a permission (identified by `permissionType`) from a custom role\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_role_permission\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An Okta [permission](/openapi/okta-management/guides/permissions)\",\n \"in\": \"path\",\n \"name\": \"permissionType\",\n \"required\": true,\n \"schema\": {\n \"example\": \"okta.users.manage\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_role_permission\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a custom role permission\",\n \"tags\": [\n \"RoleECustomPermission\"\n ]\n },\n \"delete_ui_schemas\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a UI Schema by `id`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_ui_schemas\",\n \"parameters\": [\n {\n \"description\": \"The unique ID of the UI Schema\",\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"schema\": {\n \"example\": \"uis4a7liocgcRgcxZ0g7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/uischemas/{id}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.uischemas.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_ui_schemas\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a UI schema\",\n \"tags\": [\n \"UISchema\"\n ]\n },\n \"delete_user_type\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a user type permanently.\\n> **Note**: You can't delete the default user type or a user type that is currently assigned to users.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_user_type\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"typeId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The unique key for the user type\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/types/user/{typeId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.userTypes.manage\"\n ]\n }\n ],\n \"skill_name\": \"delete_user_type\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete a user type\",\n \"tags\": [\n \"UserType\"\n ]\n },\n \"deletejwk\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an OAuth 2.0 Client JSON Web Key by `keyId`. You can only delete an inactive key.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"deletejwk\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the OAuth 2.0 client JSON Web Key\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/jwks/{keyId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"deletejwk\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Delete an OAuth 2.0 client JSON Web Key\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"execute_inline_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Executes the inline hook that matches the provided `inlineHookId` by using the request body as the input. This inline hook sends the provided\\ndata through the `channel` object and returns a response if it matches the correct data contract. Otherwise it returns an error. You need to\\nconstruct a JSON payload that matches the payloads that Okta would send to your external service for this inline hook type.\\n\\nA timeout of three seconds is enforced on all outbound requests, with one retry in the event of a timeout or an error response from the remote system.\\nIf a successful response isn't received after the request, a 400 error is returned with more information about what failed.\\n\\n>**Note:** This execution endpoint isn't tied to any other functionality in Okta, and you should only use it for testing purposes.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"execute_inline_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the inline hook\",\n \"in\": \"path\",\n \"name\": \"inlineHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"Y7Rzrd4g4xj6WdKzrBHH\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/inlineHooks/{inlineHookId}/execute\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"$ref\": \"#/components/schemas/PasswordImportRequestExecute\"\n },\n {\n \"$ref\": \"#/components/schemas/TelephonyRequestExecute\"\n },\n {\n \"$ref\": \"#/components/schemas/RegistrationInlineHookRequest\"\n },\n {\n \"$ref\": \"#/components/schemas/TokenRequest\"\n },\n {\n \"$ref\": \"#/components/schemas/SAMLPayloadExecute\"\n },\n {\n \"$ref\": \"#/components/schemas/UserImportRequestExecute\"\n }\n ]\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"execute_inline_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Execute an inline hook\",\n \"tags\": [\n \"InlineHook\"\n ]\n },\n \"extend_okta_support\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time.\\n\\n> **Note:** This resource is deprecated. Use the [Update an Okta Support case](/openapi/okta-management/management/tags/orgsettingsupport/other/updateoktasupportcase) resource to extend Okta Support access for a support case.\\n> For the corresponding Okta Admin Console feature, see [Give access to Okta Support](https://help.okta.com/okta_help.htm?type=oie&id=settings-support-access).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"extend_okta_support\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/oktaSupport/extend\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"extend_okta_support\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Extend Okta Support access\",\n \"tags\": [\n \"OrgSettingSupport\"\n ]\n },\n \"generate_application_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Generates a new X.509 certificate for an app key credential\\n> **Note:** To update an app with the newly generated key credential, use the [Replace an Application](/openapi/okta-management/management/application/replaceapplication) request with the new [credentials.signing.kid](/openapi/okta-management/management/application/replaceapplication#application/replaceapplication/t=request&path=&d=0/credentials/signing/kid) value in the request body. You can provide just the [signing credential object](/openapi/okta-management/management/application/replaceapplication#application/replaceapplication/t=request&path=&d=0/credentials/signing) instead of the entire [application credential object](/openapi/okta-management/management/application/replaceapplication#application/replaceapplication/t=response&c=200&path=&d=0/credentials).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"generate_application_key\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Expiry years of the application key credential\",\n \"in\": \"query\",\n \"name\": \"validityYears\",\n \"required\": true,\n \"schema\": {\n \"example\": 5,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/keys/generate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"generate_application_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Generate a key credential\",\n \"tags\": [\n \"ApplicationSSOCredentialKey\"\n ]\n },\n \"generate_csr_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Generates a new key pair and returns the certificate signing request (CSR) for it. The information in a CSR is used by the Certificate Authority (CA) to verify and create your certificate. It also contains the public key that's included in your certificate.\\n\\nReturns CSR in `pkcs#10` format if the `Accept` media type is `application/pkcs10` or a CSR object if the `Accept` media type is `application/json`.\\n> **Note:** The key pair isn't listed in the key credentials for the app until it's published.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"generate_csr_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/csrs\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CsrMetadata\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"generate_csr_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Generate a certificate signing request\",\n \"tags\": [\n \"ApplicationSSOCredentialKey\"\n ]\n },\n \"generate_csr_for_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Generates a new key pair and returns a certificate signing request (CSR) for it\\n> **Note:** The private key isn't listed in the [signing key credentials for the identity provider (IdP)](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProviderSigningKeys/#tag/IdentityProviderSigningKeys/operation/listIdentityProviderSigningKeys) until it's published.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"generate_csr_for_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/credentials/csrs\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CsrMetadata\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"generate_csr_for_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Generate a certificate signing request\",\n \"tags\": [\n \"IdentityProviderSigningKeys\"\n ]\n },\n \"generate_identity_provider_signing_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Generates a new X.509 certificate for an identity provider (IdP) signing key credential to be used for signing assertions sent to the IdP. IdP signing keys are read-only.\\n> **Note:** To update an IdP with the newly generated key credential, [update your IdP](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider) using the returned key's `kid` in the [signing credential](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider!path=protocol/0/credentials/signing/kid&t=request).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"generate_identity_provider_signing_key\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"expiry of the IdP key credential\",\n \"in\": \"query\",\n \"name\": \"validityYears\",\n \"required\": true,\n \"schema\": {\n \"format\": \"int32\",\n \"maximum\": 10,\n \"minimum\": 2,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/credentials/keys/generate\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"generate_identity_provider_signing_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Generate a new signing key credential for IdP\",\n \"tags\": [\n \"IdentityProviderSigningKeys\"\n ]\n },\n \"get_aerial_consent\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the Okta Aerial consent grant details for your Org. Returns a 404 Not Found error if no consent has been granted.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_aerial_consent\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/aerial\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"get_aerial_consent\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve Okta Aerial consent for your org\",\n \"tags\": [\n \"OrgSettingSupport\"\n ]\n },\n \"get_agent_pools_update_instance\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an agent pool update by its `updateId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_agent_pools_update_instance\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the update\",\n \"in\": \"path\",\n \"name\": \"updateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/{updateId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.read\"\n ]\n }\n ],\n \"skill_name\": \"get_agent_pools_update_instance\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an agent pool update by ID\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"get_agent_pools_update_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the current state of the agent pool update instance settings\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_agent_pools_update_settings\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/settings\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.read\"\n ]\n }\n ],\n \"skill_name\": \"get_agent_pools_update_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an agent pool update's settings\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"get_all_cross_app_access_connections\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves inbound and outbound Cross App Access connections associated with an app\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_all_cross_app_access_connections\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of connection results\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of results to return per page. The values:\\n * -1: Return all results (up to system maximum)\\n * 0: Return an empty result set\\n * Positive integer: Return up to that many results (capped at system maximum)\\n\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": -1,\n \"format\": \"int32\",\n \"maximum\": 200,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Filters connections by their lifecycle status. When specified, only connections that match the specified status are returned.\\n\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"ACTIVE\",\n \"INACTIVE\"\n ],\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters only connections where the app with the specified ID is the requesting app\",\n \"in\": \"query\",\n \"name\": \"requestingAppId\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters only connections where the app with the specified ID is the requesting app\",\n \"in\": \"query\",\n \"name\": \"resourceAppId\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When set to true, filters the result to include only connections where both the requesting and resource app have a status of ACTIVE\",\n \"in\": \"query\",\n \"name\": \"activeAppsOnly\",\n \"required\": false,\n \"schema\": {\n \"type\": \"boolean\"\n }\n },\n {\n \"description\": \"Filters connections where the requesting app's name matches the provided search string\",\n \"in\": \"query\",\n \"name\": \"requestingAppName\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters connections where the resource app's name matches the provided search string\",\n \"in\": \"query\",\n \"name\": \"resourceAppName\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/cwo/connections\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_all_cross_app_access_connections\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve all Cross App Access connections\",\n \"tags\": [\n \"ApplicationCrossAppAccessConnections\"\n ]\n },\n \"get_all_well_known_ur_is\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the content from each of the well-known URIs for a specified brand\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_all_well_known_ur_is\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional metadata to include in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"all\",\n \"apple-app-site-association\",\n \"assetlinks.json\",\n \"webauthn\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/well-known-uris\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_all_well_known_ur_is\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve all the well-known URIs\",\n \"tags\": [\n \"AssociatedDomainCustomizations\"\n ]\n },\n \"get_api_token\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the metadata for an active API token by `apiTokenId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_api_token\",\n \"parameters\": [\n {\n \"description\": \"id of the API Token\",\n \"in\": \"path\",\n \"name\": \"apiTokenId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00Tabcdefg1234567890\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/api-tokens/{apiTokenId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apiTokens.read\"\n ]\n }\n ],\n \"skill_name\": \"get_api_token\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an API token's metadata\",\n \"tags\": [\n \"ApiToken\"\n ]\n },\n \"get_apple_app_site_association_well_known_uri\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the content of the `apple-app-site-assocation` well-known URI\\n\\n> **Note:** When serving this URI, Okta adds `authsrv` content to provide a seamless experience for Okta Verify. You can't modify the content in the `authsrv` object.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_apple_app_site_association_well_known_uri\",\n \"parameters\": [],\n \"path\": \"/.well-known/apple-app-site-association\",\n \"request_body\": null,\n \"security\": [],\n \"skill_name\": \"get_apple_app_site_association_well_known_uri\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the customized apple-app-site-association URI content\",\n \"tags\": [\n \"AssociatedDomainCustomizations\"\n ]\n },\n \"get_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an application from your Okta organization by `id`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An optional query parameter to return the specified [Application User](/openapi/okta-management/management/tags/applicationusers) in the `_embedded` property.\\nValid value: `expand=user/{userId}`\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"user/0oa1gjh63g214q0Hq0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an application\",\n \"tags\": [\n \"Application\"\n ]\n },\n \"get_application_group_assignment\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an app group assignment\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_application_group_assignment\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An optional query parameter to return the corresponding assigned [group](openapi/okta-management/management/group) or the group assignment metadata details in the `_embedded` property.\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"group\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/groups/{groupId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_application_group_assignment\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an application group\",\n \"tags\": [\n \"ApplicationGroups\"\n ]\n },\n \"get_application_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a specific application key credential by `kid`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_application_key\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the Key Credential for the application\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"sjP9eiETijYz110VkhHN\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/keys/{keyId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_application_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a key credential\",\n \"tags\": [\n \"ApplicationSSOCredentialKey\"\n ]\n },\n \"get_application_user\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a specific user assignment for a specific app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_application_user\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of an existing Okta user\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00u13okQOVWZJGDOAUVR\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An optional query parameter to return the corresponding [User](/openapi/okta-management/management/tags/user) object in the `_embedded` property.\\nValid value: `user`\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"user\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/users/{userId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_application_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an application user\",\n \"tags\": [\n \"ApplicationUsers\"\n ]\n },\n \"get_application_user_schema\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the default schema for an app user.\\n\\nThe [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to apps. All users assigned to a given app use the same app user schema. Therefore, unlike the user schema operations, the app user schema operations all specify `default` and don't accept a schema ID.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_application_user_schema\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/schemas/apps/{appId}/default\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.schemas.read\"\n ]\n }\n ],\n \"skill_name\": \"get_application_user_schema\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the default app user schema for an app\",\n \"tags\": [\n \"Schema\"\n ]\n },\n \"get_asset_links_well_known_uri\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the content of the `assetlinks.json` well-known URI\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_asset_links_well_known_uri\",\n \"parameters\": [],\n \"path\": \"/.well-known/assetlinks.json\",\n \"request_body\": null,\n \"security\": [],\n \"skill_name\": \"get_asset_links_well_known_uri\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the customized assetlinks.json URI content\",\n \"tags\": [\n \"AssociatedDomainCustomizations\"\n ]\n },\n \"get_authenticator\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an authenticator from your Okta organization by `authenticatorId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_authenticator\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.read\"\n ]\n }\n ],\n \"skill_name\": \"get_authenticator\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an authenticator\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"get_authenticator_method\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a method identified by `methodType` of an authenticator identified by `authenticatorId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_authenticator_method\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Type of authenticator method\",\n \"in\": \"path\",\n \"name\": \"methodType\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/components/schemas/AuthenticatorMethodType\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/methods/{methodType}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.read\"\n ]\n }\n ],\n \"skill_name\": \"get_authenticator_method\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an authenticator method\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"get_authorization_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an authorization server\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_authorization_server\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"get_authorization_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an authorization server\",\n \"tags\": [\n \"AuthorizationServer\"\n ]\n },\n \"get_authorization_server_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an Authorization Server Key specified by the `keyId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_authorization_server_key\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the certificate key\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"P7jXpG-LG2ObNgY9C0Mn2uf4InCQTmRZMDCZoVNxdrk\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/credentials/keys/{keyId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"get_authorization_server_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an authorization server key\",\n \"tags\": [\n \"AuthorizationServerKeys\"\n ]\n },\n \"get_authorization_server_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a policy\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_authorization_server_policy\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"get_authorization_server_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a policy\",\n \"tags\": [\n \"AuthorizationServerPolicies\"\n ]\n },\n \"get_authorization_server_policy_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a policy rule by `ruleId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_authorization_server_policy_rule\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy rule\",\n \"in\": \"path\",\n \"name\": \"ruleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"ruld3hJ7jZh4fn0st0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"get_authorization_server_policy_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a policy rule\",\n \"tags\": [\n \"AuthorizationServerRules\"\n ]\n },\n \"get_auto_assign_admin_app_setting\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the org setting to automatically assign the Okta Admin Console when an admin role is assigned\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_auto_assign_admin_app_setting\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/settings/autoAssignAdminAppSetting\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.read\"\n ]\n }\n ],\n \"skill_name\": \"get_auto_assign_admin_app_setting\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the Okta Admin Console assignment setting\",\n \"tags\": [\n \"OrgSettingAdmin\"\n ]\n },\n \"get_behavior_detection_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a Behavior Detection Rule by `behaviorId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_behavior_detection_rule\",\n \"parameters\": [\n {\n \"description\": \"ID of the Behavior Detection Rule\",\n \"in\": \"path\",\n \"name\": \"behaviorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"abcd1234\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/behaviors/{behaviorId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.behaviors.read\"\n ]\n }\n ],\n \"skill_name\": \"get_behavior_detection_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a behavior detection rule\",\n \"tags\": [\n \"Behavior\"\n ]\n },\n \"get_binding\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the binding of a role (identified by `roleIdOrLabel`) for a resource set (identified by `resourceSetIdOrLabel`)\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_binding\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"get_binding\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a role resource set binding\",\n \"tags\": [\n \"RoleDResourceSetBinding\"\n ]\n },\n \"get_bot_protection_configuration\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the bot protection configuration for your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_bot_protection_configuration\",\n \"parameters\": [],\n \"path\": \"/api/v1/bot-protection/configuration\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.botProtection.read\"\n ]\n }\n ],\n \"skill_name\": \"get_bot_protection_configuration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the bot protection configuration\",\n \"tags\": [\n \"BotProtection\"\n ]\n },\n \"get_brand\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a brand by `brandId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_brand\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"themes\",\n \"domains\",\n \"emailDomain\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_brand\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a brand\",\n \"tags\": [\n \"Brands\"\n ]\n },\n \"get_brand_theme\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a theme for a brand\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_brand_theme\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the theme\",\n \"in\": \"path\",\n \"name\": \"themeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/themes/{themeId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_brand_theme\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a theme\",\n \"tags\": [\n \"Themes\"\n ]\n },\n \"get_brand_well_known_uri\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the customized content of a well-known URI for a specific brand and well-known URI path\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_brand_well_known_uri\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The path of the well-known URI\",\n \"in\": \"path\",\n \"name\": \"path\",\n \"required\": true,\n \"schema\": {\n \"enum\": [\n \"apple-app-site-association\",\n \"assetlinks.json\",\n \"webauthn\"\n ],\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/well-known-uris/{path}/customized\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_brand_well_known_uri\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the customized content of the specified well-known URI\",\n \"tags\": [\n \"AssociatedDomainCustomizations\"\n ]\n },\n \"get_captcha_instance\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the properties of a specified CAPTCHA instance\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_captcha_instance\",\n \"parameters\": [\n {\n \"description\": \"The unique key used to identify your CAPTCHA instance\",\n \"in\": \"path\",\n \"name\": \"captchaId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/captchas/{captchaId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.captchas.read\"\n ]\n }\n ],\n \"skill_name\": \"get_captcha_instance\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a CAPTCHA instance\",\n \"tags\": [\n \"CAPTCHA\"\n ]\n },\n \"get_cross_app_access_connection\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the Cross App Access connection with the specified ID\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_cross_app_access_connection\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Connection ID\",\n \"in\": \"path\",\n \"name\": \"connectionId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/cwo/connections/{connectionId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_cross_app_access_connection\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a Cross App Access connection\",\n \"tags\": [\n \"ApplicationCrossAppAccessConnections\"\n ]\n },\n \"get_csr_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a certificate signing request (CSR) for the app by `csrId`.\\n\\nReturns a Base64-encoded CSR in DER format if the `Accept` media type is `application/pkcs10` or a CSR object if the `Accept` media type is `application/json`.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_csr_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the CSR\",\n \"in\": \"path\",\n \"name\": \"csrId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"fd7x1h7uTcZFx22rU1f7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/csrs/{csrId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_csr_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a certificate signing request\",\n \"tags\": [\n \"ApplicationSSOCredentialKey\"\n ]\n },\n \"get_csr_for_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a specific certificate signing request (CSR) by `id`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_csr_for_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the IdP CSR\",\n \"in\": \"path\",\n \"name\": \"idpCsrId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"1uEhyE65oV3H6KM9gYcN\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_csr_for_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a certificate signing request\",\n \"tags\": [\n \"IdentityProviderSigningKeys\"\n ]\n },\n \"get_custom_aaguid\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a custom AAGUID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_custom_aaguid\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique ID of a custom AAGUID\",\n \"in\": \"path\",\n \"name\": \"aaguid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cb69481e-8ff7-4039-93ec-0a272911111\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.read\"\n ]\n }\n ],\n \"skill_name\": \"get_custom_aaguid\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a custom AAGUID\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"get_custom_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a custom domain by `domainId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_custom_domain\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Domain\",\n \"in\": \"path\",\n \"name\": \"domainId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"OmWNeywfTzElSLOBMZsL\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/domains/{domainId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.domains.read\"\n ]\n }\n ],\n \"skill_name\": \"get_custom_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a custom domain\",\n \"tags\": [\n \"CustomDomain\"\n ]\n },\n \"get_customization_preview\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a Preview of an Email Customization. All variable references are populated from the current user's context. For example, `${user.profile.firstName}`.\\n\\n If Custom languages for Okta Email Templates is disabled, requests for the preview of an additional language customization by ID return a `404 Not Found` error response.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_customization_preview\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the email customization\",\n \"in\": \"path\",\n \"name\": \"customizationId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.read\"\n ]\n }\n ],\n \"skill_name\": \"get_customization_preview\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a preview of an email customization\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"get_customized_error_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the customized error page. The customized error page appears in your live environment.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_customized_error_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/error/customized\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_customized_error_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the customized error page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"get_customized_sign_in_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the customized sign-in page. The customized sign-in page appears in your live environment.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_customized_sign_in_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-in/customized\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_customized_sign_in_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the customized sign-in page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"get_default_error_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the default error page. The default error page appears when no customized error page exists.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_default_error_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/error/default\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_default_error_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the default error page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"get_default_provisioning_connection_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the default provisioning connection for an app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_default_provisioning_connection_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/connections/default\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_default_provisioning_connection_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the default provisioning connection\",\n \"tags\": [\n \"ApplicationConnections\"\n ]\n },\n \"get_default_sign_in_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the default sign-in page. The default sign-in page appears when no customized sign-in page exists.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_default_sign_in_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-in/default\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_default_sign_in_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the default sign-in page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"get_device\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a device by `deviceId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_device\",\n \"parameters\": [\n {\n \"description\": \"`id` of the device\",\n \"in\": \"path\",\n \"name\": \"deviceId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"guo4a5u7JHHhjXrMK0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/devices/{deviceId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devices.read\"\n ]\n }\n ],\n \"skill_name\": \"get_device\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a device\",\n \"tags\": [\n \"Device\"\n ]\n },\n \"get_device_assurance_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a device assurance policy by `deviceAssuranceId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_device_assurance_policy\",\n \"parameters\": [\n {\n \"description\": \"Id of the device assurance policy\",\n \"in\": \"path\",\n \"name\": \"deviceAssuranceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/device-assurances/{deviceAssuranceId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.deviceAssurance.read\"\n ]\n }\n ],\n \"skill_name\": \"get_device_assurance_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a device assurance policy\",\n \"tags\": [\n \"DeviceAssurance\"\n ]\n },\n \"get_device_integration\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a device integration by `deviceIntegrationId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_device_integration\",\n \"parameters\": [\n {\n \"description\": \"The ID of the device integration\",\n \"in\": \"path\",\n \"name\": \"deviceIntegrationId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/device-integrations/{deviceIntegrationId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.deviceIntegrations.read\"\n ]\n }\n ],\n \"skill_name\": \"get_device_integration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a device integration\",\n \"tags\": [\n \"DeviceIntegrations\"\n ]\n },\n \"get_device_posture_check\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a device posture check by `postureCheckId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_device_posture_check\",\n \"parameters\": [\n {\n \"description\": \"ID of the device posture check\",\n \"in\": \"path\",\n \"name\": \"postureCheckId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/device-posture-checks/{postureCheckId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devicePostureChecks.read\"\n ]\n }\n ],\n \"skill_name\": \"get_device_posture_check\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a device posture check\",\n \"tags\": [\n \"DevicePostureCheck\"\n ]\n },\n \"get_dr_status\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the failover or failback status for all the domains for your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_dr_status\",\n \"parameters\": [],\n \"path\": \"/api/v1/dr/status\",\n \"request_body\": null,\n \"security\": [\n {\n \"oauth2\": [\n \"okta.dr.read\"\n ]\n }\n ],\n \"skill_name\": \"get_dr_status\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the disaster recovery status for all domains\",\n \"tags\": [\n \"DisasterRecovery\"\n ]\n },\n \"get_dr_status_for_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the failover or failback status for the domain specified in the request path\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_dr_status_for_domain\",\n \"parameters\": [\n {\n \"description\": \"The Okta domain name of your org or one of your custom domains\",\n \"in\": \"path\",\n \"name\": \"domain\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/dr/status/{domain}\",\n \"request_body\": null,\n \"security\": [\n {\n \"oauth2\": [\n \"okta.dr.read\"\n ]\n }\n ],\n \"skill_name\": \"get_dr_status_for_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the disaster recovery status for a domain\",\n \"tags\": [\n \"DisasterRecovery\"\n ]\n },\n \"get_email_customization\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an email customization by its unique identifier\\n\\n If Custom languages for Okta Email Templates is disabled, requests to retrieve an additional language customization by ID result in a `404 Not Found` error response.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_email_customization\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the email customization\",\n \"in\": \"path\",\n \"name\": \"customizationId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.read\"\n ]\n }\n ],\n \"skill_name\": \"get_email_customization\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an email customization\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"get_email_default_content\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an email template's default content\\n\\n Defaults to the current user's language given the following:\\n- Custom languages for Okta Email Templates is enabled\\n- An additional language is specified for the `language` parameter\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_email_default_content\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The language to use for the email. Defaults to the current user's language if unspecified.\",\n \"in\": \"query\",\n \"name\": \"language\",\n \"required\": false,\n \"schema\": {\n \"$ref\": \"#/components/schemas/Language\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/default-content\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.read\"\n ]\n }\n ],\n \"skill_name\": \"get_email_default_content\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an email template default content\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"get_email_default_preview\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a preview of an Email Template's default content. All variable references are populated using the current user's context. For example, `${user.profile.firstName}`.\\n\\n Defaults to the current user's language given the following:\\n- Custom languages for Okta Email Templates is enabled\\n- An additional language is specified for the `language` parameter\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_email_default_preview\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The language to use for the email. Defaults to the current user's language if unspecified.\",\n \"in\": \"query\",\n \"name\": \"language\",\n \"required\": false,\n \"schema\": {\n \"$ref\": \"#/components/schemas/Language\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.read\"\n ]\n }\n ],\n \"skill_name\": \"get_email_default_preview\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a preview of the email template default content\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"get_email_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an Email Domain by `emailDomainId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_email_domain\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"emailDomainId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The ID of the email domain.\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"brands\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/email-domains/{emailDomainId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailDomains.read\"\n ]\n }\n ],\n \"skill_name\": \"get_email_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an email domain\",\n \"tags\": [\n \"EmailDomain\"\n ]\n },\n \"get_email_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the specified custom SMTP server configuration\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_email_server\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"emailServerId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"ID of your SMTP server configuration\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/email-servers/{emailServerId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailServers.read\"\n ]\n }\n ],\n \"skill_name\": \"get_email_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an SMTP server configuration\",\n \"tags\": [\n \"EmailServer\"\n ]\n },\n \"get_email_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an email template's settings\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_email_settings\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/settings\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.read\"\n ]\n }\n ],\n \"skill_name\": \"get_email_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the email template settings\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"get_email_template\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the details of an email template by name\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_email_template\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"settings\",\n \"customizationCount\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.read\"\n ]\n }\n ],\n \"skill_name\": \"get_email_template\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an email template\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"get_error_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the error page sub-resources. The `expand` query parameter specifies which sub-resources to include in the response.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_error_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"default\",\n \"customized\",\n \"customizedUrl\",\n \"preview\",\n \"previewUrl\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/error\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_error_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the error page sub-resources\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"get_event_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an event hook\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_event_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Event Hook\",\n \"in\": \"path\",\n \"name\": \"eventHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"who8vt36qfNpCGz9H1e6\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/eventHooks/{eventHookId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.eventHooks.read\"\n ]\n }\n ],\n \"skill_name\": \"get_event_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an event hook\",\n \"tags\": [\n \"EventHook\"\n ]\n },\n \"get_feature\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a feature by ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_feature\",\n \"parameters\": [\n {\n \"description\": \"`id` of the feature\",\n \"in\": \"path\",\n \"name\": \"featureId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"R5HjqNn1pEqWGy48E9jg\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/features/{featureId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.features.read\"\n ]\n }\n ],\n \"skill_name\": \"get_feature\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a feature\",\n \"tags\": [\n \"Feature\"\n ]\n },\n \"get_feature_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a Feature object for an app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_feature_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Name of the Feature\",\n \"in\": \"path\",\n \"name\": \"featureName\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/components/schemas/ApplicationFeatureType\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/features/{featureName}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_feature_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a feature\",\n \"tags\": [\n \"ApplicationFeatures\"\n ]\n },\n \"get_federated_claim\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a federated claim by `claimId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_federated_claim\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique `id` of the federated claim\",\n \"in\": \"path\",\n \"name\": \"claimId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/federated-claims/{claimId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_federated_claim\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a federated claim\",\n \"tags\": [\n \"ApplicationSSOFederatedClaims\"\n ]\n },\n \"get_first_party_app_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the settings for an Okta app (also known as an Okta first-party app)\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_first_party_app_settings\",\n \"parameters\": [\n {\n \"description\": \"The key name for the Okta app.
\\nSupported apps:\\n * Okta Admin Console (`admin-console`)\\n\",\n \"in\": \"path\",\n \"name\": \"appName\",\n \"required\": true,\n \"schema\": {\n \"example\": \"admin-console\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/first-party-app-settings/{appName}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_first_party_app_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the Okta application settings\",\n \"tags\": [\n \"OktaApplicationSettings\"\n ]\n },\n \"get_governance_bundle\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a governance bundle for the Admin Console\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_governance_bundle\",\n \"parameters\": [\n {\n \"description\": \"The `id` of a bundle\",\n \"in\": \"path\",\n \"name\": \"bundleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"enbllojq9J9J105DL1d6\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/governance/bundles/{bundleId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"get_governance_bundle\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a governance bundle\",\n \"tags\": [\n \"GovernanceBundle\"\n ]\n },\n \"get_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a specific group by `id` from your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"get_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a group\",\n \"tags\": [\n \"Group\"\n ]\n },\n \"get_group_assigned_role\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a role assigned to a group (identified by the `groupId`). The `roleAssignmentId` is the unique identifier for either a standard role group assignment object or a custom role resource set binding object.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_group_assigned_role\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the role assignment\",\n \"in\": \"path\",\n \"name\": \"roleAssignmentId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"JBCUYUC7IRCVGS27IFCE2SKO\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles/{roleAssignmentId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"get_group_assigned_role\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a group role assignment\",\n \"tags\": [\n \"RoleAssignmentBGroup\"\n ]\n },\n \"get_group_attribute_query_result\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the results of the requested Active Directory (AD) group attributes using the `resultId` returned from the `POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query` call.\\nIf the operation has expired or if the `resultId` is invalid, returns a `404` status.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_group_attribute_query_result\",\n \"parameters\": [\n {\n \"description\": \"ID of the AD instance in Okta\",\n \"in\": \"path\",\n \"name\": \"appInstanceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the Okta group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique identifier returned by the initial POST request (`POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query`)\",\n \"in\": \"path\",\n \"name\": \"resultId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/directories/{appInstanceId}/groups/{groupId}/query/{resultId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"oauth2\": [\n \"okta.directories.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"get_group_attribute_query_result\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the results of an AD group query\",\n \"tags\": [\n \"DirectoriesIntegration\"\n ]\n },\n \"get_group_push_mapping\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a group push mapping by ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_group_push_mapping\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Group push mapping ID\",\n \"in\": \"path\",\n \"name\": \"mappingId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"gPm00000000000000000\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/group-push/mappings/{mappingId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\",\n \"okta.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"get_group_push_mapping\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a group push mapping\",\n \"tags\": [\n \"GroupPushMapping\"\n ]\n },\n \"get_group_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a specific group rule by ID from your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_group_rule\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group rule\",\n \"in\": \"path\",\n \"name\": \"groupRuleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0pr3f7zMZZHPgUoWO0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"If specified, returns the mapping of group IDs to group names in the `_embedded` object.\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"groupIdToGroupNameMap\"\n ],\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/rules/{groupRuleId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"get_group_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a group rule\",\n \"tags\": [\n \"GroupRule\"\n ]\n },\n \"get_group_schema\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the group schema\\n\\nThe [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify `default` and don't accept a schema ID.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_group_schema\",\n \"parameters\": [],\n \"path\": \"/api/v1/meta/schemas/group/default\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.schemas.read\"\n ]\n }\n ],\n \"skill_name\": \"get_group_schema\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the default group schema\",\n \"tags\": [\n \"Schema\"\n ]\n },\n \"get_hook_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the public portion of the Key object using the `id` parameter\\n\\n>**Note:** The `?expand=publickey` query parameter optionally returns the full object including the details of the public key in the response body's `_embedded` property.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_hook_key\",\n \"parameters\": [\n {\n \"description\": \"ID of the Hook Key\",\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"schema\": {\n \"example\": \"XreKU5laGwBkjOTehusG\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/hook-keys/{id}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.read\"\n ]\n }\n ],\n \"skill_name\": \"get_hook_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a key by ID\",\n \"tags\": [\n \"HookKey\"\n ]\n },\n \"get_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an identity provider (IdP) integration by `idpId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an IdP\",\n \"tags\": [\n \"IdentityProvider\"\n ]\n },\n \"get_identity_provider_application_user\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a linked identity provider (IdP) user by ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_identity_provider_application_user\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of an existing Okta user\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00ub0oNGTSWTBKOLGLNR\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/users/{userId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_identity_provider_application_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a user for IdP\",\n \"tags\": [\n \"IdentityProviderUsers\"\n ]\n },\n \"get_identity_provider_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a specific identity provider (IdP) key credential by `kid`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_identity_provider_key\",\n \"parameters\": [\n {\n \"description\": \"Unique `id` of the IdP key credential\",\n \"in\": \"path\",\n \"name\": \"kid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"KmMo85SSsU7TZzOShcGb\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/credentials/keys/{kid}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_identity_provider_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an IdP key credential\",\n \"tags\": [\n \"IdentityProviderKeys\"\n ]\n },\n \"get_identity_provider_signing_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a specific identity provider (IdP) key credential by `kid`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_identity_provider_signing_key\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the IdP key credential\",\n \"in\": \"path\",\n \"name\": \"kid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"KmMo85SSsU7TZzOShcGb\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/credentials/keys/{kid}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_identity_provider_signing_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a signing key credential for IdP\",\n \"tags\": [\n \"IdentityProviderSigningKeys\"\n ]\n },\n \"get_identity_source_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a group from an identity source for a given identity source ID and group ID or external ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_identity_source_group\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The Okta group ID or external ID of the identity source group\",\n \"in\": \"path\",\n \"name\": \"groupOrExternalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.read\"\n ]\n }\n ],\n \"skill_name\": \"get_identity_source_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an identity source group\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"get_identity_source_group_memberships\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the group memberships for the given identity source group in the given identity source instance\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_identity_source_group_memberships\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The Okta group ID or external ID of the identity source group\",\n \"in\": \"path\",\n \"name\": \"groupOrExternalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of group membership results in a page. Okta recommends using a specific value other than the default or maximum.\\nIf your request times out, retry your request with a smaller `limit` and [page the results](https://developer.okta.com/docs/api/#pagination).\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"format\": \"int32\",\n \"maximum\": 1000,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.read\"\n ]\n }\n ],\n \"skill_name\": \"get_identity_source_group_memberships\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the memberships for the given identity source group\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"get_identity_source_session\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an identity source session for a given identity source ID and session ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_identity_source_session\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the identity source session\",\n \"in\": \"path\",\n \"name\": \"sessionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.read\"\n ]\n }\n ],\n \"skill_name\": \"get_identity_source_session\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an identity source session\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"get_identity_source_user\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a user by external ID in an identity source for the given identity source instance\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_identity_source_user\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The external ID of the user\",\n \"in\": \"path\",\n \"name\": \"externalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/users/{externalId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.read\"\n ]\n }\n ],\n \"skill_name\": \"get_identity_source_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an identity source user\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"get_inline_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an inline hook by `inlineHookId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_inline_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the inline hook\",\n \"in\": \"path\",\n \"name\": \"inlineHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"Y7Rzrd4g4xj6WdKzrBHH\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/inlineHooks/{inlineHookId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.read\"\n ]\n }\n ],\n \"skill_name\": \"get_inline_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an inline hook\",\n \"tags\": [\n \"InlineHook\"\n ]\n },\n \"get_jwk\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an OAuth 2.0 client JSON Web Key by `keyId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_jwk\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the OAuth 2.0 client JSON Web Key\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/jwks/{keyId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_jwk\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an OAuth 2.0 client JSON Web Key\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"get_linked_object_definition\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a Linked Object definition\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_linked_object_definition\",\n \"parameters\": [\n {\n \"description\": \"Primary or Associated name\",\n \"in\": \"path\",\n \"name\": \"linkedObjectName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.linkedObjects.read\"\n ]\n }\n ],\n \"skill_name\": \"get_linked_object_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a linked object definition\",\n \"tags\": [\n \"LinkedObject\"\n ]\n },\n \"get_log_stream\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a log stream object by ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_log_stream\",\n \"parameters\": [\n {\n \"description\": \"Unique identifier for the log stream\",\n \"in\": \"path\",\n \"name\": \"logStreamId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa1orzg0CHSgPcjZ0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/logStreams/{logStreamId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.logStreams.read\"\n ]\n }\n ],\n \"skill_name\": \"get_log_stream\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a log stream\",\n \"tags\": [\n \"LogStream\"\n ]\n },\n \"get_log_stream_schema\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the schema for a log stream type. The `logStreamType` element in the URL specifies the log stream type, which is either `aws_eventbridge` or `splunk_cloud_logstreaming`. Use the `aws_eventbridge` literal to retrieve the AWS EventBridge type schema, and use the `splunk_cloud_logstreaming` literal retrieve the Splunk Cloud type schema.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_log_stream_schema\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"logStreamType\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/components/schemas/LogStreamType\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/schemas/logStream/{logStreamType}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.logStreams.read\"\n ]\n }\n ],\n \"skill_name\": \"get_log_stream_schema\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the log stream schema for the schema type\",\n \"tags\": [\n \"Schema\"\n ]\n },\n \"get_member_of_binding\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a member (identified by `memberId`) that belongs to a role resource set binding\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_member_of_binding\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the member\",\n \"in\": \"path\",\n \"name\": \"memberId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"irb1qe6PGuMc7Oh8N0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members/{memberId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"get_member_of_binding\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a role resource set binding member\",\n \"tags\": [\n \"RoleDResourceSetBindingMember\"\n ]\n },\n \"get_o_auth2_claim\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a custom token Claim by the specified `claimId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_o_auth2_claim\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of Claim\",\n \"in\": \"path\",\n \"name\": \"claimId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"hNJ3Uk76xLagWkGx5W3N\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/claims/{claimId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"get_o_auth2_claim\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a custom token claim\",\n \"tags\": [\n \"AuthorizationServerClaims\"\n ]\n },\n \"get_o_auth2_client_secret\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an OAuth 2.0 client secrets by `secretId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_o_auth2_client_secret\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the OAuth 2.0 client secret\",\n \"in\": \"path\",\n \"name\": \"secretId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/secrets/{secretId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_o_auth2_client_secret\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an OAuth 2.0 client secret\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"get_o_auth2_resource_server_json_web_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a custom authorization server public JSON web key by key `id`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_o_auth2_resource_server_json_web_key\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique `id` of the Custom Authorization Server JSON Web Key\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"get_o_auth2_resource_server_json_web_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a Custom Authorization Server Public JSON Web Key\",\n \"tags\": [\n \"OAuth2ResourceServerCredentialsKeys\"\n ]\n },\n \"get_o_auth2_scope\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a custom token scope\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_o_auth2_scope\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of Scope\",\n \"in\": \"path\",\n \"name\": \"scopeId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0TMRpCWXRKFjP7HiPFNM\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/scopes/{scopeId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"get_o_auth2_scope\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a custom token scope\",\n \"tags\": [\n \"AuthorizationServerScopes\"\n ]\n },\n \"get_o_auth2_token_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a refresh token for the specified app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_o_auth2_token_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of Token\",\n \"in\": \"path\",\n \"name\": \"tokenId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"sHHSth53yJAyNSTQKDJZ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An optional parameter to return scope details in the `_embedded` property. Valid value: `scope`\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"scope\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/tokens/{tokenId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_o_auth2_token_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an application token\",\n \"tags\": [\n \"ApplicationTokens\"\n ]\n },\n \"get_okta_communication_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves Okta Communication Settings of your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_okta_communication_settings\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/oktaCommunication\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.read\"\n ]\n }\n ],\n \"skill_name\": \"get_okta_communication_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the Okta communication settings\",\n \"tags\": [\n \"OrgSettingCommunication\"\n ]\n },\n \"get_opt_in_status\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the entitlement management opt-in status for the Admin Console\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_opt_in_status\",\n \"parameters\": [],\n \"path\": \"/api/v1/iam/governance/optIn\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"get_opt_in_status\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the Admin Console opt-in status\",\n \"tags\": [\n \"GovernanceBundle\"\n ]\n },\n \"get_org_captcha_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the CAPTCHA settings object for your organization\\n> **Note**: If the current organization hasn't configured CAPTCHA Settings, the request returns an empty object.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_org_captcha_settings\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/captcha\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.captchas.read\"\n ]\n }\n ],\n \"skill_name\": \"get_org_captcha_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the org-wide CAPTCHA settings\",\n \"tags\": [\n \"CAPTCHA\"\n ]\n },\n \"get_org_contact_user\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the ID and the user resource associated with the specified contact type\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_org_contact_user\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"contactType\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Type of contact\",\n \"enum\": [\n \"BILLING\",\n \"TECHNICAL\"\n ],\n \"example\": \"BILLING\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/org/contacts/{contactType}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.read\"\n ]\n }\n ],\n \"skill_name\": \"get_org_contact_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the contact type user\",\n \"tags\": [\n \"OrgSettingContact\"\n ]\n },\n \"get_org_okta_support_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves Okta Support Settings for your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_org_okta_support_settings\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/oktaSupport\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.read\"\n ]\n }\n ],\n \"skill_name\": \"get_org_okta_support_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the Okta Support settings\",\n \"tags\": [\n \"OrgSettingSupport\"\n ]\n },\n \"get_org_preferences\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves preferences of your Okta org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_org_preferences\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/preferences\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.read\"\n ]\n }\n ],\n \"skill_name\": \"get_org_preferences\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the org preferences\",\n \"tags\": [\n \"OrgSettingCustomization\"\n ]\n },\n \"get_org_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the Org General Settings\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_org_settings\",\n \"parameters\": [],\n \"path\": \"/api/v1/org\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.read\"\n ]\n }\n ],\n \"skill_name\": \"get_org_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the Org general settings\",\n \"tags\": [\n \"OrgSettingGeneral\"\n ]\n },\n \"get_preview_error_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_preview_error_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/error/preview\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_preview_error_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the preview error page preview\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"get_preview_sign_in_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_preview_sign_in_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-in/preview\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_preview_sign_in_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the preview sign-in page preview\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"get_profile_mapping\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a single profile mapping referenced by its ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_profile_mapping\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Mapping\",\n \"in\": \"path\",\n \"name\": \"mappingId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cB6u7X8mptebWkffatKA\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/mappings/{mappingId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.profileMappings.read\"\n ]\n }\n ],\n \"skill_name\": \"get_profile_mapping\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a profile mapping\",\n \"tags\": [\n \"ProfileMapping\"\n ]\n },\n \"get_public_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a public key by `keyId`\\n\\n>**Note:** keyId is the alias of the public key.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_public_key\",\n \"parameters\": [\n {\n \"description\": \"id\\\" of the Public Key\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"FcH2P9Eg7wr0o8N2FuV0\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/hook-keys/public/{keyId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.read\"\n ]\n }\n ],\n \"skill_name\": \"get_public_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a public key\",\n \"tags\": [\n \"HookKey\"\n ]\n },\n \"get_refresh_token_for_authorization_server_and_client\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a refresh token for a Client\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_refresh_token_for_authorization_server_and_client\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`client_id` of the app\",\n \"in\": \"path\",\n \"name\": \"clientId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of Token\",\n \"in\": \"path\",\n \"name\": \"tokenId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"sHHSth53yJAyNSTQKDJZ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"get_refresh_token_for_authorization_server_and_client\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a refresh token for a client\",\n \"tags\": [\n \"AuthorizationServerClients\"\n ]\n },\n \"get_resource_set\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a resource set by `resourceSetIdOrLabel`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_resource_set\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"get_resource_set\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a resource set\",\n \"tags\": [\n \"RoleCResourceSet\"\n ]\n },\n \"get_resource_set_resource\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a resource identified by `resourceId` in a resource set\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_resource_set_resource\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the resource\",\n \"in\": \"path\",\n \"name\": \"resourceId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"ire106sQKoHoXXsAe0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"get_resource_set_resource\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a resource set resource\",\n \"tags\": [\n \"RoleCResourceSetResource\"\n ]\n },\n \"get_role\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a role by `roleIdOrLabel`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_role\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/roles/{roleIdOrLabel}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"get_role\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a role\",\n \"tags\": [\n \"RoleECustom\"\n ]\n },\n \"get_role_permission\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a permission (identified by `permissionType`) for a custom role\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_role_permission\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An Okta [permission](/openapi/okta-management/guides/permissions)\",\n \"in\": \"path\",\n \"name\": \"permissionType\",\n \"required\": true,\n \"schema\": {\n \"example\": \"okta.users.manage\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"get_role_permission\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a custom role permission\",\n \"tags\": [\n \"RoleECustomPermission\"\n ]\n },\n \"get_root_brand_well_known_uri\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the well-known URI of a specific brand and well-known URI path\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_root_brand_well_known_uri\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The path of the well-known URI\",\n \"in\": \"path\",\n \"name\": \"path\",\n \"required\": true,\n \"schema\": {\n \"enum\": [\n \"apple-app-site-association\",\n \"assetlinks.json\",\n \"webauthn\"\n ],\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional metadata to include in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"customized\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/well-known-uris/{path}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_root_brand_well_known_uri\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the well-known URI of a specific brand\",\n \"tags\": [\n \"AssociatedDomainCustomizations\"\n ]\n },\n \"get_scope_consent_grant\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a single scope consent Grant object for the app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_scope_consent_grant\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Grant ID\",\n \"in\": \"path\",\n \"name\": \"grantId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iJoqkwx50mrgX4T9LcaH\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An optional parameter to return scope details in the `_embedded` property. Valid value: `scope`\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"scope\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/grants/{grantId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.appGrants.read\"\n ]\n }\n ],\n \"skill_name\": \"get_scope_consent_grant\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve an app grant\",\n \"tags\": [\n \"ApplicationGrants\"\n ]\n },\n \"get_sign_in_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the sign-in page sub-resources. The `expand` query parameter specifies which sub-resources to include in the response.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_sign_in_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"default\",\n \"customized\",\n \"customizedUrl\",\n \"preview\",\n \"previewUrl\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-in\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_sign_in_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the sign-in page sub-resources\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"get_sign_out_page_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the sign-out page settings\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_sign_out_page_settings\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-out/customized\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"get_sign_out_page_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the sign-out page settings\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"get_third_party_admin_setting\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the third-party admin setting. See [Configure third-party administrators](https://help.okta.com/okta_help.htm?type=oie&id=csh_admin-third) in the Okta product documentation.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_third_party_admin_setting\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/orgSettings/thirdPartyAdminSetting\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.read\"\n ]\n }\n ],\n \"skill_name\": \"get_third_party_admin_setting\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the org third-party admin setting\",\n \"tags\": [\n \"OrgSettingAdmin\"\n ]\n },\n \"get_ui_schema\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a UI Schema by `id`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_ui_schema\",\n \"parameters\": [\n {\n \"description\": \"The unique ID of the UI Schema\",\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"schema\": {\n \"example\": \"uis4a7liocgcRgcxZ0g7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/uischemas/{id}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.uischemas.read\"\n ]\n }\n ],\n \"skill_name\": \"get_ui_schema\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a UI schema\",\n \"tags\": [\n \"UISchema\"\n ]\n },\n \"get_user_provisioning_connection_jwks\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a JWKS for the default provisioning connection. This can be used by the OAuth 2.0 app's `jwk_uri` property in the target org.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_user_provisioning_connection_jwks\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/connections/default/jwks\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"get_user_provisioning_connection_jwks\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a JSON Web Key Set (JWKS) for the default provisioning connection\",\n \"tags\": [\n \"ApplicationConnections\"\n ]\n },\n \"get_user_schema\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the schema for a user type\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_user_schema\",\n \"parameters\": [\n {\n \"description\": \"Schema ID. You can also use `default` to refer to the default user type schema.\",\n \"in\": \"path\",\n \"name\": \"schemaId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/schemas/user/{schemaId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.schemas.read\"\n ]\n }\n ],\n \"skill_name\": \"get_user_schema\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a user schema\",\n \"tags\": [\n \"Schema\"\n ]\n },\n \"get_user_type\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a user type by ID. Use `default` to fetch the default user type.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_user_type\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"typeId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The unique key for the user type\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/types/user/{typeId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.userTypes.read\"\n ]\n }\n ],\n \"skill_name\": \"get_user_type\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a user type\",\n \"tags\": [\n \"UserType\"\n ]\n },\n \"get_web_authn_well_known_uri\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the content of the `webauthn` well-known URI\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_web_authn_well_known_uri\",\n \"parameters\": [],\n \"path\": \"/.well-known/webauthn\",\n \"request_body\": null,\n \"security\": [],\n \"skill_name\": \"get_web_authn_well_known_uri\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the customized webauthn URI content\",\n \"tags\": [\n \"AssociatedDomainCustomizations\"\n ]\n },\n \"get_well_known_app_authenticator_configuration\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the well-known app authenticator configuration. Includes an app authenticator's settings, supported methods, and other details.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_well_known_app_authenticator_configuration\",\n \"parameters\": [\n {\n \"description\": \"Filters app authenticator configurations by `oauthClientId`\",\n \"in\": \"query\",\n \"name\": \"oauthClientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/.well-known/app-authenticator-configuration\",\n \"request_body\": null,\n \"security\": [],\n \"skill_name\": \"get_well_known_app_authenticator_configuration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the well-known app authenticator configuration\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"get_wellknown_org_metadata\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the org metadata, which includes the org ID, configured custom domains, and authentication pipeline\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_wellknown_org_metadata\",\n \"parameters\": [],\n \"path\": \"/.well-known/okta-organization\",\n \"request_body\": null,\n \"security\": [],\n \"skill_name\": \"get_wellknown_org_metadata\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the Org metadata\",\n \"tags\": [\n \"OrgSettingMetadata\"\n ]\n },\n \"get_wellknown_ssf_metadata\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves SSF transmitter configuration metadata. This includes all supported endpoints and key information about certain properties of the Okta org as the transmitter, such as `delivery_methods_supported`, `issuer`, and `jwks_uri`.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_wellknown_ssf_metadata\",\n \"parameters\": [],\n \"path\": \"/.well-known/ssf-configuration\",\n \"request_body\": null,\n \"security\": [],\n \"skill_name\": \"get_wellknown_ssf_metadata\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve the SSF transmitter metadata\",\n \"tags\": [\n \"SSFTransmitter\"\n ]\n },\n \"get_yubikey_otp_token_by_id\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the specified YubiKey OTP token by `id`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_yubikey_otp_token_by_id\",\n \"parameters\": [\n {\n \"description\": \"ID of a YubiKey token\",\n \"in\": \"path\",\n \"name\": \"tokenId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"ykkxdtCA1fKVxyu6R0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/org/factors/yubikey_token/tokens/{tokenId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.users.read\"\n ]\n }\n ],\n \"skill_name\": \"get_yubikey_otp_token_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retrieve a YubiKey OTP token\",\n \"tags\": [\n \"UserFactor\"\n ]\n },\n \"grant_aerial_consent\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Grants an Okta Aerial account consent to manage your org. If the org is a child org, consent is taken from the parent org. Grant calls directly to the child are not allowed.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"grant_aerial_consent\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/aerial/grant\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OrgAerialConsent\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"grant_aerial_consent\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Grant Okta Aerial access to your org\",\n \"tags\": [\n \"OrgSettingSupport\"\n ]\n },\n \"grant_consent_to_scope\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Grants consent for the app to request an OAuth 2.0 Okta scope\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"grant_consent_to_scope\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/grants\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OAuth2ScopeConsentGrant\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.appGrants.manage\"\n ]\n }\n ],\n \"skill_name\": \"grant_consent_to_scope\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Grant consent to scope\",\n \"tags\": [\n \"ApplicationGrants\"\n ]\n },\n \"grant_okta_support\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Grants Okta Support temporary access to your org as an administrator for eight hours\\n\\n> **Note:** This resource is deprecated. Use the [Update an Okta Support case](/openapi/okta-management/management/tags/orgsettingsupport/other/updateoktasupportcase) resource to grant Okta Support access for a support case.\\n> For the corresponding Okta Admin Console feature, see [Give access to Okta Support](https://help.okta.com/okta_help.htm?type=oie&id=settings-support-access).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"grant_okta_support\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/oktaSupport/grant\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"grant_okta_support\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Grant Okta Support access\",\n \"tags\": [\n \"OrgSettingSupport\"\n ]\n },\n \"link_user_to_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Links an Okta user to an existing SAML or social identity provider (IdP).\\n\\nThe SAML IdP must have `honorPersistentNameId` set to `true` to use this API.\\nThe [Name Identifier Format](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider!path=protocol/0/settings&t=request) of the incoming assertion must be `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"link_user_to_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of an existing Okta user\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00ub0oNGTSWTBKOLGLNR\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/users/{userId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UserIdentityProviderLinkRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.users.manage\"\n ]\n }\n ],\n \"skill_name\": \"link_user_to_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Link a user to IdP\",\n \"tags\": [\n \"IdentityProviderUsers\"\n ]\n },\n \"list_active_identity_provider_signing_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists the active signing key credential for an identity provider (IdP)\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_active_identity_provider_signing_key\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/credentials/keys/active\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_active_identity_provider_signing_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List the active signing key credential for IdP\",\n \"tags\": [\n \"IdentityProviderSigningKeys\"\n ]\n },\n \"list_agent_pools\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all agent pools with pagination support\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_agent_pools\",\n \"parameters\": [\n {\n \"description\": \"Maximum number of agent pools returned\",\n \"in\": \"query\",\n \"name\": \"limitPerPoolType\",\n \"required\": false,\n \"schema\": {\n \"default\": 5,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Agent type to search for\",\n \"in\": \"query\",\n \"name\": \"poolType\",\n \"required\": false,\n \"schema\": {\n \"$ref\": \"#/components/schemas/AgentType\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.read\"\n ]\n }\n ],\n \"skill_name\": \"list_agent_pools\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all agent pools\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"list_agent_pools_updates\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all agent pool updates\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_agent_pools_updates\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates.\",\n \"in\": \"query\",\n \"name\": \"scheduled\",\n \"required\": false,\n \"schema\": {\n \"type\": \"boolean\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.read\"\n ]\n }\n ],\n \"skill_name\": \"list_agent_pools_updates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all agent pool updates\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"list_all_custom_aagui_ds\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org\\n\\nOnly custom AAGUIDs that an admin has created are returned.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_all_custom_aagui_ds\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/aaguids\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.read\"\n ]\n }\n ],\n \"skill_name\": \"list_all_custom_aagui_ds\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all custom AAGUIDs\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"list_all_sign_in_widget_versions\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all sign-in widget versions supported by the current org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_all_sign_in_widget_versions\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-in/widget-versions\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"list_all_sign_in_widget_versions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all Sign-In Widget versions\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"list_api_tokens\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all the metadata of the active API tokens\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_api_tokens\",\n \"parameters\": [],\n \"path\": \"/api/v1/api-tokens\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apiTokens.read\"\n ]\n }\n ],\n \"skill_name\": \"list_api_tokens\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all API token metadata\",\n \"tags\": [\n \"ApiToken\"\n ]\n },\n \"list_application_group_assignments\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all app group assignments\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_application_group_assignments\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies a filter for a list of assigned groups returned based on their names. The value of `q` is matched against the group `name`.\\nThis filter only supports the `startsWith` operation that matches the `q` string against the beginning of the [group name](openapi/okta-management/management/group#tag/Group/operation/listGroups!c=200&path=profile/name&t=response).\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"example\": \"test\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the `next` page of results. Treat this as an opaque value obtained through the next link relationship. See [Pagination](https://developer.okta.com/docs/api/#pagination).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"example\": 16275000448691,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of objects to return per page.\\nIf there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it).\\nSee [Pagination](/#pagination).\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"format\": \"int32\",\n \"maximum\": 200,\n \"minimum\": 20,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"An optional query parameter to return the corresponding assigned [group](openapi/okta-management/management/group) or the group assignment metadata details in the `_embedded` property.\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"metadata\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/groups\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_application_group_assignments\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all application groups\",\n \"tags\": [\n \"ApplicationGroups\"\n ]\n },\n \"list_application_keys\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all key credentials for an app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_application_keys\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/keys\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_application_keys\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all key credentials\",\n \"tags\": [\n \"ApplicationSSOCredentialKey\"\n ]\n },\n \"list_application_targets_for_application_administrator_role_for_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all app targets for an `APP_ADMIN` role assignment to a group. The response includes a list of OIN-cataloged apps or app instances. The response payload for an app instance contains the `id` property, but an OIN-cataloged app doesn't.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_application_targets_for_application_administrator_role_for_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the role assignment\",\n \"in\": \"path\",\n \"name\": \"roleAssignmentId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"JBCUYUC7IRCVGS27IFCE2SKO\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_application_targets_for_application_administrator_role_for_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all group role app targets\",\n \"tags\": [\n \"RoleBTargetBGroup\"\n ]\n },\n \"list_application_users\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all assigned users for an app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_application_users\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of results. Treat this as an opaque value obtained through the next link relationship. See [Pagination](/#pagination).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"example\": 16275000448691,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of objects to return per page.\\nIf there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it).\\nSee [Pagination](/#pagination).\\n\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 50,\n \"format\": \"int32\",\n \"maximum\": 500,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Specifies a filter for the list of application users returned based on their profile attributes.\\nThe value of `q` is matched against the beginning of the following profile attributes: `userName`, `firstName`, `lastName`, and `email`.\\nThis filter only supports the `startsWith` operation that matches the `q` string against the beginning of the attribute values.\\n> **Note:** For OIDC apps, user profiles don't contain the `firstName` or `lastName` attributes. Therefore, the query only matches against the `userName` or `email` attributes.\\n\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"example\": \"sam\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An optional query parameter to return the corresponding [User](/openapi/okta-management/management/tags/user) object in the `_embedded` property.\\nValid value: `user`\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"user\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/users\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_application_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all application users\",\n \"tags\": [\n \"ApplicationUsers\"\n ]\n },\n \"list_applications\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all apps in the org with pagination. A subset of apps can be returned that match a supported filter expression or query. The results are [paginated](/#pagination) according to the `limit` parameter. If there are multiple pages of results, the header contains a `next` link. Treat the link as an opaque value (follow it, don't parse it).\\n\\n> **Note:** To list all of a member's assigned app links, use the [List all assigned app links endpoint in the User Resources API](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/userresources/other/listapplinks).\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_applications\",\n \"parameters\": [\n {\n \"description\": \"Searches for apps with `name` or `label` properties that starts with the `q` value using the `startsWith` operation\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"example\": \"Okta\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the [pagination](/#pagination) cursor for the next page of results. Treat this as an opaque value obtained through the `next` link relationship.\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"example\": 16278919418571,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies whether to use query optimization. If you specify `useOptimization=true` in the request query, the response contains a subset of app instance properties.\",\n \"in\": \"query\",\n \"name\": \"useOptimization\",\n \"required\": false,\n \"schema\": {\n \"default\": false,\n \"type\": \"boolean\"\n }\n },\n {\n \"description\": \"Specifies whether to include the VPN configuration for existing notifications in the result, regardless of whether VPN notifications are configured\",\n \"in\": \"query\",\n \"name\": \"alwaysIncludeVpnSettings\",\n \"required\": false,\n \"schema\": {\n \"default\": false,\n \"type\": \"boolean\"\n }\n },\n {\n \"description\": \"Specifies the number of results per page\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": -1,\n \"format\": \"int32\",\n \"maximum\": 200,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Filters apps with a supported expression for a subset of properties. Filtering supports the following limited number of properties: `id`, `status`, `credentials.signing.kid`, `settings.slo.enabled`, or `name`. See [Filter](https://developer.okta.com/docs/api/#filter).\",\n \"in\": \"query\",\n \"name\": \"filter\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An optional parameter used for link expansion to embed more resources in the response.\\nOnly supports `expand=user/{userId}` and must be used with the `user.id eq \\\"{userId}\\\"` filter query for the same user.\\nReturns the assigned [application user](/openapi/okta-management/management/tags/applicationusers) in the `_embedded` property.\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"user/0oa1gjh63g214q0Hq0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies whether to include non-active, but not deleted apps in the results\",\n \"in\": \"query\",\n \"name\": \"includeNonDeleted\",\n \"required\": false,\n \"schema\": {\n \"default\": false,\n \"type\": \"boolean\"\n }\n }\n ],\n \"path\": \"/api/v1/apps\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_applications\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all applications\",\n \"tags\": [\n \"Application\"\n ]\n },\n \"list_assigned_applications_for_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all apps that are assigned to a group. See [Application Groups API](/openapi/okta-management/management/tags/applicationgroups/).\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_assigned_applications_for_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of apps\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of app results for a page\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"format\": \"int32\",\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/apps\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"list_assigned_applications_for_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all assigned apps\",\n \"tags\": [\n \"Group\"\n ]\n },\n \"list_associated_servers_by_trusted_type\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all associated Authorization Servers by trusted type for the given `authServerId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_associated_servers_by_trusted_type\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Searches trusted authorization servers when `true` or searches untrusted authorization servers when `false`\",\n \"in\": \"query\",\n \"name\": \"trusted\",\n \"required\": false,\n \"schema\": {\n \"type\": \"boolean\"\n }\n },\n {\n \"description\": \"Searches for the name or audience of the associated authorization servers\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of results for a page\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 200,\n \"format\": \"int32\",\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of the associated authorization servers\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/associatedServers\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_associated_servers_by_trusted_type\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all associated authorization servers\",\n \"tags\": [\n \"AuthorizationServerAssoc\"\n ]\n },\n \"list_authenticator_methods\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all methods of an authenticator identified by `authenticatorId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_authenticator_methods\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/methods\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.read\"\n ]\n }\n ],\n \"skill_name\": \"list_authenticator_methods\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all methods of an authenticator\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"list_authenticators\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all authenticators\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_authenticators\",\n \"parameters\": [],\n \"path\": \"/api/v1/authenticators\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.read\"\n ]\n }\n ],\n \"skill_name\": \"list_authenticators\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all authenticators\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"list_authorization_server_keys\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all of the current, future, and expired Keys used by the Custom Authorization Server\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_authorization_server_keys\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/credentials/keys\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_authorization_server_keys\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all credential keys\",\n \"tags\": [\n \"AuthorizationServerKeys\"\n ]\n },\n \"list_authorization_server_policies\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all policies\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_authorization_server_policies\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_authorization_server_policies\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all policies\",\n \"tags\": [\n \"AuthorizationServerPolicies\"\n ]\n },\n \"list_authorization_server_policy_rules\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all policy rules for the specified Custom Authorization Server and Policy\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_authorization_server_policy_rules\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_authorization_server_policy_rules\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all policy rules\",\n \"tags\": [\n \"AuthorizationServerRules\"\n ]\n },\n \"list_authorization_servers\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all custom authorization servers in the org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_authorization_servers\",\n \"parameters\": [\n {\n \"description\": \"Searches the `name` and `audiences` of authorization servers for matching values\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of authorization server results on a page. Maximum value: 200\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 200,\n \"format\": \"int32\",\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of authorization servers. Treat as an opaque value and obtain through the next link relationship.\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_authorization_servers\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all authorization servers\",\n \"tags\": [\n \"AuthorizationServer\"\n ]\n },\n \"list_behavior_detection_rules\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all behavior detection rules with pagination support\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_behavior_detection_rules\",\n \"parameters\": [],\n \"path\": \"/api/v1/behaviors\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.behaviors.read\"\n ]\n }\n ],\n \"skill_name\": \"list_behavior_detection_rules\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all behavior detection rules\",\n \"tags\": [\n \"Behavior\"\n ]\n },\n \"list_bindings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all bindings for a resource set with pagination support.\\n\\nThe returned `roles` array contains the roles for each binding associated with the specified resource set. If there are more than 100 bindings for the specified resource set, `links.next` provides the resource with pagination for the next list of bindings.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_bindings\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_bindings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all role resource set bindings\",\n \"tags\": [\n \"RoleDResourceSetBinding\"\n ]\n },\n \"list_brand_domains\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all domains associated with a brand by `brandId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_brand_domains\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/domains\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"list_brand_domains\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all domains associated with a brand\",\n \"tags\": [\n \"Brands\"\n ]\n },\n \"list_brand_themes\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all the themes in your brand.\\n\\n> **Important:** Currently each org supports only one theme, therefore this contains a single object only.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_brand_themes\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/themes\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"list_brand_themes\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all themes\",\n \"tags\": [\n \"Themes\"\n ]\n },\n \"list_brands\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all the brands in your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_brands\",\n \"parameters\": [\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"themes\",\n \"domains\",\n \"emailDomain\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Searches the records for matching value\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.read\"\n ]\n }\n ],\n \"skill_name\": \"list_brands\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all brands\",\n \"tags\": [\n \"Brands\"\n ]\n },\n \"list_bundle_entitlement_values\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all entitlement values that are specific to a governance bundle entitlement\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_bundle_entitlement_values\",\n \"parameters\": [\n {\n \"description\": \"The `id` of a bundle\",\n \"in\": \"path\",\n \"name\": \"bundleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"enbllojq9J9J105DL1d6\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of a bundle entitlement\",\n \"in\": \"path\",\n \"name\": \"entitlementId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"ent4rg7fltWSgrlDT8g6\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/governance/bundles/{bundleId}/entitlements/{entitlementId}/values\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_bundle_entitlement_values\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all values for a governance bundle entitlement\",\n \"tags\": [\n \"GovernanceBundle\"\n ]\n },\n \"list_bundle_entitlements\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all entitlements specific to a governance bundle\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_bundle_entitlements\",\n \"parameters\": [\n {\n \"description\": \"The `id` of a bundle\",\n \"in\": \"path\",\n \"name\": \"bundleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"enbllojq9J9J105DL1d6\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/governance/bundles/{bundleId}/entitlements\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_bundle_entitlements\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all entitlements for a governance bundle\",\n \"tags\": [\n \"GovernanceBundle\"\n ]\n },\n \"list_captcha_instances\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all CAPTCHA instances with pagination support. A subset of CAPTCHA instances can be returned that match a supported filter expression or query.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_captcha_instances\",\n \"parameters\": [],\n \"path\": \"/api/v1/captchas\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.captchas.read\"\n ]\n }\n ],\n \"skill_name\": \"list_captcha_instances\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all CAPTCHA instances\",\n \"tags\": [\n \"CAPTCHA\"\n ]\n },\n \"list_csrs_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all certificate signing requests for an app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_csrs_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/csrs\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_csrs_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all certificate signing requests\",\n \"tags\": [\n \"ApplicationSSOCredentialKey\"\n ]\n },\n \"list_csrs_for_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all certificate signing requests (CSRs) for an identity provider (IdP)\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_csrs_for_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/credentials/csrs\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_csrs_for_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all certificate signing requests\",\n \"tags\": [\n \"IdentityProviderSigningKeys\"\n ]\n },\n \"list_custom_domains\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all verified custom domains for the org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_custom_domains\",\n \"parameters\": [],\n \"path\": \"/api/v1/domains\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.domains.read\"\n ]\n }\n ],\n \"skill_name\": \"list_custom_domains\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all custom domains\",\n \"tags\": [\n \"CustomDomain\"\n ]\n },\n \"list_default_device_posture_checks\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all default device posture checks. Default device posture checks are defined by Okta. Their type will always be `BUILTIN`.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_default_device_posture_checks\",\n \"parameters\": [],\n \"path\": \"/api/v1/device-posture-checks/default\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devicePostureChecks.read\"\n ]\n }\n ],\n \"skill_name\": \"list_default_device_posture_checks\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all default device posture checks\",\n \"tags\": [\n \"DevicePostureCheck\"\n ]\n },\n \"list_device_assurance_policies\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all device assurance policies\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_device_assurance_policies\",\n \"parameters\": [],\n \"path\": \"/api/v1/device-assurances\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.deviceAssurance.read\"\n ]\n }\n ],\n \"skill_name\": \"list_device_assurance_policies\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all device assurance policies\",\n \"tags\": [\n \"DeviceAssurance\"\n ]\n },\n \"list_device_integrations\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all device integrations for your org. Examples include Device Posture Provider, Windows Security Center, Chrome Device Trust, OSQuery, and Android Device Trust.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_device_integrations\",\n \"parameters\": [],\n \"path\": \"/api/v1/device-integrations\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.deviceIntegrations.read\"\n ]\n }\n ],\n \"skill_name\": \"list_device_integrations\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all device integrations\",\n \"tags\": [\n \"DeviceIntegrations\"\n ]\n },\n \"list_device_posture_checks\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all device posture checks\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_device_posture_checks\",\n \"parameters\": [],\n \"path\": \"/api/v1/device-posture-checks\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devicePostureChecks.read\"\n ]\n }\n ],\n \"skill_name\": \"list_device_posture_checks\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all device posture checks\",\n \"tags\": [\n \"DevicePostureCheck\"\n ]\n },\n \"list_device_users\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all Users for a device by `deviceId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_device_users\",\n \"parameters\": [\n {\n \"description\": \"`id` of the device\",\n \"in\": \"path\",\n \"name\": \"deviceId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"guo4a5u7JHHhjXrMK0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/devices/{deviceId}/users\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devices.read\"\n ]\n }\n ],\n \"skill_name\": \"list_device_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all users for a device\",\n \"tags\": [\n \"Device\"\n ]\n },\n \"list_devices\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all devices with pagination support.\\n\\n>**Note:** To list all devices enrolled by a user, use the [List all devices endpoint in the User Resources API](/openapi/okta-management/management/userresources/listuserdevices).\\n\\nYou can return a subset of devices that match a supported search criteria using the `search` query parameter.\\nSearches for devices based on the properties specified in the `search` parameter conforming SCIM filter specifications (case-insensitive). This data is eventually consistent. The API returns different results depending on specified queries in the request. Empty list is returned if no objects match `search` request.\\n\\n> **Note:** The `search` parameter results are sourced from an eventually consistent datasource and may not reflect the latest information.\\n\\nDon't use search results directly for record updates, as the data might be stale and therefore overwrite newer data, resulting in data loss.\\n\\nUse an `id` lookup for records that you update to ensure your results contain the latest data.\\n\\nThis operation requires [URL encoding](https://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1). For example, `search=profile.displayName eq \\\"Bob\\\"` is encoded as `search=profile.displayName%20eq%20%22Bob%22`.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_devices\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information.\",\n \"example\": \"200u3des4afA47rYJu1d7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return (recommend `20`)\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 200,\n \"example\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"A SCIM filter expression that filters the results. Searches include all device `profile` properties and the device `id`, `status`, and `lastUpdated` properties.\\n\\nSearches for devices can be filtered by the contains (`co`) operator. You can only use `co` with these select device profile attributes: `profile.displayName`, `profile.serialNumber`, `profile.imei`, `profile.meid`, `profile.udid`, and `profile.sid`. See [Operators](https://developer.okta.com/docs/api/#operators).\",\n \"in\": \"query\",\n \"name\": \"search\",\n \"required\": false,\n \"schema\": {\n \"example\": \"lastUpdated gt \\\"2019-06-01T09:00:00.000Z\\\"\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Includes associated user details and management status for the device in the `_embedded` attribute\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"user\",\n \"userSummary\"\n ],\n \"example\": \"userSummary\",\n \"type\": \"string\",\n \"x-enumDescriptions\": {\n \"user\": \"Lists full details for associated users\",\n \"userSummary\": \"Lists summaries for associated users\"\n }\n }\n }\n ],\n \"path\": \"/api/v1/devices\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devices.read\"\n ]\n }\n ],\n \"skill_name\": \"list_devices\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all devices\",\n \"tags\": [\n \"Device\"\n ]\n },\n \"list_email_customizations\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all customizations of an email template\\n\\n If Custom languages for Okta Email Templates is enabled, all existing customizations are retrieved, including customizations for additional languages. If disabled, only customizations for Okta-supported languages are returned.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_email_customizations\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.read\"\n ]\n }\n ],\n \"skill_name\": \"list_email_customizations\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all email customizations\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"list_email_domains\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all the Email Domains in your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_email_domains\",\n \"parameters\": [\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"brands\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/email-domains\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailDomains.read\"\n ]\n }\n ],\n \"skill_name\": \"list_email_domains\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all email domains\",\n \"tags\": [\n \"EmailDomain\"\n ]\n },\n \"list_email_servers\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all the enrolled custom SMTP server configurations\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_email_servers\",\n \"parameters\": [],\n \"path\": \"/api/v1/email-servers\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_email_servers\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all enrolled SMTP servers\",\n \"tags\": [\n \"EmailServer\"\n ]\n },\n \"list_email_templates\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all supported email templates\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_email_templates\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"settings\",\n \"customizationCount\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.read\"\n ]\n }\n ],\n \"skill_name\": \"list_email_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all email templates\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"list_event_hooks\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all event hooks\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_event_hooks\",\n \"parameters\": [],\n \"path\": \"/api/v1/eventHooks\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.eventHooks.read\"\n ]\n }\n ],\n \"skill_name\": \"list_event_hooks\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all event hooks\",\n \"tags\": [\n \"EventHook\"\n ]\n },\n \"list_feature_dependencies\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all feature dependencies for a specified feature.\\n\\nA feature's dependencies are the features that it requires to be enabled in order for itself to be enabled.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_feature_dependencies\",\n \"parameters\": [\n {\n \"description\": \"`id` of the feature\",\n \"in\": \"path\",\n \"name\": \"featureId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"R5HjqNn1pEqWGy48E9jg\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/features/{featureId}/dependencies\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.features.read\"\n ]\n }\n ],\n \"skill_name\": \"list_feature_dependencies\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all dependencies\",\n \"tags\": [\n \"Feature\"\n ]\n },\n \"list_feature_dependents\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all feature dependents for the specified feature.\\n\\nA feature's dependents are the features that need to be disabled in order for the feature itself to be disabled.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_feature_dependents\",\n \"parameters\": [\n {\n \"description\": \"`id` of the feature\",\n \"in\": \"path\",\n \"name\": \"featureId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"R5HjqNn1pEqWGy48E9jg\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/features/{featureId}/dependents\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.features.read\"\n ]\n }\n ],\n \"skill_name\": \"list_feature_dependents\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all dependents\",\n \"tags\": [\n \"Feature\"\n ]\n },\n \"list_features\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all self-service features for your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_features\",\n \"parameters\": [],\n \"path\": \"/api/v1/features\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.features.read\"\n ]\n }\n ],\n \"skill_name\": \"list_features\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all features\",\n \"tags\": [\n \"Feature\"\n ]\n },\n \"list_features_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all features for an app\\n> **Note:** This request returns an error if provisioning isn't enabled for the app.\\n> To set up provisioning, see [Update the default provisioning connection](/openapi/okta-management/management/applicationconnections/updatedefaultprovisioningconnectionforapplication).\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_features_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/features\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_features_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all features\",\n \"tags\": [\n \"ApplicationFeatures\"\n ]\n },\n \"list_federated_claims\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all federated claims for your app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_federated_claims\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/federated-claims\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_federated_claims\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all configured federated claims\",\n \"tags\": [\n \"ApplicationSSOFederatedClaims\"\n ]\n },\n \"list_governance_bundles\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all governance bundles for the Admin Console in your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_governance_bundles\",\n \"parameters\": [\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/governance/bundles\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_governance_bundles\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all governance bundles\",\n \"tags\": [\n \"GovernanceBundle\"\n ]\n },\n \"list_group_assigned_roles\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all assigned roles of a group by `groupId`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_group_assigned_roles\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An optional parameter used to return targets configured for the standard role assignment in the `embedded` property. Supported values: `targets/groups` or `targets/catalog/apps`\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_group_assigned_roles\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all group role assignments\",\n \"tags\": [\n \"RoleAssignmentBGroup\"\n ]\n },\n \"list_group_owners\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all owners for a specific group\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_group_owners\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"SCIM filter expression for group owners. Allows you to filter owners by type.\",\n \"in\": \"query\",\n \"name\": \"search\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of owners\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of owner results in a page\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 1000,\n \"format\": \"int32\",\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/owners\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"list_group_owners\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all group owners\",\n \"tags\": [\n \"GroupOwner\"\n ]\n },\n \"list_group_push_mappings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all group push mappings with pagination support\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_group_push_mappings\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of mappings\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of results returned\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 100,\n \"format\": \"int32\",\n \"maximum\": 1000,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Filters group push mappings by last updated date. The `lastUpdated` parameter supports the following format: `YYYY-MM-DDTHH:mm:ssZ`. This filters mappings updated on or after the specified date and time in UTC.\\n\\nIf you don't specify a value, all group push mappings are returned.\",\n \"in\": \"query\",\n \"name\": \"lastUpdated\",\n \"required\": false,\n \"schema\": {\n \"example\": \"2025-01-01T00:00:00Z\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters group push mappings by source group ID. If you don't specify a value, all group push mappings are returned.\",\n \"in\": \"query\",\n \"name\": \"sourceGroupId\",\n \"required\": false,\n \"schema\": {\n \"example\": \"00g00000000000000000\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters group push mappings by status. If you don't specify a value, all group push mappings are returned.\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"$ref\": \"#/components/schemas/GroupPushMappingStatus\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/group-push/mappings\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\",\n \"okta.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"list_group_push_mappings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all group push mappings\",\n \"tags\": [\n \"GroupPushMapping\"\n ]\n },\n \"list_group_rules\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all group rules for your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_group_rules\",\n \"parameters\": [\n {\n \"description\": \"Specifies the number of rule results in a page\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 50,\n \"format\": \"int32\",\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of rules\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the keyword to search rules for\",\n \"in\": \"query\",\n \"name\": \"search\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"If specified, returns the mapping of group IDs to group names in the `_embedded` object.\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"groupIdToGroupNameMap\"\n ],\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/rules\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"list_group_rules\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all group rules\",\n \"tags\": [\n \"GroupRule\"\n ]\n },\n \"list_group_targets_for_group_role\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all group targets for a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a group.\\nIf the role isn't scoped to specific group targets, Okta returns an empty array `[]`.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_group_targets_for_group_role\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the role assignment\",\n \"in\": \"path\",\n \"name\": \"roleAssignmentId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"JBCUYUC7IRCVGS27IFCE2SKO\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_group_targets_for_group_role\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all group role group targets\",\n \"tags\": [\n \"RoleBTargetBGroup\"\n ]\n },\n \"list_group_users\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all users that are a member of a group.\\nThe default user limit is set to a very high number due to historical reasons that are no longer valid for most orgs. This will change in a future version of this API. The recommended page limit is now `limit=200`.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_group_users\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of user results in a page\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 1000,\n \"format\": \"int32\",\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/users\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"list_group_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all member users\",\n \"tags\": [\n \"Group\"\n ]\n },\n \"list_groups\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all groups with pagination support.\\n\\n> **Note:** To list all groups belonging to a member, use the [List all groups endpoint in the User Resources API](/openapi/okta-management/management/tags/userresources/other/listusergroups).\\n\\nThe number of groups returned depends on the specified [`limit`](/openapi/okta-management/management/group/listgroups#group/listgroups/t=request&in=query&path=limit), if you have a search, filter, and/or query parameter set, and if that parameter is not null. We recommend using a limit less than or equal to 200.\\n\\nA subset of groups can be returned that match a supported filter expression, query, or search criteria.\\n\\n> **Note:** The `search` parameter results are sourced from an eventually consistent datasource and may not reflect the latest information.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_groups\",\n \"parameters\": [\n {\n \"description\": \"Searches for groups with a supported [filtering](https://developer.okta.com/docs/api/#filter) expression for all properties except for `_embedded`, `_links`, and `objectClass`. Okta recommends this query parameter because it provides the largest range of search options and optimal performance.\\n\\nThis operation supports [pagination](https://developer.okta.com/docs/api/#pagination).\\n\\nThe `search` string requires [URL encoding](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). For example, `search=type eq \\\"OKTA_GROUP\\\"` is encoded as `search=type+eq+%22OKTA_GROUP%22`.\\n\\nThis operation searches many properties:\\n\\n* Any group profile attribute, including imported app group profile attributes.\\n* The top-level properties: `id`, `created`, `lastMembershipUpdated`, `lastUpdated`, and `type`.\\n* The [source](/openapi/okta-management/management/group/listgroups#group/listgroups/t=response&c=200&path=_links/source) of groups with type of `APP_GROUP`, accessed as `source.id`.\\n\\nYou can also use the `sortBy` and `sortOrder` parameters.\\n\\nSearches for groups can be filtered by the following operators: `sw`, `eq`, and `co`. You can only use `co` with these select profile attributes: `profile.name` and `profile.description`. See [Operators](https://developer.okta.com/docs/api/#operators).\",\n \"in\": \"query\",\n \"name\": \"search\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filter expression for groups. See [Filter](https://developer.okta.com/docs/api/#filter).\\n\\nFiltering supports the following limited number of properties: `id`, `type`, `lastUpdated`, and `lastMembershipUpdated`.\\n\\n> **Note:** All filters must be [URL encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). For example, `filter=lastUpdated gt \\\"2013-06-01T00:00:00.000Z\\\"` is encoded as `filter=lastUpdated%20gt%20%222013-06-01T00:00:00.000Z%22`. See [Special characters](https://developer.okta.com/docs/api/#special-characters).\",\n \"in\": \"query\",\n \"name\": \"filter\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Finds a group that matches the `name` property.\\n> **Note:** Paging and searching are currently mutually exclusive. You can't page a query. The default limit for a query is 300 results. Query is intended for an auto-complete picker use case where users refine their search string to constrain the results.\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"example\": \"West&limit=10\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of groups. The `after` cursor should be treated as an opaque value and obtained through the next link relation. See [Pagination](https://developer.okta.com/docs/api/#pagination).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of group results in a page.\\n\\nOkta recommends using a specific value other than the default or maximum. If your request times out, retry your request with a smaller `limit` and [page the results](https://developer.okta.com/docs/api/#pagination).\\n\\nThe Okta default `Everyone` group isn't returned for users with a group admin role.\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"format\": \"int32\",\n \"maximum\": 10000,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"If specified, additional metadata is included in the response. Possible values are `stats` and `app`. This additional metadata is listed in the [`_embedded`](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/addGroup!c=200&path=_embedded&t=response) property of the response.\\n\\n> **Note:** You can use the `stats` value to return the number of users within a group. This is listed as the `_embedded.stats.usersCount` value in the response. See this [Knowledge Base article](https://support.okta.com/help/s/article/Is-there-an-API-that-returns-the-number-of-users-in-a-group?language=en_US) for more information and an example.\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the field to sort by (for search queries only). `sortBy` can be any single property, for example `sortBy=profile.name`. Groups with the same value for the `sortBy` property are ordered by `id`'. Use with `sortOrder` to control the order of results.\",\n \"in\": \"query\",\n \"name\": \"sortBy\",\n \"required\": false,\n \"schema\": {\n \"example\": \"lastUpdated\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies sort order: `asc` or `desc` (for search queries only). This parameter is ignored if `sortBy` isn't present.\",\n \"in\": \"query\",\n \"name\": \"sortOrder\",\n \"required\": false,\n \"schema\": {\n \"default\": \"asc\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"list_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all groups\",\n \"tags\": [\n \"Group\"\n ]\n },\n \"list_hook_keys\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all keys\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_hook_keys\",\n \"parameters\": [],\n \"path\": \"/api/v1/hook-keys\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.read\"\n ]\n }\n ],\n \"skill_name\": \"list_hook_keys\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all keys\",\n \"tags\": [\n \"HookKey\"\n ]\n },\n \"list_identity_provider_application_users\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all the users linked to an identity provider (IdP)\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_identity_provider_application_users\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Searches the records for matching value\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Expand user data\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"user\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/users\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_identity_provider_application_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all users for IdP\",\n \"tags\": [\n \"IdentityProviderUsers\"\n ]\n },\n \"list_identity_provider_keys\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all identity provider (IdP) key credentials\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_identity_provider_keys\",\n \"parameters\": [\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/credentials/keys\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_identity_provider_keys\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all IdP key credentials\",\n \"tags\": [\n \"IdentityProviderKeys\"\n ]\n },\n \"list_identity_provider_signing_keys\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all signing key credentials for an identity provider (IdP)\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_identity_provider_signing_keys\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/credentials/keys\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_identity_provider_signing_keys\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all signing key credentials for IdP\",\n \"tags\": [\n \"IdentityProviderSigningKeys\"\n ]\n },\n \"list_identity_providers\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all identity provider (IdP) integrations with pagination. A subset of IdPs can be returned that match a supported filter expression or query.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_identity_providers\",\n \"parameters\": [\n {\n \"description\": \"Searches the `name` property of IdPs for matching value\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Filters IdPs by `type`\",\n \"in\": \"query\",\n \"name\": \"type\",\n \"required\": false,\n \"schema\": {\n \"$ref\": \"#/components/schemas/IdentityProviderType\"\n }\n }\n ],\n \"path\": \"/api/v1/idps\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_identity_providers\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all IdPs\",\n \"tags\": [\n \"IdentityProvider\"\n ]\n },\n \"list_identity_source_sessions\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all identity source sessions for the given identity source instance\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_identity_source_sessions\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.read\"\n ]\n }\n ],\n \"skill_name\": \"list_identity_source_sessions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all identity source sessions\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"list_inline_hooks\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all inline hooks or all inline hooks of a specific type.\\n\\nWhen listing a specific inline hook, you need to specify its type. The following types are currently supported:\\n | Type Value | Name |\\n |------------------------------------|----------------------------------------------------------------|\\n | `com.okta.import.transform` | [User import inline hook](/openapi/okta-management/management/management/inlinehook/createuserimportinlinehook) |\\n | `com.okta.oauth2.tokens.transform` | [Token inline hook](/openapi/okta-management/management/management/inlinehook/createtokeninlinehook) |\\n | `com.okta.saml.tokens.transform` | [SAML assertion inline hook](/openapi/okta-management/management/management/inlinehook/createsamlassertioninlinehook) |\\n | `com.okta.telephony.provider` | [Telephony inline hook](/openapi/okta-management/management/management/inlinehook/createtelephonyinlinehook) |\\n | `com.okta.user.credential.password.import` | [Password import inline hook](openapi/okta-management/management/management/inlinehook/createpasswordimportinlinehook)|\\n | `com.okta.user.pre-registration` | [Registration inline hook](/openapi/okta-management/management/management/inlinehook/create-registration-hook) |\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_inline_hooks\",\n \"parameters\": [\n {\n \"description\": \"One of the supported inline hook types\",\n \"in\": \"query\",\n \"name\": \"type\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"com.okta.import.transform\",\n \"com.okta.oauth2.tokens.transform\",\n \"com.okta.saml.tokens.transform\",\n \"com.okta.user.credential.password.import\",\n \"com.okta.user.pre-registration\",\n \"com.okta.telephony.provider\"\n ],\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/inlineHooks\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.read\"\n ]\n }\n ],\n \"skill_name\": \"list_inline_hooks\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all inline hooks\",\n \"tags\": [\n \"InlineHook\"\n ]\n },\n \"list_interclient_allowed_applications\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all apps allowed by this app to request interclient SSO using the interclient token\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_interclient_allowed_applications\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/interclient-allowed-apps\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.interclientTrust.read\"\n ]\n }\n ],\n \"skill_name\": \"list_interclient_allowed_applications\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all allowed apps for a target app\",\n \"tags\": [\n \"ApplicationInterclientTrustMappings\"\n ]\n },\n \"list_interclient_target_applications\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all the target apps that allow this app to request interclient SSO using an interclient token\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_interclient_target_applications\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/interclient-target-apps\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.interclientTrust.read\"\n ]\n }\n ],\n \"skill_name\": \"list_interclient_target_applications\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all target apps for an allowed app\",\n \"tags\": [\n \"ApplicationInterclientTrustMappings\"\n ]\n },\n \"list_jwk\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all JSON Web Keys for an OAuth 2.0 client app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_jwk\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/jwks\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_jwk\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all the OAuth 2.0 client JSON Web Keys\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"list_linked_object_definitions\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all Linked Object definitions\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_linked_object_definitions\",\n \"parameters\": [],\n \"path\": \"/api/v1/meta/schemas/user/linkedObjects\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.linkedObjects.read\"\n ]\n }\n ],\n \"skill_name\": \"list_linked_object_definitions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all linked object definitions\",\n \"tags\": [\n \"LinkedObject\"\n ]\n },\n \"list_log_events\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all System Log events\\n\\nSee [System Log query](https://developer.okta.com/docs/reference/system-log-query/) for further details and examples, and [System Log filters and search](https://help.okta.com/okta_help.htm?type=oie&id=csh-syslog-filters) for common use cases.\\n\\nBy default, 100 System Log events are returned. If there are more events, see the [header link](https://developer.okta.com/docs/api/#link-header) for the `next` link,\\nor increase the number of returned objects using the `limit` parameter.\\n\\n>**Note:** The value of the `clientSecret` property in the System Log is secured by a hashing function, and isn't the value used during authentication.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_log_events\",\n \"parameters\": [\n {\n \"description\": \"Filters the lower time bound of the log events `published` property for bounded queries or persistence time for polling queries\",\n \"in\": \"query\",\n \"name\": \"since\",\n \"required\": false,\n \"schema\": {\n \"default\": \"7 days prior to until\",\n \"format\": \"ISO 8601 compliant timestamp\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters the upper time bound of the log events `published` property for bounded queries or persistence time for polling queries.\",\n \"in\": \"query\",\n \"name\": \"until\",\n \"required\": false,\n \"schema\": {\n \"default\": \"current time\",\n \"format\": \"ISO 8601 compliant timestamp\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Retrieves the next page of results. Okta returns a link in the HTTP Header (`rel=next`) that includes the after query parameter\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"format\": \"Opaque token\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filter expression that filters the results. All operators except [ ] are supported. See [Filter](https://developer.okta.com/docs/api/#filter) and [Operators](https://developer.okta.com/docs/api/#operators).\",\n \"in\": \"query\",\n \"name\": \"filter\",\n \"required\": false,\n \"schema\": {\n \"format\": \"SCIM Filter expression\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters log events results by one or more case insensitive keywords.\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"format\": \"URL encoded string. Max length is 40 characters per keyword, with a maximum of 10 keyword filters per query (before encoding)\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the number of results that are returned in the response\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 100,\n \"format\": \"Integer between 0 and 1000\",\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"The order of the returned events that are sorted by the `published` property\",\n \"in\": \"query\",\n \"name\": \"sortOrder\",\n \"required\": false,\n \"schema\": {\n \"default\": \"ASCENDING\",\n \"enum\": [\n \"ASCENDING\",\n \"DESCENDING\"\n ],\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/logs\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.logs.read\"\n ]\n }\n ],\n \"skill_name\": \"list_log_events\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all System Log events\",\n \"tags\": [\n \"SystemLog\"\n ]\n },\n \"list_log_stream_schemas\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists the schema for all log stream types visible for this org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_log_stream_schemas\",\n \"parameters\": [],\n \"path\": \"/api/v1/meta/schemas/logStream\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.logStreams.read\"\n ]\n }\n ],\n \"skill_name\": \"list_log_stream_schemas\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List the log stream schemas\",\n \"tags\": [\n \"Schema\"\n ]\n },\n \"list_log_streams\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all log stream objects in your org. You can request a paginated list or a subset of log streams that match a supported filter expression.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_log_streams\",\n \"parameters\": [\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"An expression that [filters](/#filter) the returned objects. You can only use the `eq` operator on either the `status` or `type` properties in the filter expression.\",\n \"in\": \"query\",\n \"name\": \"filter\",\n \"required\": false,\n \"schema\": {\n \"example\": \"type eq \\\"aws_eventbridge\\\"\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/logStreams\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.logStreams.read\"\n ]\n }\n ],\n \"skill_name\": \"list_log_streams\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all log streams\",\n \"tags\": [\n \"LogStream\"\n ]\n },\n \"list_members_of_binding\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all members of a role resource set binding with pagination support\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_members_of_binding\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_members_of_binding\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all role resource set binding members\",\n \"tags\": [\n \"RoleDResourceSetBindingMember\"\n ]\n },\n \"list_o_auth2_claims\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all custom token Claims defined for a specified custom authorization server\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_o_auth2_claims\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/claims\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_o_auth2_claims\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all custom token claims\",\n \"tags\": [\n \"AuthorizationServerClaims\"\n ]\n },\n \"list_o_auth2_client_secrets\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all client secrets for an OAuth 2.0 client app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_o_auth2_client_secrets\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/secrets\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_o_auth2_client_secrets\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all OAuth 2.0 client secrets\",\n \"tags\": [\n \"ApplicationSSOPublicKeys\"\n ]\n },\n \"list_o_auth2_clients_for_authorization_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all client resources for which the specified authorization server has tokens.\\n\\n> **Note:** To list a specific user's client resources for which they have tokens or grants, use the [List all clients endpoint in the User Resources API](/openapi/okta-management/management/userresources/listuserclients).\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_o_auth2_clients_for_authorization_server\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/clients\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_o_auth2_clients_for_authorization_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all client resources for an authorization server\",\n \"tags\": [\n \"AuthorizationServerClients\"\n ]\n },\n \"list_o_auth2_resource_server_json_web_keys\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all the public keys used by the custom authorization server\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_o_auth2_resource_server_json_web_keys\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_o_auth2_resource_server_json_web_keys\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all Custom Authorization Server Public JSON Web Keys\",\n \"tags\": [\n \"OAuth2ResourceServerCredentialsKeys\"\n ]\n },\n \"list_o_auth2_scopes\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all custom token scopes\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_o_auth2_scopes\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Searches the `name` of Custom Token Scopes for matching values\",\n \"in\": \"query\",\n \"name\": \"q\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filter expression for Custom Token Scopes\",\n \"in\": \"query\",\n \"name\": \"filter\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of scopes.\\nTreat the after cursor as an opaque value and obtain it through the next link relationship. See [Pagination](https://developer.okta.com/docs/api/#pagination).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of objects to return per page.\\nIf there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it). See [Pagination](https://developer.okta.com/docs/api/#pagination).\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"maximum\": 200,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/scopes\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_o_auth2_scopes\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all custom token scopes\",\n \"tags\": [\n \"AuthorizationServerScopes\"\n ]\n },\n \"list_o_auth2_tokens_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all refresh tokens for an app\\n\\n> **Note:** The results are [paginated](/#pagination) according to the `limit` parameter.\\n> If there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it).\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_o_auth2_tokens_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An optional parameter to return scope details in the `_embedded` property. Valid value: `scope`\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"scope\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of results. Treat this as an opaque value obtained through the next link relationship. See [Pagination](/#pagination).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"example\": 16275000448691,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A limit on the number of objects to return\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/tokens\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_o_auth2_tokens_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all application refresh tokens\",\n \"tags\": [\n \"ApplicationTokens\"\n ]\n },\n \"list_okta_support_cases\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all Okta Support cases that the requesting principal has permission to view\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_okta_support_cases\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/oktaSupport/cases\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.read\"\n ]\n }\n ],\n \"skill_name\": \"list_okta_support_cases\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all Okta Support cases\",\n \"tags\": [\n \"OrgSettingSupport\"\n ]\n },\n \"list_org_contact_types\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all org contact types for your Okta org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_org_contact_types\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/contacts\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.read\"\n ]\n }\n ],\n \"skill_name\": \"list_org_contact_types\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all org contact types\",\n \"tags\": [\n \"OrgSettingContact\"\n ]\n },\n \"list_profile_mappings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all profile mappings in your org with [pagination](https://developer.okta.com/docs/api/#pagination). You can return a subset of profile mappings that match a supported `sourceId` and/or `targetId`.\\n\\nThe results are [paginated](/#pagination) according to the `limit` parameter. If there are multiple pages of results, the Link header contains a `next` link that you should treat as an opaque value (follow it, don't parse it). See [Link Header](https://developer.okta.com/docs/api/#link-header).\\n\\nThe response is a collection of profile mappings that include a subset of the profile mapping object's parameters. The profile mapping object describes\\nthe properties mapping between an Okta user and an app user profile using [JSON Schema Draft 4](https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-04).\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_profile_mappings\",\n \"parameters\": [\n {\n \"description\": \"Mapping `id` that specifies the pagination cursor for the next page of mappings\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of results per page\\n> **Note:** If you encounter timeout errors with larger values, reduce the limit (for example, `50`) and use pagination with the `after` parameter to retrieve the results.\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"format\": \"int32\",\n \"maximum\": 200,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"The user type or app instance ID that acts as the source of expressions in a mapping. If this parameter is included, all returned mappings have this as their `source.id`.\",\n \"in\": \"query\",\n \"name\": \"sourceId\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The user type or app instance ID that acts as the target of expressions in a mapping. If this parameter is included, all returned mappings have this as their `target.id`.\",\n \"in\": \"query\",\n \"name\": \"targetId\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/mappings\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.profileMappings.read\"\n ]\n }\n ],\n \"skill_name\": \"list_profile_mappings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all profile mappings\",\n \"tags\": [\n \"ProfileMapping\"\n ]\n },\n \"list_refresh_tokens_for_authorization_server_and_client\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all refresh tokens issued by an authorization server for a specific Client\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_refresh_tokens_for_authorization_server_and_client\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`client_id` of the app\",\n \"in\": \"path\",\n \"name\": \"clientId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of tokens\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of tokens to return (maximum 200)\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": -1,\n \"format\": \"int32\",\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.read\"\n ]\n }\n ],\n \"skill_name\": \"list_refresh_tokens_for_authorization_server_and_client\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all refresh tokens for a client\",\n \"tags\": [\n \"AuthorizationServerClients\"\n ]\n },\n \"list_resource_set_resources\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all resources for the resource set\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_resource_set_resources\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the pagination cursor for the next page of targets\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of results returned. Defaults to `100`.\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 100,\n \"format\": \"int32\",\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_resource_set_resources\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all resource set resources\",\n \"tags\": [\n \"RoleCResourceSetResource\"\n ]\n },\n \"list_resource_sets\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all resource sets with pagination support\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_resource_sets\",\n \"parameters\": [\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_resource_sets\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all resource sets\",\n \"tags\": [\n \"RoleCResourceSet\"\n ]\n },\n \"list_role_permissions\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all permissions for a custom role by `roleIdOrLabel`\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_role_permissions\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/roles/{roleIdOrLabel}/permissions\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_role_permissions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all custom role permissions\",\n \"tags\": [\n \"RoleECustomPermission\"\n ]\n },\n \"list_roles\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all custom roles with pagination support\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_roles\",\n \"parameters\": [\n {\n \"description\": \"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/roles\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_roles\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all custom roles\",\n \"tags\": [\n \"RoleECustom\"\n ]\n },\n \"list_scope_consent_grants\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all scope consent Grants for the app\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_scope_consent_grants\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An optional parameter to return scope details in the `_embedded` property. Valid value: `scope`\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"example\": \"scope\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/grants\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.appGrants.read\"\n ]\n }\n ],\n \"skill_name\": \"list_scope_consent_grants\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all app grants\",\n \"tags\": [\n \"ApplicationGrants\"\n ]\n },\n \"list_social_auth_tokens\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists the tokens minted by the social authentication provider when the user authenticates with Okta via Social Auth.\\n\\nOkta doesn't import all the user information from a social provider. If the app needs information that isn't imported, it can get the user token from this endpoint. Then the app can make an API call to the social provider with the token to request the additional information.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_social_auth_tokens\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of an existing Okta user\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00ub0oNGTSWTBKOLGLNR\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/users/{userId}/credentials/tokens\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.read\"\n ]\n }\n ],\n \"skill_name\": \"list_social_auth_tokens\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all tokens from OIDC IdP\",\n \"tags\": [\n \"IdentityProviderUsers\"\n ]\n },\n \"list_ui_schemas\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all UI Schemas in your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_ui_schemas\",\n \"parameters\": [],\n \"path\": \"/api/v1/meta/uischemas\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.uischemas.read\"\n ]\n }\n ],\n \"skill_name\": \"list_ui_schemas\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all UI schemas\",\n \"tags\": [\n \"UISchema\"\n ]\n },\n \"list_user_types\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all user types in your org\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_user_types\",\n \"parameters\": [],\n \"path\": \"/api/v1/meta/types/user\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.userTypes.read\"\n ]\n }\n ],\n \"skill_name\": \"list_user_types\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all user types\",\n \"tags\": [\n \"UserType\"\n ]\n },\n \"list_users_with_role_assignments\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all users with role assignments\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_users_with_role_assignments\",\n \"parameters\": [\n {\n \"description\": \"Specifies the pagination cursor for the next page of targets\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the number of results returned. Defaults to `100`.\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 100,\n \"format\": \"int32\",\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/assignees/users\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.read\"\n ]\n }\n ],\n \"skill_name\": \"list_users_with_role_assignments\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all users with role assignments\",\n \"tags\": [\n \"RoleAssignmentAUser\"\n ]\n },\n \"list_yubikey_otp_tokens\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Lists all YubiKey OTP tokens\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_yubikey_otp_tokens\",\n \"parameters\": [\n {\n \"description\": \"Specifies the pagination cursor for the next page of tokens\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Embeds the [user](/openapi/okta-management/management/tags/user) resource if the YubiKey token is assigned to a user and `expand` is set to `user`\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The expression used to filter tokens\",\n \"in\": \"query\",\n \"name\": \"filter\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"profile.email\",\n \"profile.serial\",\n \"activated\",\n \"user.id\",\n \"created\",\n \"status\",\n \"lastVerified\"\n ],\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Returns tokens in a CSV to download instead of in the response. When you use this query parameter, the `limit` default changes to 1000.\",\n \"in\": \"query\",\n \"name\": \"forDownload\",\n \"required\": false,\n \"schema\": {\n \"default\": false,\n \"type\": \"boolean\"\n }\n },\n {\n \"description\": \"Specifies the number of results per page\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"The value of how the tokens are sorted\",\n \"in\": \"query\",\n \"name\": \"sortBy\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"profile.email\",\n \"profile.serial\",\n \"activated\",\n \"user.id\",\n \"created\",\n \"status\",\n \"lastVerified\"\n ],\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the sort order, either `ASC` or `DESC`\",\n \"in\": \"query\",\n \"name\": \"sortOrder\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"ASC\",\n \"DESC\"\n ],\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/org/factors/yubikey_token/tokens\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.users.read\"\n ]\n }\n ],\n \"skill_name\": \"list_yubikey_otp_tokens\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"List all YubiKey OTP tokens\",\n \"tags\": [\n \"UserFactor\"\n ]\n },\n \"opt_in\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Opts in the Admin Console to entitlement management\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"opt_in\",\n \"parameters\": [],\n \"path\": \"/api/v1/iam/governance/optIn\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"opt_in\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Opt in the Admin Console to entitlement management\",\n \"tags\": [\n \"GovernanceBundle\"\n ]\n },\n \"opt_in_users_to_okta_communication_emails\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Opts in all users of this org to Okta communication emails\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"opt_in_users_to_okta_communication_emails\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/oktaCommunication/optIn\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"opt_in_users_to_okta_communication_emails\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Opt in to Okta user communication emails\",\n \"tags\": [\n \"OrgSettingCommunication\"\n ]\n },\n \"opt_out\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Opts out the Admin Console from entitlement management\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"opt_out\",\n \"parameters\": [],\n \"path\": \"/api/v1/iam/governance/optOut\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"opt_out\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Opt out the Admin Console from entitlement management\",\n \"tags\": [\n \"GovernanceBundle\"\n ]\n },\n \"opt_out_users_from_okta_communication_emails\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Opts out all users of this org from Okta communication emails\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"opt_out_users_from_okta_communication_emails\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/oktaCommunication/optOut\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"opt_out_users_from_okta_communication_emails\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Opt out of Okta user communication emails\",\n \"tags\": [\n \"OrgSettingCommunication\"\n ]\n },\n \"pause_agent_pools_update\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Pauses a running or queued agent pool update\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"pause_agent_pools_update\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the update\",\n \"in\": \"path\",\n \"name\": \"updateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/{updateId}/pause\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.manage\"\n ]\n }\n ],\n \"skill_name\": \"pause_agent_pools_update\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Pause an agent pool update\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"preview_sam_lmetadata_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Previews the SSO SAML metadata for an application\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"preview_sam_lmetadata_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"kid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"mXtzOtml09Dg1ZCeKxTRBo3KrQuBWFkJ5oxhVagjTzo\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/sso/saml/metadata\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.read\"\n ]\n }\n ],\n \"skill_name\": \"preview_sam_lmetadata_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Preview the application SAML metadata\",\n \"tags\": [\n \"ApplicationSSO\"\n ]\n },\n \"publish_csr_for_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Publishes the certificate signing request (CSR) with a signed X.509 certificate and adds it into the signing key credentials for the identity provider (IdP)\\n> **Notes:**\\n> * Publishing a certificate completes the lifecycle of the CSR, and it's no longer accessible.\\n> * If the validity period of the certificate is less than 90 days, a 400 error response is returned.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"publish_csr_for_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the IdP CSR\",\n \"in\": \"path\",\n \"name\": \"idpCsrId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"1uEhyE65oV3H6KM9gYcN\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}/lifecycle/publish\",\n \"request_body\": {\n \"description\": \"X.509 certificate in `DER` format.\\nThe client can either post in binary or Base64URL-encoded. If the post is Base64URL-encoded, set the `Content-Transfer-Encoding` header to `base64`.\",\n \"example\": \"MIIFgjCCA2qgAwIBAgICEAcwDQYJKoZIhvcNAQELBQAwXjELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMQ0wCwYDVQQKDARPa3RhMQwwCgYDVQQLDANFbmcxDTALBgNVBAMMBFJvb3QwHhcNMTcwMzI3MjEyMDQ3WhcNMTgwNDA2MjEyMDQ3WjB4MQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzETMBEGA1UECgwKT2t0YSwgSW5jLjEQMA4GA1UECwwHSmFua3lDbzEVMBMGA1UEAwwMSWRQIElzc3VlciA3MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmkC6yAJVvFwUlmM9gKjb2d+YK5qHFt+mXSsbjWKKs4EfNm+BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL/q7n0f/SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH+bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQIDAQABo4IBLjCCASowCQYDVR0TBAIwADARBglghkgBhvhCAQEEBAMCBkAwMwYJYIZIAYb4QgENBCYWJE9wZW5TU0wgR2VuZXJhdGVkIFNlcnZlciBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQUVqJukDmyENw/2pTApbxc/HRKbngwgZAGA1UdIwSBiDCBhYAUFx245ZZXqWTTbARfMlFWN77L9EahYqRgMF4xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJDQTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEMMAoGA1UECwwDRW5nMQ0wCwYDVQQDDARSb290ggkAlIfpwZjO5o8wDgYDVR0PAQH/BAQDAgWgMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUAA4ICAQCcoBSRtY+9cJY00hLvq6AloYZcdn/kUQupfmyz4n3lKE3wV2FB0swKnK0QDi8iNuQJFdag/19vDHC4/LhoSuv1Q+KXM61pPZVRXXPyC1+e7Y6hj93tEI5HcqLPcDRH1AIG2l8tE7LBn+MQB5Vh6oxjG2IdoWxg6abMfISU+MauPWql4vMDUWo9iNShAo44Z5fd+nuz+hlAinU9Xn9Jf2QsfKvcbMRq7iuqgkabgdmObmWb9KK0Vm7TDkxCH0pB0onPr6epVUP8Obg/pT1Oj/1hOLbfR8CHHWdAWzUBGGvp2TIy2A8LUaEoFnwkxZfdL7Bnd0RH/ClBtAjzLOxmUo7NbZmEnYCcD5pZz7BdZI0db/eBXFqfOlA88rEe+9Sv+NndIq0/WNIIsJi2RgjJnxsxvB5MjhhzmItpFIUl5yqoO3C9jcCp6HDBJxtCGbvAr5ALPn5RCJeBIr67WpAiTd7L3Ebu9SQZlXnoHX8kP04EA6ylR3W0EFbh7KUtq8M2H2vo0wjMj7ysl/3tT7cEZ97s1ygO5iJx3GfMDyrDhtLXSBJ20uSxTJeptRw8SDiwTqunIh1WyKlcQz1WGauSbW4eXdj/r9KYMJ3qMMkdP/9THQUtTcOYx51r8RV9pdzqF2HPnZZNziBa+wXJZHEWp70NyoakNthgYwtypqiDHs2f3Q==\",\n \"format\": \"binary\",\n \"type\": \"string\",\n \"x-okta-operationId\": \"publishBinaryDerCertForIdentityProvider\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"publish_csr_for_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Publish a certificate signing request\",\n \"tags\": [\n \"IdentityProviderSigningKeys\"\n ]\n },\n \"publish_csr_from_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Publishes a certificate signing request (CSR) for the app with a signed X.509 certificate and adds it into the application key credentials.\\n> **Note:** Publishing a certificate completes the lifecycle of the CSR and it's no longer accessible.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"publish_csr_from_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the CSR\",\n \"in\": \"path\",\n \"name\": \"csrId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"fd7x1h7uTcZFx22rU1f7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish\",\n \"request_body\": {\n \"description\": \"X.509 certificate in `CER` format.\\nThe client can either post in binary or Base64URL-encoded. If the post is Base64URL-encoded, set the `Content-Transfer-Encoding` header to `base64`.\",\n \"example\": \"@certificate.pem\",\n \"format\": \"binary\",\n \"type\": \"string\",\n \"x-okta-operationId\": \"publishBinaryCerCert\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"publish_csr_from_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Publish a certificate signing request\",\n \"tags\": [\n \"ApplicationSSOCredentialKey\"\n ]\n },\n \"replace_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces properties for an application\\n> **Notes:**\\n> * All required properties must be specified in the request body\\n> * You can't modify system-assigned properties, such as `id`, `name`, `status`, `created`, and `lastUpdated`. The values for these properties in the PUT request body are ignored.\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/Application\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an application\",\n \"tags\": [\n \"Application\"\n ]\n },\n \"replace_authenticator\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the properties for an authenticator identified by `authenticatorId`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_authenticator\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}\",\n \"request_body\": {\n \"properties\": {},\n \"type\": \"object\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_authenticator\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an authenticator\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"replace_authenticator_method\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a method of `methodType` for an authenticator identified by `authenticatorId`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_authenticator_method\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Type of authenticator method\",\n \"in\": \"path\",\n \"name\": \"methodType\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/components/schemas/AuthenticatorMethodType\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/methods/{methodType}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AuthenticatorMethodBase\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_authenticator_method\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an authenticator method\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"replace_authorization_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces an authorization server\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_authorization_server\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AuthorizationServer\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_authorization_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an authorization server\",\n \"tags\": [\n \"AuthorizationServer\"\n ]\n },\n \"replace_authorization_server_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a policy\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_authorization_server_policy\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AuthorizationServerPolicy\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_authorization_server_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a policy\",\n \"tags\": [\n \"AuthorizationServerPolicies\"\n ]\n },\n \"replace_authorization_server_policy_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_authorization_server_policy_rule\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy\",\n \"in\": \"path\",\n \"name\": \"policyId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00plrilJ7jZ66Gn0X0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the policy rule\",\n \"in\": \"path\",\n \"name\": \"ruleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"ruld3hJ7jZh4fn0st0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AuthorizationServerPolicyRuleRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_authorization_server_policy_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a policy rule\",\n \"tags\": [\n \"AuthorizationServerRules\"\n ]\n },\n \"replace_behavior_detection_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a Behavior Detection Rule by `behaviorId`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_behavior_detection_rule\",\n \"parameters\": [\n {\n \"description\": \"ID of the Behavior Detection Rule\",\n \"in\": \"path\",\n \"name\": \"behaviorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"abcd1234\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/behaviors/{behaviorId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BehaviorRule\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.behaviors.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_behavior_detection_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a behavior detection rule\",\n \"tags\": [\n \"Behavior\"\n ]\n },\n \"replace_brand\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a brand by `brandId`\\n\\nPassing an invalid `brandId` returns a `404 Not Found` status code with the error code `E0000007`.\\n\\nNot providing `agreeToCustomPrivacyPolicy` with `customPrivacyPolicyUrl` returns a `400 Bad Request` status code with the error code `E0000001`.\\n\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_brand\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BrandRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_brand\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a brand\",\n \"tags\": [\n \"Brands\"\n ]\n },\n \"replace_brand_theme\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a theme for a brand\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_brand_theme\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the theme\",\n \"in\": \"path\",\n \"name\": \"themeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/themes/{themeId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UpdateThemeRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_brand_theme\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a theme\",\n \"tags\": [\n \"Themes\"\n ]\n },\n \"replace_brand_well_known_uri\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the content of a customized well-known URI that you specify.\\n\\nThere are endpoint-specific format requirements when you update the content of a customized well-known URI. See [Customize associated domains](https://developer.okta.com/docs/guides/custom-well-known-uri/main/).\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_brand_well_known_uri\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The path of the well-known URI\",\n \"in\": \"path\",\n \"name\": \"path\",\n \"required\": true,\n \"schema\": {\n \"enum\": [\n \"apple-app-site-association\",\n \"assetlinks.json\",\n \"webauthn\"\n ],\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/well-known-uris/{path}/customized\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/WellKnownURIRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_brand_well_known_uri\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the customized well-known URI of the specific path\",\n \"tags\": [\n \"AssociatedDomainCustomizations\"\n ]\n },\n \"replace_captcha_instance\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the properties for a specified CAPTCHA instance\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_captcha_instance\",\n \"parameters\": [\n {\n \"description\": \"The unique key used to identify your CAPTCHA instance\",\n \"in\": \"path\",\n \"name\": \"captchaId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/captchas/{captchaId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CAPTCHAInstance\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.captchas.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_captcha_instance\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a CAPTCHA instance\",\n \"tags\": [\n \"CAPTCHA\"\n ]\n },\n \"replace_custom_aaguid\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a custom AAGUID for the specified Passkey (FIDO2 WebAuthn) authenticator\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_custom_aaguid\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique ID of a custom AAGUID\",\n \"in\": \"path\",\n \"name\": \"aaguid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cb69481e-8ff7-4039-93ec-0a272911111\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CustomAAGUIDUpdateRequestObject\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_custom_aaguid\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a custom AAGUID\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"replace_custom_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a custom domain's brand\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_custom_domain\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Domain\",\n \"in\": \"path\",\n \"name\": \"domainId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"OmWNeywfTzElSLOBMZsL\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/domains/{domainId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UpdateDomain\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.domains.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_custom_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a custom domain's brand\",\n \"tags\": [\n \"CustomDomain\"\n ]\n },\n \"replace_customized_error_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the customized error page. The customized error page appears in your live environment.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_customized_error_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/error/customized\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ErrorPage\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_customized_error_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the customized error page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"replace_customized_sign_in_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the customized sign-in page. The customized sign-in page appears in your live environment.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_customized_sign_in_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-in/customized\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/SignInPage\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_customized_sign_in_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the customized sign-in page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"replace_device_assurance_policy\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a device assurance policy by `deviceAssuranceId`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_device_assurance_policy\",\n \"parameters\": [\n {\n \"description\": \"Id of the device assurance policy\",\n \"in\": \"path\",\n \"name\": \"deviceAssuranceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/device-assurances/{deviceAssuranceId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/DeviceAssurance\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.deviceAssurance.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_device_assurance_policy\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a device assurance policy\",\n \"tags\": [\n \"DeviceAssurance\"\n ]\n },\n \"replace_device_posture_check\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a device posture check by `postureCheckId`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_device_posture_check\",\n \"parameters\": [\n {\n \"description\": \"ID of the device posture check\",\n \"in\": \"path\",\n \"name\": \"postureCheckId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/device-posture-checks/{postureCheckId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/DevicePostureCheck\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devicePostureChecks.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_device_posture_check\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a device posture check\",\n \"tags\": [\n \"DevicePostureCheck\"\n ]\n },\n \"replace_email_customization\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces an email customization using property values\\n\\n If Custom languages for Okta Email Templates is disabled, requests to update a customization for an additional language return a `404 Not Found` error response.\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_email_customization\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the email customization\",\n \"in\": \"path\",\n \"name\": \"customizationId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/EmailCustomization\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_email_customization\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an email customization\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"replace_email_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces associated username and sender display name by `emailDomainId`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_email_domain\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"emailDomainId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The ID of the email domain.\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional metadata to be included in the response\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"enum\": [\n \"brands\"\n ],\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/api/v1/email-domains/{emailDomainId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UpdateEmailDomain\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailDomains.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_email_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an email domain\",\n \"tags\": [\n \"EmailDomain\"\n ]\n },\n \"replace_email_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces an email template's settings\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_email_settings\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/settings\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/EmailSettings\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_email_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the email template settings\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"replace_event_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces an event hook. Okta validates the new properties before replacing the existing values.\\nSome event hook properties are immutable and can't be updated. Refer to the parameter description in the request body schema.\\n\\n>**Note:** Updating the `channel` property requires you to verify the hook again.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_event_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Event Hook\",\n \"in\": \"path\",\n \"name\": \"eventHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"who8vt36qfNpCGz9H1e6\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/eventHooks/{eventHookId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/EventHook\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.eventHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_event_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an event hook\",\n \"tags\": [\n \"EventHook\"\n ]\n },\n \"replace_existing_identity_source_user\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces an existing user for the given identity source instance and external ID\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_existing_identity_source_user\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The external ID of the user\",\n \"in\": \"path\",\n \"name\": \"externalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/users/{externalId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UserRequestSchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_existing_identity_source_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an existing identity source user\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"replace_federated_claim\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_federated_claim\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique `id` of the federated claim\",\n \"in\": \"path\",\n \"name\": \"claimId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/federated-claims/{claimId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/FederatedClaim\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_federated_claim\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a federated claim\",\n \"tags\": [\n \"ApplicationSSOFederatedClaims\"\n ]\n },\n \"replace_first_party_app_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the settings for an Okta app (also known as an Okta first-party app)\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_first_party_app_settings\",\n \"parameters\": [\n {\n \"description\": \"The key name for the Okta app.
\\nSupported apps:\\n * Okta Admin Console (`admin-console`)\\n\",\n \"in\": \"path\",\n \"name\": \"appName\",\n \"required\": true,\n \"schema\": {\n \"example\": \"admin-console\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/first-party-app-settings/{appName}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AdminConsoleSettings\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_first_party_app_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the Okta application settings\",\n \"tags\": [\n \"OktaApplicationSettings\"\n ]\n },\n \"replace_governance_bundle\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the properties of a governance bundle for the Admin Console\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_governance_bundle\",\n \"parameters\": [\n {\n \"description\": \"The `id` of a bundle\",\n \"in\": \"path\",\n \"name\": \"bundleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"enbllojq9J9J105DL1d6\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/governance/bundles/{bundleId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/GovernanceBundleUpdateRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_governance_bundle\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a governance bundle\",\n \"tags\": [\n \"GovernanceBundle\"\n ]\n },\n \"replace_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the profile for a group of `OKTA_GROUP` type from your org.\\n> **Note :** You only can modify profiles for groups of the `OKTA_GROUP` type.\\n>\\n> App imports are responsible for updating profiles for groups of the `APP_GROUP` type, such as Active Directory groups.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}\",\n \"request_body\": {\n \"properties\": {\n \"profile\": {\n \"$ref\": \"#/components/schemas/OktaUserGroupProfile\"\n }\n }\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a group\",\n \"tags\": [\n \"Group\"\n ]\n },\n \"replace_group_rule\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a group rule\\n> **Notes:** You can only update rules with a group whose status is set to `INACTIVE`.\\n>\\n> You currently can't update the `actions` section.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_group_rule\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group rule\",\n \"in\": \"path\",\n \"name\": \"groupRuleId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0pr3f7zMZZHPgUoWO0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/rules/{groupRuleId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/GroupRule\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_group_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a group rule\",\n \"tags\": [\n \"GroupRule\"\n ]\n },\n \"replace_hook_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a key by `id`\\n\\nThis request replaces existing properties after passing validation.\\n\\n> **Note:** The only parameter that you can update is the name of the key, which must be unique at all times.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_hook_key\",\n \"parameters\": [\n {\n \"description\": \"ID of the Hook Key\",\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"schema\": {\n \"example\": \"XreKU5laGwBkjOTehusG\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/hook-keys/{id}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/KeyRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_hook_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a key\",\n \"tags\": [\n \"HookKey\"\n ]\n },\n \"replace_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces an identity provider (IdP) integration by `idpId`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/IdentityProvider\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an IdP\",\n \"tags\": [\n \"IdentityProvider\"\n ]\n },\n \"replace_identity_provider_key\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces an identity provider (IdP) key credential by `kid`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_identity_provider_key\",\n \"parameters\": [\n {\n \"description\": \"Unique `id` of the IdP key credential\",\n \"in\": \"path\",\n \"name\": \"kid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"KmMo85SSsU7TZzOShcGb\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/credentials/keys/{kid}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/IdPKeyCredential\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_identity_provider_key\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an IdP key credential\",\n \"tags\": [\n \"IdentityProviderKeys\"\n ]\n },\n \"replace_inline_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces an inline hook by `inlineHookId`. The submitted inline hook properties replace the existing properties after passing validation.\\n\\n>**Note:** Some properties are immutable and can't be updated.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_inline_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the inline hook\",\n \"in\": \"path\",\n \"name\": \"inlineHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"Y7Rzrd4g4xj6WdKzrBHH\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/inlineHooks/{inlineHookId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/InlineHookReplace\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_inline_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace an inline hook\",\n \"tags\": [\n \"InlineHook\"\n ]\n },\n \"replace_log_stream\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the log stream object properties for a given ID.\\n\\nThis operation is typically used to update the configuration of a log stream.\\nDepending on the type of log stream you want to update, certain properties can't be modified after the log stream is initially created.\\nUse the [Retrieve the log stream schema for the schema type](/openapi/okta-management/management/schema/getlogstreamschema) request to determine which properties you can update for the specific log stream type.\\nLog stream properties with the `\\\"writeOnce\\\" : true` attribute can't be updated after creation.\\nYou must still specify these `writeOnce` properties in the request body with the original values in the PUT request.\\n\\n> **Note:** You don't have to specify properties that have both the `\\\"writeOnce\\\": true` and the `\\\"writeOnly\\\": true` attributes in the PUT request body. These property values are ignored even if you add them in the PUT request body.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_log_stream\",\n \"parameters\": [\n {\n \"description\": \"Unique identifier for the log stream\",\n \"in\": \"path\",\n \"name\": \"logStreamId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa1orzg0CHSgPcjZ0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/logStreams/{logStreamId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/LogStreamPutSchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.logStreams.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_log_stream\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a log stream\",\n \"tags\": [\n \"LogStream\"\n ]\n },\n \"replace_o_auth2_claim\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a custom token Claim specified by the `claimId`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_o_auth2_claim\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of Claim\",\n \"in\": \"path\",\n \"name\": \"claimId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"hNJ3Uk76xLagWkGx5W3N\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/claims/{claimId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OAuth2Claim\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_o_auth2_claim\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a custom token claim\",\n \"tags\": [\n \"AuthorizationServerClaims\"\n ]\n },\n \"replace_o_auth2_scope\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a custom token scope\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_o_auth2_scope\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of Scope\",\n \"in\": \"path\",\n \"name\": \"scopeId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0TMRpCWXRKFjP7HiPFNM\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/scopes/{scopeId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OAuth2Scope\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_o_auth2_scope\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a custom token scope\",\n \"tags\": [\n \"AuthorizationServerScopes\"\n ]\n },\n \"replace_org_contact_user\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the user associated with the specified contact type\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_org_contact_user\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"contactType\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Type of contact\",\n \"enum\": [\n \"BILLING\",\n \"TECHNICAL\"\n ],\n \"example\": \"BILLING\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/org/contacts/{contactType}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OrgContactUser\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_org_contact_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the contact type user\",\n \"tags\": [\n \"OrgSettingContact\"\n ]\n },\n \"replace_org_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the Org General Settings for your Okta org\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_org_settings\",\n \"parameters\": [],\n \"path\": \"/api/v1/org\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OrgSetting\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_org_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the Org general settings\",\n \"tags\": [\n \"OrgSettingGeneral\"\n ]\n },\n \"replace_preview_error_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_preview_error_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/error/preview\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ErrorPage\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_preview_error_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the preview error page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"replace_preview_sign_in_page\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_preview_sign_in_page\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-in/preview\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/SignInPage\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_preview_sign_in_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the preview sign-in page\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"replace_resource_set\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the label and description of a resource set. See [Supported resources](/openapi/okta-management/guides/roles/#supported-resources).\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_resource_set\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ResourceSet\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_resource_set\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a resource set\",\n \"tags\": [\n \"RoleCResourceSet\"\n ]\n },\n \"replace_resource_set_resource\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the conditions of a resource identified by `resourceId` in a resource set\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_resource_set_resource\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the resource\",\n \"in\": \"path\",\n \"name\": \"resourceId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"ire106sQKoHoXXsAe0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ResourceSetResourcePutRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_resource_set_resource\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the resource set resource conditions\",\n \"tags\": [\n \"RoleCResourceSetResource\"\n ]\n },\n \"replace_role\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the label and description for a custom role by `roleIdOrLabel`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_role\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/roles/{roleIdOrLabel}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UpdateIamRoleRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_role\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a custom role\",\n \"tags\": [\n \"RoleECustom\"\n ]\n },\n \"replace_role_permission\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a permission (specified by `permissionType`) for a custom role\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_role_permission\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"An Okta [permission](/openapi/okta-management/guides/permissions)\",\n \"in\": \"path\",\n \"name\": \"permissionType\",\n \"required\": true,\n \"schema\": {\n \"example\": \"okta.users.manage\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CreateUpdateIamRolePermissionRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_role_permission\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a custom role permission\",\n \"tags\": [\n \"RoleECustomPermission\"\n ]\n },\n \"replace_sign_out_page_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the sign-out page settings\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_sign_out_page_settings\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/pages/sign-out/customized\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/HostedPage\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_sign_out_page_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the sign-out page settings\",\n \"tags\": [\n \"CustomPages\"\n ]\n },\n \"replace_ui_schemas\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces a UI Schema by `id`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_ui_schemas\",\n \"parameters\": [\n {\n \"description\": \"The unique ID of the UI Schema\",\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"schema\": {\n \"example\": \"uis4a7liocgcRgcxZ0g7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/uischemas/{id}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UpdateUISchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.uischemas.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_ui_schemas\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a UI schema\",\n \"tags\": [\n \"UISchema\"\n ]\n },\n \"replace_user_type\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces an existing user type. This operation is a full update.\\n> **Note**: The `name` of an existing user type can't be changed, but must be part of the request body. You can only replace the `displayName` and `description` elements.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replace_user_type\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"typeId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The unique key for the user type\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/types/user/{typeId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UserTypePutRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.userTypes.manage\"\n ]\n }\n ],\n \"skill_name\": \"replace_user_type\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace a user type\",\n \"tags\": [\n \"UserType\"\n ]\n },\n \"replaces_org_captcha_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Replaces the CAPTCHA settings object for your organization\\n> **Note**: You can disable CAPTCHA for your organization by setting `captchaId` and `enabledPages` to `null`.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"replaces_org_captcha_settings\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/captcha\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OrgCAPTCHASettings\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.captchas.manage\"\n ]\n }\n ],\n \"skill_name\": \"replaces_org_captcha_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Replace the org-wide CAPTCHA settings\",\n \"tags\": [\n \"CAPTCHA\"\n ]\n },\n \"resume_agent_pools_update\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Resumes a running or queued agent pool update\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"resume_agent_pools_update\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the update\",\n \"in\": \"path\",\n \"name\": \"updateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/{updateId}/resume\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.manage\"\n ]\n }\n ],\n \"skill_name\": \"resume_agent_pools_update\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Resume an agent pool update\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"retry_agent_pools_update\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"retry_agent_pools_update\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the update\",\n \"in\": \"path\",\n \"name\": \"updateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/{updateId}/retry\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.manage\"\n ]\n }\n ],\n \"skill_name\": \"retry_agent_pools_update\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Retry an agent pool update\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"revoke_aerial_consent\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes access of an Okta Aerial account to your Org. The revoke operation will fail if the org has already been added to an Aerial account.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"revoke_aerial_consent\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/aerial/revoke\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OrgAerialConsent\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"revoke_aerial_consent\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke Okta Aerial access to your org\",\n \"tags\": [\n \"OrgSettingSupport\"\n ]\n },\n \"revoke_api_token\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes an API token by `apiTokenId`\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"revoke_api_token\",\n \"parameters\": [\n {\n \"description\": \"id of the API Token\",\n \"in\": \"path\",\n \"name\": \"apiTokenId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00Tabcdefg1234567890\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/api-tokens/{apiTokenId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apiTokens.manage\"\n ]\n }\n ],\n \"skill_name\": \"revoke_api_token\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke an API token\",\n \"tags\": [\n \"ApiToken\"\n ]\n },\n \"revoke_csr_for_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes a certificate signing request (CSR) and deletes the key pair from the identity provider (IdP)\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"revoke_csr_for_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the IdP CSR\",\n \"in\": \"path\",\n \"name\": \"idpCsrId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"1uEhyE65oV3H6KM9gYcN\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"revoke_csr_for_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke a certificate signing request\",\n \"tags\": [\n \"IdentityProviderSigningKeys\"\n ]\n },\n \"revoke_csr_from_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes a certificate signing request and deletes the key pair from the app\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"revoke_csr_from_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the CSR\",\n \"in\": \"path\",\n \"name\": \"csrId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"fd7x1h7uTcZFx22rU1f7\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/credentials/csrs/{csrId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"revoke_csr_from_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke a certificate signing request\",\n \"tags\": [\n \"ApplicationSSOCredentialKey\"\n ]\n },\n \"revoke_current_api_token\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes the API token provided in the Authorization header\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"revoke_current_api_token\",\n \"parameters\": [],\n \"path\": \"/api/v1/api-tokens/current\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n }\n ],\n \"skill_name\": \"revoke_current_api_token\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke the current API token\",\n \"tags\": [\n \"ApiToken\"\n ]\n },\n \"revoke_o_auth2_token_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes the specified token for the specified app\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"revoke_o_auth2_token_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of Token\",\n \"in\": \"path\",\n \"name\": \"tokenId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"sHHSth53yJAyNSTQKDJZ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/tokens/{tokenId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"revoke_o_auth2_token_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke an application token\",\n \"tags\": [\n \"ApplicationTokens\"\n ]\n },\n \"revoke_o_auth2_tokens_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes all OAuth 2.0 refresh tokens for the specified app. Any access tokens issued with these refresh tokens are also revoked, but access tokens issued without a refresh token aren't affected.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"revoke_o_auth2_tokens_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/tokens\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"revoke_o_auth2_tokens_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke all application tokens\",\n \"tags\": [\n \"ApplicationTokens\"\n ]\n },\n \"revoke_okta_support\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes Okta Support access to your org\\n\\n> **Note:** This resource is deprecated. Use the [Update an Okta Support case](/openapi/okta-management/management/tags/orgsettingsupport/other/updateoktasupportcase) resource to revoke Okta Support access for a support case.\\n> For the corresponding Okta Admin Console feature, see [Give access to Okta Support](https://help.okta.com/okta_help.htm?type=oie&id=settings-support-access).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"revoke_okta_support\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/privacy/oktaSupport/revoke\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"revoke_okta_support\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke Okta Support access\",\n \"tags\": [\n \"OrgSettingSupport\"\n ]\n },\n \"revoke_refresh_token_for_authorization_server_and_client\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes a refresh token for a Client\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"revoke_refresh_token_for_authorization_server_and_client\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`client_id` of the app\",\n \"in\": \"path\",\n \"name\": \"clientId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of Token\",\n \"in\": \"path\",\n \"name\": \"tokenId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"sHHSth53yJAyNSTQKDJZ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"revoke_refresh_token_for_authorization_server_and_client\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke a refresh token for a client\",\n \"tags\": [\n \"AuthorizationServerClients\"\n ]\n },\n \"revoke_refresh_tokens_for_authorization_server_and_client\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes all refresh tokens for a Client\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"revoke_refresh_tokens_for_authorization_server_and_client\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`client_id` of the app\",\n \"in\": \"path\",\n \"name\": \"clientId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"revoke_refresh_tokens_for_authorization_server_and_client\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke all refresh tokens for a client\",\n \"tags\": [\n \"AuthorizationServerClients\"\n ]\n },\n \"revoke_scope_consent_grant\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Revokes permission for the app to grant the given scope\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"revoke_scope_consent_grant\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Grant ID\",\n \"in\": \"path\",\n \"name\": \"grantId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iJoqkwx50mrgX4T9LcaH\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/grants/{grantId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.appGrants.manage\"\n ]\n }\n ],\n \"skill_name\": \"revoke_scope_consent_grant\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Revoke an app grant\",\n \"tags\": [\n \"ApplicationGrants\"\n ]\n },\n \"rotate_authorization_server_keys\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Rotates the current Keys for a Custom Authorization Server. If you rotate Keys,\\nthe `ACTIVE` Key becomes the `EXPIRED` Key, the `NEXT` Key becomes the `ACTIVE` Key,\\nand the Custom Authorization Server immediately begins using the new active\\nKey to sign tokens.\\n\\n> **Note:** Okta rotates your Keys automatically in `AUTO` mode. You can rotate Keys\\nyourself in either mode. If Keys are rotated manually, you should invalidate any intermediate cache.\\nand fetch the Keys again using the Keys endpoint.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"rotate_authorization_server_keys\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Authorization Server\",\n \"in\": \"path\",\n \"name\": \"authServerId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"GeGRTEr7f3yu2n7grw22\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/JwkUse\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authorizationServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"rotate_authorization_server_keys\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Rotate all credential keys\",\n \"tags\": [\n \"AuthorizationServerKeys\"\n ]\n },\n \"send_test_email\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Sends a test email to the current user's primary and secondary email addresses. The email content is selected based on the following priority:\\n1. The email customization for the language specified in the `language` query parameter\\n If Custom languages for Okta Email Templates is enabled and the `language` parameter is an additional language, the test email uses the customization corresponding to the language.\\n2. The email template's default customization\\n3. The email template's default content, translated to the current user's language\\n\\nYou can only send customized test emails if you've configured a custom email domain. If you don't have a custom email domain, test emails use the Okta default template and are sent from the Okta email domain.\\n\\n> **Note:** Super admins can view customized email templates with the **Send a test email** request. However, when custom email templates are sent to super admins as part of actual email notification flows, the customizations aren't applied. Instead, the default email template is used. This only applies to super admins.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"send_test_email\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name of the email template\",\n \"in\": \"path\",\n \"name\": \"templateName\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The language to use for the email. Defaults to the current user's language if unspecified.\",\n \"in\": \"query\",\n \"name\": \"language\",\n \"required\": false,\n \"schema\": {\n \"$ref\": \"#/components/schemas/Language\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/templates/email/{templateName}/test\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.templates.read\"\n ]\n }\n ],\n \"skill_name\": \"send_test_email\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Send a test email\",\n \"tags\": [\n \"CustomTemplates\"\n ]\n },\n \"set_org_hide_okta_ui_footer\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Sets the preference to hide the Okta End-User Dashboard footer for all end users of your org\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"set_org_hide_okta_ui_footer\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/preferences/hideEndUserFooter\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"set_org_hide_okta_ui_footer\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Set the hide dashboard footer preference\",\n \"tags\": [\n \"OrgSettingCustomization\"\n ]\n },\n \"set_org_show_okta_ui_footer\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Sets the preference to show the Okta UI footer for all end users of your org\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"set_org_show_okta_ui_footer\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/preferences/showEndUserFooter\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"set_org_show_okta_ui_footer\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Set the show dashboard footer preference\",\n \"tags\": [\n \"OrgSettingCustomization\"\n ]\n },\n \"start_import_from_identity_source\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Starts the import from the identity source described by the uploaded bulk operations\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"start_import_from_identity_source\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the identity source session\",\n \"in\": \"path\",\n \"name\": \"sessionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/start-import\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"start_import_from_identity_source\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Start the import from the identity source\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"start_org_failback\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Starts the failback of your org\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"start_org_failback\",\n \"parameters\": [],\n \"path\": \"/api/v1/dr/failback\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"$ref\": \"#/components/schemas/FailbackRequestSchema\"\n },\n {\n \"$ref\": \"#/components/schemas/EmptyRequestSchema\"\n }\n ],\n \"x-okta-ignore-redocly-rules-for-sdk\": true\n },\n \"security\": [\n {\n \"oauth2\": [\n \"okta.dr.manage\"\n ]\n }\n ],\n \"skill_name\": \"start_org_failback\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Start the failback of your org\",\n \"tags\": [\n \"DisasterRecovery\"\n ]\n },\n \"start_org_failover\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Starts the failover of your org\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"start_org_failover\",\n \"parameters\": [],\n \"path\": \"/api/v1/dr/failover\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"$ref\": \"#/components/schemas/FailoverRequestSchema\"\n },\n {\n \"$ref\": \"#/components/schemas/EmptyRequestSchema\"\n }\n ],\n \"x-okta-ignore-redocly-rules-for-sdk\": true\n },\n \"security\": [\n {\n \"oauth2\": [\n \"okta.dr.manage\"\n ]\n }\n ],\n \"skill_name\": \"start_org_failover\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Start the failover of your org\",\n \"tags\": [\n \"DisasterRecovery\"\n ]\n },\n \"stop_agent_pools_update\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Stops an agent pool update\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"stop_agent_pools_update\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the update\",\n \"in\": \"path\",\n \"name\": \"updateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/{updateId}/stop\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.manage\"\n ]\n }\n ],\n \"skill_name\": \"stop_agent_pools_update\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Stop an agent pool update\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"submit_group_attribute_query\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Submits a query search on the on-premises agent to asynchronously fetch specific Active Directory (AD) attributes for a group.\\nReturns a `resultId` that is used to poll for the results.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"submit_group_attribute_query\",\n \"parameters\": [\n {\n \"description\": \"ID of the AD instance in Okta\",\n \"in\": \"path\",\n \"name\": \"appInstanceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the Okta group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/directories/{appInstanceId}/groups/{groupId}/query\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/GroupQueryRequest\"\n },\n \"security\": [\n {\n \"oauth2\": [\n \"okta.directories.groups.read\"\n ]\n }\n ],\n \"skill_name\": \"submit_group_attribute_query\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Submit a query for AD Group\",\n \"tags\": [\n \"DirectoriesIntegration\"\n ]\n },\n \"suspend_device\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Suspends a device by setting its status to `SUSPENDED`.\\nUse suspended devices to create and delete device user links. You can only unsuspend or deactivate suspended devices.\\n> **Note:** `SUSPENDED` status is meant to be temporary, so it isn't destructive.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"suspend_device\",\n \"parameters\": [\n {\n \"description\": \"`id` of the device\",\n \"in\": \"path\",\n \"name\": \"deviceId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"guo4a5u7JHHhjXrMK0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/devices/{deviceId}/lifecycle/suspend\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devices.manage\"\n ]\n }\n ],\n \"skill_name\": \"suspend_device\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Suspend a Device\",\n \"tags\": [\n \"Device\"\n ]\n },\n \"test_email_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Tests the specified custom SMTP server configuration\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"test_email_server\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"emailServerId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"ID of your SMTP server configuration\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/email-servers/{emailServerId}/test\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/EmailTestAddresses\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"test_email_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Test an SMTP server configuration\",\n \"tags\": [\n \"EmailServer\"\n ]\n },\n \"unassign_app_instance_target_to_app_admin_role_for_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unassigns an app instance target from an `APP_ADMIN` role assignment to a group\\n\\n> **Note:** You can't remove the last app instance target from a role assignment.\\n> If you need a role assignment that applies to all apps, delete the `APP_ADMIN` role assignment with the target and create another one. See [Unassign a group role](/openapi/okta-management/management/roleassignmentbgroup/unassignrolefromgroup).\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"unassign_app_instance_target_to_app_admin_role_for_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the role assignment\",\n \"in\": \"path\",\n \"name\": \"roleAssignmentId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"JBCUYUC7IRCVGS27IFCE2SKO\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Name of the app definition (the OIN catalog app key name)\",\n \"in\": \"path\",\n \"name\": \"appName\",\n \"required\": true,\n \"schema\": {\n \"example\": \"google\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"unassign_app_instance_target_to_app_admin_role_for_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Unassign a group role app instance target\",\n \"tags\": [\n \"RoleBTargetBGroup\"\n ]\n },\n \"unassign_app_target_to_admin_role_for_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unassigns an OIN app target from an `APP_ADMIN` role assignment to a group\\n\\n> **Note:** You can't remove the last app target from a role assignment.\\n> If you need a role assignment that applies to all apps, delete the `APP_ADMIN` role assignment with the target and create another one. See [Unassign a group role](/openapi/okta-management/management/roleassignmentbgroup/unassignrolefromgroup).\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"unassign_app_target_to_admin_role_for_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the role assignment\",\n \"in\": \"path\",\n \"name\": \"roleAssignmentId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"JBCUYUC7IRCVGS27IFCE2SKO\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Name of the app definition (the OIN catalog app key name)\",\n \"in\": \"path\",\n \"name\": \"appName\",\n \"required\": true,\n \"schema\": {\n \"example\": \"google\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"unassign_app_target_to_admin_role_for_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Unassign a group role app target\",\n \"tags\": [\n \"RoleBTargetBGroup\"\n ]\n },\n \"unassign_application_from_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unassigns a Group from an app\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"unassign_application_from_group\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/groups/{groupId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"unassign_application_from_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Unassign an application group\",\n \"tags\": [\n \"ApplicationGroups\"\n ]\n },\n \"unassign_group_target_from_group_admin_role\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unassigns a group target from a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a group.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"unassign_group_target_from_group_admin_role\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the role assignment\",\n \"in\": \"path\",\n \"name\": \"roleAssignmentId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"JBCUYUC7IRCVGS27IFCE2SKO\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"targetGroupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1e9dfjHeLAsdX983d\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups/{targetGroupId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"unassign_group_target_from_group_admin_role\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Unassign a group role group target\",\n \"tags\": [\n \"RoleBTargetBGroup\"\n ]\n },\n \"unassign_member_from_binding\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unassigns a member (identified by `memberId`) from a role resource set binding\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"unassign_member_from_binding\",\n \"parameters\": [\n {\n \"description\": \"`id` or `label` of the resource set\",\n \"in\": \"path\",\n \"name\": \"resourceSetIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"iamoJDFKaJxGIr0oamd9g\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` or `label` of the role\",\n \"in\": \"path\",\n \"name\": \"roleIdOrLabel\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cr0Yq6IJxGIr0ouum0g3\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"`id` of the member\",\n \"in\": \"path\",\n \"name\": \"memberId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"irb1qe6PGuMc7Oh8N0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members/{memberId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"unassign_member_from_binding\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Unassign a role resource set binding member\",\n \"tags\": [\n \"RoleDResourceSetBindingMember\"\n ]\n },\n \"unassign_role_from_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unassigns a role assignment (identified by `roleAssignmentId`) from a group (identified by the `groupId`)\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"unassign_role_from_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the role assignment\",\n \"in\": \"path\",\n \"name\": \"roleAssignmentId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"JBCUYUC7IRCVGS27IFCE2SKO\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/roles/{roleAssignmentId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.roles.manage\"\n ]\n }\n ],\n \"skill_name\": \"unassign_role_from_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Unassign a group role\",\n \"tags\": [\n \"RoleAssignmentBGroup\"\n ]\n },\n \"unassign_user_from_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unassigns a user from an app\\n\\nFor directories like Active Directory and LDAP, they act as the owner of the user's credential with Okta delegating authentication (DelAuth) to that directory.\\nIf this request is successful for a user when DelAuth is enabled, then the user is in a state with no password. You can then reset the user's password.\\n\\n> **Important:** This is a destructive operation. You can't recover the user's app profile. If the app is enabled for provisioning and configured to deactivate users, the user is also deactivated in the target app.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"unassign_user_from_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of an existing Okta user\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00u13okQOVWZJGDOAUVR\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sends a deactivation email to the administrator if `true`\",\n \"in\": \"query\",\n \"name\": \"sendEmail\",\n \"required\": false,\n \"schema\": {\n \"default\": false,\n \"type\": \"boolean\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/users/{userId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"unassign_user_from_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Unassign an application user\",\n \"tags\": [\n \"ApplicationUsers\"\n ]\n },\n \"unassign_user_from_group\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unassigns a user from a group with the `OKTA_GROUP` type.\\n> **Note:** You only can modify memberships for groups of the `OKTA_GROUP` type.\\n>\\n> App imports are responsible for managing group memberships for groups of the `APP_GROUP` type, such as Active Directory groups.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"unassign_user_from_group\",\n \"parameters\": [\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of an existing Okta user\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00ub0oNGTSWTBKOLGLNR\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/groups/{groupId}/users/{userId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"unassign_user_from_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Unassign a user from a group\",\n \"tags\": [\n \"Group\"\n ]\n },\n \"unlink_user_from_identity_provider\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unlinks the Okta user and the identity provider (IdP) user. The next time the user federates into Okta through this IdP, they have to re-link their account according to the account link policy.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"unlink_user_from_identity_provider\",\n \"parameters\": [\n {\n \"description\": \"`id` of IdP\",\n \"in\": \"path\",\n \"name\": \"idpId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oa62bfdjnK55Z5x80h7\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of an existing Okta user\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00ub0oNGTSWTBKOLGLNR\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/idps/{idpId}/users/{userId}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.idps.manage\"\n ]\n }\n ],\n \"skill_name\": \"unlink_user_from_identity_provider\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Unlink a user from IdP\",\n \"tags\": [\n \"IdentityProviderUsers\"\n ]\n },\n \"unsuspend_device\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unsuspends a device by returning its `status` to `ACTIVE`.\\n>**Note:** Only devices with a `SUSPENDED` status can be unsuspended.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"unsuspend_device\",\n \"parameters\": [\n {\n \"description\": \"`id` of the device\",\n \"in\": \"path\",\n \"name\": \"deviceId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"guo4a5u7JHHhjXrMK0g4\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/devices/{deviceId}/lifecycle/unsuspend\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.devices.manage\"\n ]\n }\n ],\n \"skill_name\": \"unsuspend_device\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Unsuspend a Device\",\n \"tags\": [\n \"Device\"\n ]\n },\n \"update_agent_pools_update\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates an agent pool update instance and returns the latest agent pool update\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_agent_pools_update\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of the update\",\n \"in\": \"path\",\n \"name\": \"updateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/{updateId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AgentPoolUpdate\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_agent_pools_update\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update an agent pool update by ID\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"update_agent_pools_update_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates an agent pool update instance settings\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_agent_pools_update_settings\",\n \"parameters\": [\n {\n \"description\": \"ID of the agent pool for which the settings apply to\",\n \"in\": \"path\",\n \"name\": \"poolId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/agentPools/{poolId}/updates/settings\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AgentPoolUpdateSettingRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.agentPools.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_agent_pools_update_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update an agent pool update settings\",\n \"tags\": [\n \"AgentPools\"\n ]\n },\n \"update_application_user\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the profile or credentials of a user assigned to an app\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_application_user\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ID of an existing Okta user\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00u13okQOVWZJGDOAUVR\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/users/{userId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AppUserUpdateRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_application_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update an application user\",\n \"tags\": [\n \"ApplicationUsers\"\n ]\n },\n \"update_application_user_profile\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the app user schema. This updates, adds, or removes one or more custom profile properties or the nullability of a base property in the app user schema for an app. Changing a base property's nullability (for example, the value of its `required` field) is allowed only if it is nullable in the default predefined schema for the app.\\n\\n> **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update.\\n\\nThe [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to apps. All users assigned to a given app use the same app user schema. Therefore, unlike the user schema operations, the app user schema operations all specify `default` and don't accept a schema ID.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_application_user_profile\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/schemas/apps/{appId}/default\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UserSchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.schemas.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_application_user_profile\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update the app user profile schema for an app\",\n \"tags\": [\n \"Schema\"\n ]\n },\n \"update_bot_protection_configuration\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the bot protection configuration for your org\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_bot_protection_configuration\",\n \"parameters\": [],\n \"path\": \"/api/v1/bot-protection/configuration\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BotProtectionConfiguration\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.botProtection.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_bot_protection_configuration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update the bot protection configuration\",\n \"tags\": [\n \"BotProtection\"\n ]\n },\n \"update_captcha_instance\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Partially updates the properties of a specified CAPTCHA instance\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_captcha_instance\",\n \"parameters\": [\n {\n \"description\": \"The unique key used to identify your CAPTCHA instance\",\n \"in\": \"path\",\n \"name\": \"captchaId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/captchas/{captchaId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CAPTCHAInstance\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.captchas.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_captcha_instance\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update a CAPTCHA instance\",\n \"tags\": [\n \"CAPTCHA\"\n ]\n },\n \"update_cross_app_access_connection\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the Cross App Access connection with the specified ID\\n\",\n \"destructive\": true,\n \"method\": \"PATCH\",\n \"operation_id\": \"update_cross_app_access_connection\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Connection ID\",\n \"in\": \"path\",\n \"name\": \"connectionId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/cwo/connections/{connectionId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OrgCrossAppAccessConnectionPatchRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_cross_app_access_connection\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update a Cross App Access connection\",\n \"tags\": [\n \"ApplicationCrossAppAccessConnections\"\n ]\n },\n \"update_custom_aaguid\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the properties of a custom AAGUID by the `authenticatorId` and `aaguid` ID\",\n \"destructive\": true,\n \"method\": \"PATCH\",\n \"operation_id\": \"update_custom_aaguid\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Unique ID of a custom AAGUID\",\n \"in\": \"path\",\n \"name\": \"aaguid\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cb69481e-8ff7-4039-93ec-0a272911111\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/CustomAAGUIDUpdateRequestObject\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_custom_aaguid\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update a custom AAGUID\",\n \"tags\": [\n \"Authenticator\"\n ]\n },\n \"update_default_provisioning_connection_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the default provisioning connection for an app\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_default_provisioning_connection_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Activates the provisioning connection\",\n \"in\": \"query\",\n \"name\": \"activate\",\n \"required\": false,\n \"schema\": {\n \"type\": \"boolean\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/connections/default\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"$ref\": \"#/components/schemas/ProvisioningConnectionTokenRequest\"\n },\n {\n \"$ref\": \"#/components/schemas/ProvisioningConnectionOauthRequest\"\n }\n ]\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_default_provisioning_connection_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update the default provisioning connection\",\n \"tags\": [\n \"ApplicationConnections\"\n ]\n },\n \"update_email_server\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the specified custom SMTP server configuration\\n\\n> **Note:** When you update an SMTP server configuration that uses OAuth 2.0 authentication, the [`authType`](#components/schemas/BaseEmailServer/properties/authType) property is required in the request body.\",\n \"destructive\": true,\n \"method\": \"PATCH\",\n \"operation_id\": \"update_email_server\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"emailServerId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"ID of your SMTP server configuration\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/email-servers/{emailServerId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BaseEmailServer\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailServers.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_email_server\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update an SMTP server configuration\",\n \"tags\": [\n \"EmailServer\"\n ]\n },\n \"update_feature_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates a Feature object for an app\\n> **Note:** This endpoint supports partial updates.\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"update_feature_for_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Name of the Feature\",\n \"in\": \"path\",\n \"name\": \"featureName\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/components/schemas/ApplicationFeatureType\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/features/{featureName}\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"$ref\": \"#/components/schemas/CapabilitiesObject\"\n },\n {\n \"$ref\": \"#/components/schemas/CapabilitiesInboundProvisioningObject\"\n }\n ],\n \"x-okta-ignore-redocly-rules-for-sdk\": true\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_feature_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update a feature\",\n \"tags\": [\n \"ApplicationFeatures\"\n ]\n },\n \"update_feature_lifecycle\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates a feature's lifecycle status. Use this endpoint to enable or disable a feature for your org.\\n\\nUse the `mode=force` parameter to override dependency restrictions for a particular feature. Normally, you can't enable a feature if it has one or more dependencies that aren't enabled.\\n\\nWhen you use the `mode=force` parameter while enabling a feature, Okta first tries to enable any disabled features that this feature may have as dependencies. If you don't pass the `mode=force` parameter and the feature has dependencies that need to be enabled before the feature is enabled, a 400 error is returned.\\n\\nWhen you use the `mode=force` parameter while disabling a feature, Okta first tries to disable any enabled features that this feature may have as dependents. If you don't pass the `mode=force` parameter and the feature has dependents that need to be disabled before the feature is disabled, a 400 error is returned.\\n\\nThe following chart shows the different state transitions for a feature.\\n\\n\\\"Example\\\"\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_feature_lifecycle\",\n \"parameters\": [\n {\n \"description\": \"`id` of the feature\",\n \"in\": \"path\",\n \"name\": \"featureId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"R5HjqNn1pEqWGy48E9jg\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Whether to `ENABLE` or `DISABLE` the feature\",\n \"in\": \"path\",\n \"name\": \"lifecycle\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/components/schemas/FeatureLifecycle\"\n }\n },\n {\n \"description\": \"Indicates if you want to force enable or disable a feature. Supported value is `force`.\",\n \"in\": \"query\",\n \"name\": \"mode\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/features/{featureId}/{lifecycle}\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.features.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_feature_lifecycle\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update a feature lifecycle\",\n \"tags\": [\n \"Feature\"\n ]\n },\n \"update_group_assignment_to_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates a group assignment to an app\",\n \"destructive\": true,\n \"method\": \"PATCH\",\n \"operation_id\": \"update_group_assignment_to_application\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `id` of the group\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00g1emaKYZTWRYYRRTSK\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/groups/{groupId}\",\n \"request_body\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/JsonPatchOperation\"\n },\n \"type\": \"array\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_group_assignment_to_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update an application group\",\n \"tags\": [\n \"ApplicationGroups\"\n ]\n },\n \"update_group_membership\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates an Active Directory or LDAP group membership directly in the Active Directory or LDAP server.\\n\\nYou can add or remove users from groups based on their identity and access requirements. This ensures that changes made to user access in Okta are reflected in AD or LDAP. When you use Okta Access Certifications to revoke a user's membership to an AD or LDAP group, the removal is reflected in AD or LDAP.\\n\\nSee [AD Bidirectional Group Management](https://help.okta.com/okta_help.htm?type=oie&id=ad-bidirectional-group-mgmt) and [LDAP Bidirectional Group Management](https://help.okta.com/okta_help.htm?type=oie&id=ldap-bidirectional-group-mgmt).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_group_membership\",\n \"parameters\": [\n {\n \"description\": \"ID of the Active Directory or LDAP app instance in Okta\",\n \"in\": \"path\",\n \"name\": \"appInstanceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/directories/{appInstanceId}/groups/modify\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/AgentAction\"\n },\n \"security\": [\n {\n \"oauth2\": [\n \"okta.directories.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_group_membership\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update an external directory group membership\",\n \"tags\": [\n \"DirectoriesIntegration\"\n ]\n },\n \"update_group_push_mapping\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the status of a group push mapping\",\n \"destructive\": true,\n \"method\": \"PATCH\",\n \"operation_id\": \"update_group_push_mapping\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Group push mapping ID\",\n \"in\": \"path\",\n \"name\": \"mappingId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"gPm00000000000000000\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/group-push/mappings/{mappingId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UpdateGroupPushMappingRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\",\n \"okta.groups.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_group_push_mapping\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update a group push mapping\",\n \"tags\": [\n \"GroupPushMapping\"\n ]\n },\n \"update_group_schema\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the group profile schema. This updates, adds, or removes one or more custom profile properties in a group schema. Currently Okta does not support changing base group profile properties.\\n\\n> **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update.\\n\\nThe [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify `default` and don't accept a schema ID.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_group_schema\",\n \"parameters\": [],\n \"path\": \"/api/v1/meta/schemas/group/default\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/GroupSchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.schemas.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_group_schema\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update the group profile schema\",\n \"tags\": [\n \"Schema\"\n ]\n },\n \"update_identity_source_groups\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates a group to an identity source for the given identity source instance and group ID\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_identity_source_groups\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The Okta group ID or external ID of the identity source group\",\n \"in\": \"path\",\n \"name\": \"groupOrExternalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/GroupsRequestSchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_identity_source_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update an identity source group\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"update_identity_source_users\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates a user to an identity source for the given identity source instance and external ID\",\n \"destructive\": true,\n \"method\": \"PATCH\",\n \"operation_id\": \"update_identity_source_users\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The external ID of the user\",\n \"in\": \"path\",\n \"name\": \"externalId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/users/{externalId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UsersUpdateRequestSchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_identity_source_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update an identity source user\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"update_inline_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates an inline hook by `inlineHookId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_inline_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the inline hook\",\n \"in\": \"path\",\n \"name\": \"inlineHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"Y7Rzrd4g4xj6WdKzrBHH\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/inlineHooks/{inlineHookId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/InlineHookReplace\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.inlineHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_inline_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update an inline hook\",\n \"tags\": [\n \"InlineHook\"\n ]\n },\n \"update_okta_support_case\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates access to the org for an Okta Support case:\\n\\n* You can enable, disable, or extend access to your org for an Okta Support case.\\n\\n* You can approve Okta Support access to your org for self-assigned cases. A self-assigned case is created and assigned by the same Okta Support user.\",\n \"destructive\": true,\n \"method\": \"PATCH\",\n \"operation_id\": \"update_okta_support_case\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"caseNumber\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Okta Support case number\",\n \"example\": \"00000144\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/org/privacy/oktaSupport/cases/{caseNumber}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OktaSupportCase\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_okta_support_case\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update an Okta Support case\",\n \"tags\": [\n \"OrgSettingSupport\"\n ]\n },\n \"update_org_settings\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates partial Org General Settings\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_org_settings\",\n \"parameters\": [],\n \"path\": \"/api/v1/org\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/OrgSetting\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_org_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update the Org general settings\",\n \"tags\": [\n \"OrgSettingGeneral\"\n ]\n },\n \"update_profile_mapping\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates an existing profile mapping by adding, updating, or removing one or many property mappings\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_profile_mapping\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Mapping\",\n \"in\": \"path\",\n \"name\": \"mappingId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"cB6u7X8mptebWkffatKA\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/mappings/{mappingId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ProfileMappingRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.profileMappings.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_profile_mapping\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update a profile mapping\",\n \"tags\": [\n \"ProfileMapping\"\n ]\n },\n \"update_third_party_admin_setting\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the third-party admin setting.\\nThis setting allows third-party admins to perform administrative actions in the Admin Console, but they can't do any of the following:\\n * Receive Okta admin email notifications\\n * Contact Okta support\\n * Sign in to the Okta Help Center\\n\\nSee [Configure third-party administrators](https://help.okta.com/okta_help.htm?type=oie&id=csh_admin-third) in the Okta product documentation.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_third_party_admin_setting\",\n \"parameters\": [],\n \"path\": \"/api/v1/org/orgSettings/thirdPartyAdminSetting\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ThirdPartyAdminSetting\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.orgs.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_third_party_admin_setting\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update the org third-party admin setting\",\n \"tags\": [\n \"OrgSettingAdmin\"\n ]\n },\n \"update_user_profile\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates a user schema. Use this request to update, add, or remove one or more profile properties in a user schema. If you specify `default` for the `schemaId`, updates will apply to the default user type.\\n\\nUnlike custom user profile properties, limited changes are allowed to base user profile properties (permissions, nullability of the `firstName` and `lastName` properties, or pattern for `login`).\\nYou can't remove a property from the default schema if it's being referenced as a [`matchAttribute`](/openapi/okta-management/management/tags/identityprovider/other/createidentityprovider#other/createidentityprovider/t=request&path=policy/subject/matchattribute) in `SAML2` IdPs.\\nCurrently, all validation of SAML assertions are only performed against the default user type.\\n\\n> **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_user_profile\",\n \"parameters\": [\n {\n \"description\": \"Schema ID. You can also use `default` to refer to the default user type schema.\",\n \"in\": \"path\",\n \"name\": \"schemaId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/schemas/user/{schemaId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UserSchema\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.schemas.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_user_profile\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update a user schema\",\n \"tags\": [\n \"Schema\"\n ]\n },\n \"update_user_type\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates an existing user type. This operation is a partial update.\\n> **Note**: You can only update the `displayName` and `description` elements. The `name` of an existing user type can't be changed.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"update_user_type\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"typeId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The unique key for the user type\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/meta/types/user/{typeId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/UserTypePostRequest\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.userTypes.manage\"\n ]\n }\n ],\n \"skill_name\": \"update_user_type\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Update a user type\",\n \"tags\": [\n \"UserType\"\n ]\n },\n \"upload_application_logo\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads a logo for the app instance.\\nIf the app already has a logo, this operation replaces the previous logo.\\n\\nThe logo is visible in the Admin Console as an icon for your app instance.\\nIf you have one `appLink` object configured, this logo also appears in the End-User Dashboard as an icon for your app.\\n> **Note:** If you have multiple `appLink` objects, use the Admin Console to add logos for each app link.\\n> You can't use the API to add logos for multiple app links.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_application_logo\",\n \"parameters\": [\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appId}/logo\",\n \"request_body\": {\n \"properties\": {\n \"file\": {\n \"description\": \"The image file containing the logo.\\n\\nThe file must be in PNG, JPG, SVG, or GIF format, and less than one MB in size.\\nFor best results, use an image with a transparent background and a square dimension of 200 x 200 pixels to prevent upscaling.\\n\\n> **Notes:**\\n> * Only SVG files encoded in UTF-8 are supported. For example, `` is a valid SVG file declaration.\\n> * `multipart/form-data` isn't supported for Python. Remove the `\\\"Content-Type\\\": \\\"multipart/form-data\\\"` line if you use the Python request sample code.\\n\",\n \"format\": \"binary\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"file\"\n ],\n \"type\": \"object\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_application_logo\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload an application logo\",\n \"tags\": [\n \"ApplicationLogos\"\n ]\n },\n \"upload_brand_theme_background_image\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads and replaces the background image for the theme. The file must be in PNG, JPG, or GIF format and less than 2 MB in size.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_brand_theme_background_image\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the theme\",\n \"in\": \"path\",\n \"name\": \"themeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/themes/{themeId}/background-image\",\n \"request_body\": {\n \"description\": \"The file must be in PNG, JPG, or GIF format and less than 2 MB in size.\",\n \"properties\": {\n \"file\": {\n \"format\": \"binary\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"file\"\n ],\n \"type\": \"object\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_brand_theme_background_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload the background image\",\n \"tags\": [\n \"Themes\"\n ]\n },\n \"upload_brand_theme_favicon\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads and replaces the favicon for the theme\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_brand_theme_favicon\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the theme\",\n \"in\": \"path\",\n \"name\": \"themeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/themes/{themeId}/favicon\",\n \"request_body\": {\n \"description\": \"The file must be in PNG or ICO format and have a 1:1 ratio with a maximum dimension of 512 x 512\",\n \"properties\": {\n \"file\": {\n \"format\": \"binary\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"file\"\n ],\n \"type\": \"object\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_brand_theme_favicon\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload the favicon\",\n \"tags\": [\n \"Themes\"\n ]\n },\n \"upload_brand_theme_logo\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads and replaces the logo for the theme. The file must be in PNG, JPG, or GIF format and less than 100kB in size. For best results use landscape orientation, a transparent background, and a minimum size of 300px by 50px to prevent upscaling.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_brand_theme_logo\",\n \"parameters\": [\n {\n \"description\": \"The ID of the brand\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the theme\",\n \"in\": \"path\",\n \"name\": \"themeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/brands/{brandId}/themes/{themeId}/logo\",\n \"request_body\": {\n \"description\": \"The file must be in PNG, JPG, or GIF format and less than 100kB in size. For best results use landscape orientation, a transparent background, and a minimum size of 300px by 50px to prevent upscaling.\",\n \"properties\": {\n \"file\": {\n \"format\": \"binary\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"file\"\n ],\n \"type\": \"object\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.brands.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_brand_theme_logo\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload the logo\",\n \"tags\": [\n \"Themes\"\n ]\n },\n \"upload_identity_source_data_for_delete\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads external IDs of entities that need to be deleted in Okta from the identity source for the given session\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_identity_source_data_for_delete\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the identity source session\",\n \"in\": \"path\",\n \"name\": \"sessionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-delete\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BulkDeleteRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_identity_source_data_for_delete\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload the data to be deleted in Okta\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"upload_identity_source_data_for_upsert\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads entities that need to be inserted or updated in Okta from the identity source for the given session\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_identity_source_data_for_upsert\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the identity source session\",\n \"in\": \"path\",\n \"name\": \"sessionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-upsert\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BulkUpsertRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_identity_source_data_for_upsert\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload the data to be upserted in Okta\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"upload_identity_source_group_memberships_for_delete\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads the group memberships that need to be deleted in Okta from the identity source for the given session\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_identity_source_group_memberships_for_delete\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the identity source session\",\n \"in\": \"path\",\n \"name\": \"sessionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-group-memberships-delete\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BulkGroupMembershipsDeleteRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_identity_source_group_memberships_for_delete\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload the group memberships to be deleted in Okta\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"upload_identity_source_group_memberships_for_upsert\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads the group memberships that need to be inserted or updated in Okta from the identity source for the given session\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_identity_source_group_memberships_for_upsert\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the identity source session\",\n \"in\": \"path\",\n \"name\": \"sessionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-group-memberships-upsert\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BulkGroupMembershipsUpsertRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_identity_source_group_memberships_for_upsert\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload the group memberships to be upserted in Okta\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"upload_identity_source_groups_data_for_delete\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads external IDs of groups that need to be deleted in Okta from the identity source for the given session\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_identity_source_groups_data_for_delete\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the identity source session\",\n \"in\": \"path\",\n \"name\": \"sessionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-groups-delete\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BulkGroupDeleteRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_identity_source_groups_data_for_delete\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload the group external IDs to be deleted in Okta\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"upload_identity_source_groups_for_upsert\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads the group profiles without memberships that need to be inserted or updated in Okta from the identity source for the given session\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_identity_source_groups_for_upsert\",\n \"parameters\": [\n {\n \"description\": \"The ID of the identity source for which the session is created\",\n \"in\": \"path\",\n \"name\": \"identitySourceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the identity source session\",\n \"in\": \"path\",\n \"name\": \"sessionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-groups-upsert\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/BulkGroupUpsertRequestBody\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.identitySources.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_identity_source_groups_for_upsert\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload the group profiles without memberships to be upserted in Okta\",\n \"tags\": [\n \"IdentitySource\"\n ]\n },\n \"upload_yubikey_otp_token_seed\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Uploads a seed for a user to enroll a YubiKey OTP\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"upload_yubikey_otp_token_seed\",\n \"parameters\": [\n {\n \"description\": \"Specifies the pagination cursor for the next page of tokens\",\n \"in\": \"query\",\n \"name\": \"after\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Embeds the [user](/openapi/okta-management/management/tags/user) resource if the YubiKey token is assigned to a user and `expand` is set to `user`\",\n \"in\": \"query\",\n \"name\": \"expand\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The expression used to filter tokens\",\n \"in\": \"query\",\n \"name\": \"filter\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"profile.email\",\n \"profile.serial\",\n \"activated\",\n \"user.id\",\n \"created\",\n \"status\",\n \"lastVerified\"\n ],\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Returns tokens in a CSV to download instead of in the response. When you use this query parameter, the `limit` default changes to 1000.\",\n \"in\": \"query\",\n \"name\": \"forDownload\",\n \"required\": false,\n \"schema\": {\n \"default\": false,\n \"type\": \"boolean\"\n }\n },\n {\n \"description\": \"Specifies the number of results per page\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"required\": false,\n \"schema\": {\n \"default\": 20,\n \"maximum\": 200,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"The value of how the tokens are sorted\",\n \"in\": \"query\",\n \"name\": \"sortBy\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"profile.email\",\n \"profile.serial\",\n \"activated\",\n \"user.id\",\n \"created\",\n \"status\",\n \"lastVerified\"\n ],\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the sort order, either `ASC` or `DESC`\",\n \"in\": \"query\",\n \"name\": \"sortOrder\",\n \"required\": false,\n \"schema\": {\n \"enum\": [\n \"ASC\",\n \"DESC\"\n ],\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/org/factors/yubikey_token/tokens\",\n \"request_body\": {\n \"properties\": {\n \"aesKey\": {\n \"description\": \"The cryptographic key used in the AES (Advanced Encryption Standard) algorithm to encrypt and decrypt the YubiKey OTP\",\n \"type\": \"string\"\n },\n \"privateId\": {\n \"description\": \"The YubiKey's private ID\",\n \"type\": \"string\"\n },\n \"publicId\": {\n \"description\": \"The YubiKey's public ID\",\n \"type\": \"string\"\n },\n \"serialNumber\": {\n \"description\": \"The unique identifier assigned to each YubiKey device\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.users.manage\"\n ]\n }\n ],\n \"skill_name\": \"upload_yubikey_otp_token_seed\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upload a YubiKey OTP seed\",\n \"tags\": [\n \"UserFactor\"\n ]\n },\n \"upsert_api_token\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Upserts an API Token Network Condition by `apiTokenId`\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"upsert_api_token\",\n \"parameters\": [\n {\n \"description\": \"id of the API Token\",\n \"in\": \"path\",\n \"name\": \"apiTokenId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"00Tabcdefg1234567890\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/api-tokens/{apiTokenId}\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/ApiTokenUpdate\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apiTokens.manage\"\n ]\n }\n ],\n \"skill_name\": \"upsert_api_token\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upsert an API token network condition\",\n \"tags\": [\n \"ApiToken\"\n ]\n },\n \"upsert_certificate\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Upserts (creates or renews) the `MANUAL` certificate for the custom domain\\n\\n> **Notes:**\\n> * If the existing `certificateSourceType` is `OKTA_MANAGED`, this operation changes the source type to `MANUAL`. Okta no longer manages and renews certificates for this domain after you provide a user-managed certificate.\\n> * Okta supports TLS certificates and private keys that are PEM-encoded and 2048, 3072, or 4096 bits. See the [Custom domain guide](https://developer.okta.com/docs/guides/custom-url-domain/main/) for more details.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"upsert_certificate\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Domain\",\n \"in\": \"path\",\n \"name\": \"domainId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"OmWNeywfTzElSLOBMZsL\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/domains/{domainId}/certificate\",\n \"request_body\": {\n \"$ref\": \"#/components/schemas/DomainCertificate\"\n },\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.domains.manage\"\n ]\n }\n ],\n \"skill_name\": \"upsert_certificate\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Upsert the custom domain's certificate\",\n \"tags\": [\n \"CustomDomain\"\n ]\n },\n \"verify_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Verifies the custom domain and validity of DNS records by `domainId`. Verify your custom domain to confirm that you own or control the domain and that you have properly configured the required DNS records. Furthermore, if the `certificateSourceType` in the domain is `OKTA_MANAGED`, then an attempt is made to obtain and install a certificate. After a certificate is obtained and installed by Okta, Okta manages the certificate including certificate renewal.\\n\\nVerify your custom domain after you've [created it](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/CustomDomain/#tag/CustomDomain/operation/createCustomDomain) and after you've added your DNS records to your domain provider. Okta doesn't verify your domain automatically. You must use the API to verify your custom domain if you change your DNS records or if you encounter issues with domain validation.\\n\\n> **Note:** DNS record changes can take time to propagate. If you recently updated your DNS records, you may need to wait before verifying your custom domain. If you encounter issues with domain verification, double-check your DNS records and ensure that they're correctly configured. See [Update your DNS records](https://developer.okta.com/docs/guides/custom-url-domain/main/#update-your-dns-txt).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"verify_domain\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Domain\",\n \"in\": \"path\",\n \"name\": \"domainId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"OmWNeywfTzElSLOBMZsL\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/domains/{domainId}/verify\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.domains.manage\"\n ]\n }\n ],\n \"skill_name\": \"verify_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Verify a custom domain\",\n \"tags\": [\n \"CustomDomain\"\n ]\n },\n \"verify_email_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Verifies an Email Domain by `emailDomainId`\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"verify_email_domain\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"emailDomainId\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The ID of the email domain.\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/email-domains/{emailDomainId}/verify\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.emailDomains.manage\"\n ]\n }\n ],\n \"skill_name\": \"verify_email_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Verify an email domain\",\n \"tags\": [\n \"EmailDomain\"\n ]\n },\n \"verify_event_hook\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Verifies that the event hook matches the provided `eventHookId`. To verify ownership, your endpoint must send information back to Okta in JSON format. See [Event hooks](https://developer.okta.com/docs/concepts/event-hooks/#one-time-verification-request).\\n\\nOnly `ACTIVE` and `VERIFIED` event hooks can receive events from Okta.\\n\\nIf a response is not received within 3 seconds, the outbound request times out. One retry is attempted after a timeout or error response.\\nIf a successful response still isn't received, this operation returns a 400 error with more information about the failure.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"verify_event_hook\",\n \"parameters\": [\n {\n \"description\": \"`id` of the Event Hook\",\n \"in\": \"path\",\n \"name\": \"eventHookId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"who8vt36qfNpCGz9H1e6\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/eventHooks/{eventHookId}/lifecycle/verify\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.eventHooks.manage\"\n ]\n }\n ],\n \"skill_name\": \"verify_event_hook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Verify an event hook\",\n \"tags\": [\n \"EventHook\"\n ]\n },\n \"verify_provisioning_connection_for_application\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Verifies the OAuth 2.0-based connection as part of the OAuth 2.0 consent flow. The validation of the consent flow is the last step of the provisioning setup for an OAuth 2.0-based connection.\\nCurrently, this operation only supports `office365`,`google`, `zoomus`, and `slack` apps.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"verify_provisioning_connection_for_application\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"appName\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/components/schemas/OAuthProvisioningEnabledApp\"\n }\n },\n {\n \"description\": \"Application ID\",\n \"in\": \"path\",\n \"name\": \"appId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"0oafxqCAJWWGELFTYASJ\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"code\",\n \"required\": false,\n \"schema\": {\n \"description\": \"Unique string associated with each authentication request\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"state\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A temporary code string that the client exchanges for an access token\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/api/v1/apps/{appName}/{appId}/oauth2/callback\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.apps.manage\"\n ]\n }\n ],\n \"skill_name\": \"verify_provisioning_connection_for_application\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Verify the provisioning connection\",\n \"tags\": [\n \"ApplicationConnections\"\n ]\n },\n \"verify_rp_id_domain\": {\n \"base_url\": \"https://{yourOktaDomain}\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Verifies the [Relying Party identifier (RP ID)](https://www.w3.org/TR/webauthn/#relying-party-identifier) domain for the specified Passkey (FIDO2 WebAuthn) authenticator and the specific `webauthn` authenticator method\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"verify_rp_id_domain\",\n \"parameters\": [\n {\n \"description\": \"`id` of the authenticator\",\n \"in\": \"path\",\n \"name\": \"authenticatorId\",\n \"required\": true,\n \"schema\": {\n \"example\": \"aut1nd8PQhGcQtSxB0g4\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Type of authenticator method\",\n \"in\": \"path\",\n \"name\": \"webAuthnMethodType\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/components/schemas/AuthenticatorMethodTypeWebAuthn\"\n }\n }\n ],\n \"path\": \"/api/v1/authenticators/{authenticatorId}/methods/{webAuthnMethodType}/verify-rp-id-domain\",\n \"request_body\": null,\n \"security\": [\n {\n \"apiToken\": []\n },\n {\n \"oauth2\": [\n \"okta.authenticators.manage\"\n ]\n }\n ],\n \"skill_name\": \"verify_rp_id_domain\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml\",\n \"source_title\": \"Okta Admin Management API\",\n \"summary\": \"Verify a Relying Party ID domain\",\n \"tags\": [\n \"Authenticator\"\n ]\n }\n}") +OPERATION_GROUPS = json.loads("[\n {\n \"common_prefix\": \"/.well-known\",\n \"description\": \"Handle 6 OpenAPI operation(s) under /.well-known for the well known route group.\",\n \"id\": \"well_known\",\n \"label\": \"well known\",\n \"operation_ids\": [\n \"get_well_known_app_authenticator_configuration\",\n \"get_apple_app_site_association_well_known_uri\",\n \"get_asset_links_well_known_uri\",\n \"get_wellknown_org_metadata\",\n \"get_wellknown_ssf_metadata\",\n \"get_web_authn_well_known_uri\"\n ],\n \"skill_dir\": \"well-known\",\n \"skill_name\": \"well-known-routes\",\n \"skill_path\": \"skills/well-known/SKILL.md\",\n \"subagent_name\": \"well-known-api\"\n },\n {\n \"common_prefix\": \"/api/v1/agentPools\",\n \"description\": \"Handle 14 OpenAPI operation(s) under /api/v1/agentPools for the agentPools route group.\",\n \"id\": \"agent_pools\",\n \"label\": \"agentPools\",\n \"operation_ids\": [\n \"list_agent_pools\",\n \"list_agent_pools_updates\",\n \"create_agent_pools_update\",\n \"get_agent_pools_update_settings\",\n \"update_agent_pools_update_settings\",\n \"get_agent_pools_update_instance\",\n \"update_agent_pools_update\",\n \"delete_agent_pools_update\",\n \"activate_agent_pools_update\",\n \"deactivate_agent_pools_update\",\n \"pause_agent_pools_update\",\n \"resume_agent_pools_update\",\n \"retry_agent_pools_update\",\n \"stop_agent_pools_update\"\n ],\n \"skill_dir\": \"agent-pools\",\n \"skill_name\": \"agent-pools-routes\",\n \"skill_path\": \"skills/agent-pools/SKILL.md\",\n \"subagent_name\": \"agent-pools-api\"\n },\n {\n \"common_prefix\": \"/api/v1/api-tokens\",\n \"description\": \"Handle 5 OpenAPI operation(s) under /api/v1/api-tokens for the api tokens route group.\",\n \"id\": \"api_tokens\",\n \"label\": \"api tokens\",\n \"operation_ids\": [\n \"list_api_tokens\",\n \"revoke_current_api_token\",\n \"get_api_token\",\n \"upsert_api_token\",\n \"revoke_api_token\"\n ],\n \"skill_dir\": \"api-tokens\",\n \"skill_name\": \"api-tokens-routes\",\n \"skill_path\": \"skills/api-tokens/SKILL.md\",\n \"subagent_name\": \"api-tokens-api\"\n },\n {\n \"common_prefix\": \"/api/v1/apps\",\n \"description\": \"Handle 77 OpenAPI operation(s) under /api/v1/apps for the apps route group.\",\n \"id\": \"apps\",\n \"label\": \"apps\",\n \"operation_ids\": [\n \"list_applications\",\n \"create_application\",\n \"get_application\",\n \"replace_application\",\n \"delete_application\",\n \"get_default_provisioning_connection_for_application\",\n \"update_default_provisioning_connection_for_application\",\n \"get_user_provisioning_connection_jwks\",\n \"activate_default_provisioning_connection_for_application\",\n \"deactivate_default_provisioning_connection_for_application\",\n \"list_csrs_for_application\",\n \"generate_csr_for_application\",\n \"get_csr_for_application\",\n \"revoke_csr_from_application\",\n \"publish_csr_from_application\",\n \"list_jwk\",\n \"add_jwk\",\n \"get_jwk\",\n \"deletejwk\",\n \"activate_o_auth2_client_json_web_key\",\n \"deactivate_o_auth2_client_json_web_key\",\n \"list_application_keys\",\n \"generate_application_key\",\n \"get_application_key\",\n \"clone_application_key\",\n \"list_o_auth2_client_secrets\",\n \"create_o_auth2_client_secret\",\n \"get_o_auth2_client_secret\",\n \"delete_o_auth2_client_secret\",\n \"activate_o_auth2_client_secret\",\n \"deactivate_o_auth2_client_secret\",\n \"get_all_cross_app_access_connections\",\n \"create_cross_app_access_connection\",\n \"get_cross_app_access_connection\",\n \"update_cross_app_access_connection\",\n \"delete_cross_app_access_connection\",\n \"list_features_for_application\",\n \"get_feature_for_application\",\n \"update_feature_for_application\",\n \"list_federated_claims\",\n \"create_federated_claim\",\n \"get_federated_claim\",\n \"replace_federated_claim\",\n \"delete_federated_claim\",\n \"list_scope_consent_grants\",\n \"grant_consent_to_scope\",\n \"get_scope_consent_grant\",\n \"revoke_scope_consent_grant\",\n \"list_group_push_mappings\",\n \"create_group_push_mapping\",\n \"get_group_push_mapping\",\n \"update_group_push_mapping\",\n \"delete_group_push_mapping\",\n \"list_application_group_assignments\",\n \"get_application_group_assignment\",\n \"assign_group_to_application\",\n \"update_group_assignment_to_application\",\n \"unassign_application_from_group\",\n \"list_interclient_allowed_applications\",\n \"create_interclient_trust_mapping\",\n \"delete_interclient_trust_mapping\",\n \"list_interclient_target_applications\",\n \"activate_application\",\n \"deactivate_application\",\n \"upload_application_logo\",\n \"assign_application_policy\",\n \"preview_sam_lmetadata_for_application\",\n \"list_o_auth2_tokens_for_application\",\n \"revoke_o_auth2_tokens_for_application\",\n \"get_o_auth2_token_for_application\",\n \"revoke_o_auth2_token_for_application\",\n \"list_application_users\",\n \"assign_user_to_application\",\n \"get_application_user\",\n \"update_application_user\",\n \"unassign_user_from_application\",\n \"verify_provisioning_connection_for_application\"\n ],\n \"skill_dir\": \"apps\",\n \"skill_name\": \"apps-routes\",\n \"skill_path\": \"skills/apps/SKILL.md\",\n \"subagent_name\": \"apps-api\"\n },\n {\n \"common_prefix\": \"/api/v1/authenticators\",\n \"description\": \"Handle 18 OpenAPI operation(s) under /api/v1/authenticators for the authenticators route group.\",\n \"id\": \"authenticators\",\n \"label\": \"authenticators\",\n \"operation_ids\": [\n \"list_authenticators\",\n \"create_authenticator\",\n \"get_authenticator\",\n \"replace_authenticator\",\n \"list_all_custom_aagui_ds\",\n \"create_custom_aaguid\",\n \"get_custom_aaguid\",\n \"replace_custom_aaguid\",\n \"update_custom_aaguid\",\n \"delete_custom_aaguid\",\n \"activate_authenticator\",\n \"deactivate_authenticator\",\n \"list_authenticator_methods\",\n \"get_authenticator_method\",\n \"replace_authenticator_method\",\n \"activate_authenticator_method\",\n \"deactivate_authenticator_method\",\n \"verify_rp_id_domain\"\n ],\n \"skill_dir\": \"authenticators\",\n \"skill_name\": \"authenticators-routes\",\n \"skill_path\": \"skills/authenticators/SKILL.md\",\n \"subagent_name\": \"authenticators-api\"\n },\n {\n \"common_prefix\": \"/api/v1/authorizationServers\",\n \"description\": \"Handle 48 OpenAPI operation(s) under /api/v1/authorizationServers for the authorizationServers route group.\",\n \"id\": \"authorization_servers\",\n \"label\": \"authorizationServers\",\n \"operation_ids\": [\n \"list_authorization_servers\",\n \"create_authorization_server\",\n \"get_authorization_server\",\n \"replace_authorization_server\",\n \"delete_authorization_server\",\n \"list_associated_servers_by_trusted_type\",\n \"create_associated_servers\",\n \"delete_associated_server\",\n \"list_o_auth2_claims\",\n \"create_o_auth2_claim\",\n \"get_o_auth2_claim\",\n \"replace_o_auth2_claim\",\n \"delete_o_auth2_claim\",\n \"list_o_auth2_clients_for_authorization_server\",\n \"list_refresh_tokens_for_authorization_server_and_client\",\n \"revoke_refresh_tokens_for_authorization_server_and_client\",\n \"get_refresh_token_for_authorization_server_and_client\",\n \"revoke_refresh_token_for_authorization_server_and_client\",\n \"list_authorization_server_keys\",\n \"get_authorization_server_key\",\n \"rotate_authorization_server_keys\",\n \"activate_authorization_server\",\n \"deactivate_authorization_server\",\n \"list_authorization_server_policies\",\n \"create_authorization_server_policy\",\n \"get_authorization_server_policy\",\n \"replace_authorization_server_policy\",\n \"delete_authorization_server_policy\",\n \"activate_authorization_server_policy\",\n \"deactivate_authorization_server_policy\",\n \"list_authorization_server_policy_rules\",\n \"create_authorization_server_policy_rule\",\n \"get_authorization_server_policy_rule\",\n \"replace_authorization_server_policy_rule\",\n \"delete_authorization_server_policy_rule\",\n \"activate_authorization_server_policy_rule\",\n \"deactivate_authorization_server_policy_rule\",\n \"list_o_auth2_resource_server_json_web_keys\",\n \"add_o_auth2_resource_server_json_web_key\",\n \"get_o_auth2_resource_server_json_web_key\",\n \"delete_o_auth2_resource_server_json_web_key\",\n \"activate_o_auth2_resource_server_json_web_key\",\n \"deactivate_o_auth2_resource_server_json_web_key\",\n \"list_o_auth2_scopes\",\n \"create_o_auth2_scope\",\n \"get_o_auth2_scope\",\n \"replace_o_auth2_scope\",\n \"delete_o_auth2_scope\"\n ],\n \"skill_dir\": \"authorization-servers\",\n \"skill_name\": \"authorization-servers-routes\",\n \"skill_path\": \"skills/authorization-servers/SKILL.md\",\n \"subagent_name\": \"authorization-servers-api\"\n },\n {\n \"common_prefix\": \"/api/v1/behaviors\",\n \"description\": \"Handle 7 OpenAPI operation(s) under /api/v1/behaviors for the behaviors route group.\",\n \"id\": \"behaviors\",\n \"label\": \"behaviors\",\n \"operation_ids\": [\n \"list_behavior_detection_rules\",\n \"create_behavior_detection_rule\",\n \"get_behavior_detection_rule\",\n \"replace_behavior_detection_rule\",\n \"delete_behavior_detection_rule\",\n \"activate_behavior_detection_rule\",\n \"deactivate_behavior_detection_rule\"\n ],\n \"skill_dir\": \"behaviors\",\n \"skill_name\": \"behaviors-routes\",\n \"skill_path\": \"skills/behaviors/SKILL.md\",\n \"subagent_name\": \"behaviors-api\"\n },\n {\n \"common_prefix\": \"/api/v1/bot-protection/configuration\",\n \"description\": \"Handle 2 OpenAPI operation(s) under /api/v1/bot-protection/configuration for the bot protection route group.\",\n \"id\": \"bot_protection\",\n \"label\": \"bot protection\",\n \"operation_ids\": [\n \"get_bot_protection_configuration\",\n \"update_bot_protection_configuration\"\n ],\n \"skill_dir\": \"bot-protection\",\n \"skill_name\": \"bot-protection-routes\",\n \"skill_path\": \"skills/bot-protection/SKILL.md\",\n \"subagent_name\": \"bot-protection-api\"\n },\n {\n \"common_prefix\": \"/api/v1/brands\",\n \"description\": \"Handle 52 OpenAPI operation(s) under /api/v1/brands for the brands route group.\",\n \"id\": \"brands\",\n \"label\": \"brands\",\n \"operation_ids\": [\n \"list_brands\",\n \"create_brand\",\n \"get_brand\",\n \"replace_brand\",\n \"delete_brand\",\n \"list_brand_domains\",\n \"get_error_page\",\n \"get_customized_error_page\",\n \"replace_customized_error_page\",\n \"delete_customized_error_page\",\n \"get_default_error_page\",\n \"get_preview_error_page\",\n \"replace_preview_error_page\",\n \"delete_preview_error_page\",\n \"get_sign_in_page\",\n \"get_customized_sign_in_page\",\n \"replace_customized_sign_in_page\",\n \"delete_customized_sign_in_page\",\n \"get_default_sign_in_page\",\n \"get_preview_sign_in_page\",\n \"replace_preview_sign_in_page\",\n \"delete_preview_sign_in_page\",\n \"list_all_sign_in_widget_versions\",\n \"get_sign_out_page_settings\",\n \"replace_sign_out_page_settings\",\n \"list_email_templates\",\n \"get_email_template\",\n \"list_email_customizations\",\n \"create_email_customization\",\n \"delete_all_customizations\",\n \"get_email_customization\",\n \"replace_email_customization\",\n \"delete_email_customization\",\n \"get_customization_preview\",\n \"get_email_default_content\",\n \"get_email_default_preview\",\n \"get_email_settings\",\n \"replace_email_settings\",\n \"send_test_email\",\n \"list_brand_themes\",\n \"get_brand_theme\",\n \"replace_brand_theme\",\n \"upload_brand_theme_background_image\",\n \"delete_brand_theme_background_image\",\n \"upload_brand_theme_favicon\",\n \"delete_brand_theme_favicon\",\n \"upload_brand_theme_logo\",\n \"delete_brand_theme_logo\",\n \"get_all_well_known_ur_is\",\n \"get_root_brand_well_known_uri\",\n \"get_brand_well_known_uri\",\n \"replace_brand_well_known_uri\"\n ],\n \"skill_dir\": \"brands\",\n \"skill_name\": \"brands-routes\",\n \"skill_path\": \"skills/brands/SKILL.md\",\n \"subagent_name\": \"brands-api\"\n },\n {\n \"common_prefix\": \"/api/v1/captchas\",\n \"description\": \"Handle 6 OpenAPI operation(s) under /api/v1/captchas for the captchas route group.\",\n \"id\": \"captchas\",\n \"label\": \"captchas\",\n \"operation_ids\": [\n \"list_captcha_instances\",\n \"create_captcha_instance\",\n \"get_captcha_instance\",\n \"update_captcha_instance\",\n \"replace_captcha_instance\",\n \"delete_captcha_instance\"\n ],\n \"skill_dir\": \"captchas\",\n \"skill_name\": \"captchas-routes\",\n \"skill_path\": \"skills/captchas/SKILL.md\",\n \"subagent_name\": \"captchas-api\"\n },\n {\n \"common_prefix\": \"/api/v1/device-assurances\",\n \"description\": \"Handle 5 OpenAPI operation(s) under /api/v1/device-assurances for the device assurances route group.\",\n \"id\": \"device_assurances\",\n \"label\": \"device assurances\",\n \"operation_ids\": [\n \"list_device_assurance_policies\",\n \"create_device_assurance_policy\",\n \"get_device_assurance_policy\",\n \"replace_device_assurance_policy\",\n \"delete_device_assurance_policy\"\n ],\n \"skill_dir\": \"device-assurances\",\n \"skill_name\": \"device-assurances-routes\",\n \"skill_path\": \"skills/device-assurances/SKILL.md\",\n \"subagent_name\": \"device-assurances-api\"\n },\n {\n \"common_prefix\": \"/api/v1/device-integrations\",\n \"description\": \"Handle 4 OpenAPI operation(s) under /api/v1/device-integrations for the device integrations route group.\",\n \"id\": \"device_integrations\",\n \"label\": \"device integrations\",\n \"operation_ids\": [\n \"list_device_integrations\",\n \"get_device_integration\",\n \"activate_device_integration\",\n \"deactivate_device_integration\"\n ],\n \"skill_dir\": \"device-integrations\",\n \"skill_name\": \"device-integrations-routes\",\n \"skill_path\": \"skills/device-integrations/SKILL.md\",\n \"subagent_name\": \"device-integrations-api\"\n },\n {\n \"common_prefix\": \"/api/v1/device-posture-checks\",\n \"description\": \"Handle 6 OpenAPI operation(s) under /api/v1/device-posture-checks for the device posture checks route group.\",\n \"id\": \"device_posture_checks\",\n \"label\": \"device posture checks\",\n \"operation_ids\": [\n \"list_device_posture_checks\",\n \"create_device_posture_check\",\n \"list_default_device_posture_checks\",\n \"get_device_posture_check\",\n \"replace_device_posture_check\",\n \"delete_device_posture_check\"\n ],\n \"skill_dir\": \"device-posture-checks\",\n \"skill_name\": \"device-posture-checks-routes\",\n \"skill_path\": \"skills/device-posture-checks/SKILL.md\",\n \"subagent_name\": \"device-posture-checks-api\"\n },\n {\n \"common_prefix\": \"/api/v1/devices\",\n \"description\": \"Handle 8 OpenAPI operation(s) under /api/v1/devices for the devices route group.\",\n \"id\": \"devices\",\n \"label\": \"devices\",\n \"operation_ids\": [\n \"list_devices\",\n \"get_device\",\n \"delete_device\",\n \"activate_device\",\n \"deactivate_device\",\n \"suspend_device\",\n \"unsuspend_device\",\n \"list_device_users\"\n ],\n \"skill_dir\": \"devices\",\n \"skill_name\": \"devices-routes\",\n \"skill_path\": \"skills/devices/SKILL.md\",\n \"subagent_name\": \"devices-api\"\n },\n {\n \"common_prefix\": \"/api/v1/directories/{appInstanceId}/groups\",\n \"description\": \"Handle 3 OpenAPI operation(s) under /api/v1/directories/{appInstanceId}/groups for the directories route group.\",\n \"id\": \"directories\",\n \"label\": \"directories\",\n \"operation_ids\": [\n \"update_group_membership\",\n \"submit_group_attribute_query\",\n \"get_group_attribute_query_result\"\n ],\n \"skill_dir\": \"directories\",\n \"skill_name\": \"directories-routes\",\n \"skill_path\": \"skills/directories/SKILL.md\",\n \"subagent_name\": \"directories-api\"\n },\n {\n \"common_prefix\": \"/api/v1/domains\",\n \"description\": \"Handle 7 OpenAPI operation(s) under /api/v1/domains for the domains route group.\",\n \"id\": \"domains\",\n \"label\": \"domains\",\n \"operation_ids\": [\n \"list_custom_domains\",\n \"create_custom_domain\",\n \"get_custom_domain\",\n \"replace_custom_domain\",\n \"delete_custom_domain\",\n \"upsert_certificate\",\n \"verify_domain\"\n ],\n \"skill_dir\": \"domains\",\n \"skill_name\": \"domains-routes\",\n \"skill_path\": \"skills/domains/SKILL.md\",\n \"subagent_name\": \"domains-api\"\n },\n {\n \"common_prefix\": \"/api/v1/dr\",\n \"description\": \"Handle 4 OpenAPI operation(s) under /api/v1/dr for the dr route group.\",\n \"id\": \"dr\",\n \"label\": \"dr\",\n \"operation_ids\": [\n \"start_org_failback\",\n \"start_org_failover\",\n \"get_dr_status\",\n \"get_dr_status_for_domain\"\n ],\n \"skill_dir\": \"dr\",\n \"skill_name\": \"dr-routes\",\n \"skill_path\": \"skills/dr/SKILL.md\",\n \"subagent_name\": \"dr-api\"\n },\n {\n \"common_prefix\": \"/api/v1/email-domains\",\n \"description\": \"Handle 6 OpenAPI operation(s) under /api/v1/email-domains for the email domains route group.\",\n \"id\": \"email_domains\",\n \"label\": \"email domains\",\n \"operation_ids\": [\n \"list_email_domains\",\n \"create_email_domain\",\n \"get_email_domain\",\n \"replace_email_domain\",\n \"delete_email_domain\",\n \"verify_email_domain\"\n ],\n \"skill_dir\": \"email-domains\",\n \"skill_name\": \"email-domains-routes\",\n \"skill_path\": \"skills/email-domains/SKILL.md\",\n \"subagent_name\": \"email-domains-api\"\n },\n {\n \"common_prefix\": \"/api/v1/email-servers\",\n \"description\": \"Handle 6 OpenAPI operation(s) under /api/v1/email-servers for the email servers route group.\",\n \"id\": \"email_servers\",\n \"label\": \"email servers\",\n \"operation_ids\": [\n \"list_email_servers\",\n \"create_email_server\",\n \"get_email_server\",\n \"update_email_server\",\n \"delete_email_server\",\n \"test_email_server\"\n ],\n \"skill_dir\": \"email-servers\",\n \"skill_name\": \"email-servers-routes\",\n \"skill_path\": \"skills/email-servers/SKILL.md\",\n \"subagent_name\": \"email-servers-api\"\n },\n {\n \"common_prefix\": \"/api/v1/eventHooks\",\n \"description\": \"Handle 8 OpenAPI operation(s) under /api/v1/eventHooks for the eventHooks route group.\",\n \"id\": \"event_hooks\",\n \"label\": \"eventHooks\",\n \"operation_ids\": [\n \"list_event_hooks\",\n \"create_event_hook\",\n \"get_event_hook\",\n \"replace_event_hook\",\n \"delete_event_hook\",\n \"activate_event_hook\",\n \"deactivate_event_hook\",\n \"verify_event_hook\"\n ],\n \"skill_dir\": \"event-hooks\",\n \"skill_name\": \"event-hooks-routes\",\n \"skill_path\": \"skills/event-hooks/SKILL.md\",\n \"subagent_name\": \"event-hooks-api\"\n },\n {\n \"common_prefix\": \"/api/v1/features\",\n \"description\": \"Handle 5 OpenAPI operation(s) under /api/v1/features for the features route group.\",\n \"id\": \"features\",\n \"label\": \"features\",\n \"operation_ids\": [\n \"list_features\",\n \"get_feature\",\n \"list_feature_dependencies\",\n \"list_feature_dependents\",\n \"update_feature_lifecycle\"\n ],\n \"skill_dir\": \"features\",\n \"skill_name\": \"features-routes\",\n \"skill_path\": \"skills/features/SKILL.md\",\n \"subagent_name\": \"features-api\"\n },\n {\n \"common_prefix\": \"/api/v1/first-party-app-settings/{appName}\",\n \"description\": \"Handle 2 OpenAPI operation(s) under /api/v1/first-party-app-settings/{appName} for the first party app settings route group.\",\n \"id\": \"first_party_app_settings\",\n \"label\": \"first party app settings\",\n \"operation_ids\": [\n \"get_first_party_app_settings\",\n \"replace_first_party_app_settings\"\n ],\n \"skill_dir\": \"first-party-app-settings\",\n \"skill_name\": \"first-party-app-settings-routes\",\n \"skill_path\": \"skills/first-party-app-settings/SKILL.md\",\n \"subagent_name\": \"first-party-app-settings-api\"\n },\n {\n \"common_prefix\": \"/api/v1/groups\",\n \"description\": \"Handle 31 OpenAPI operation(s) under /api/v1/groups for the groups route group.\",\n \"id\": \"groups\",\n \"label\": \"groups\",\n \"operation_ids\": [\n \"list_groups\",\n \"add_group\",\n \"list_group_rules\",\n \"create_group_rule\",\n \"get_group_rule\",\n \"replace_group_rule\",\n \"delete_group_rule\",\n \"activate_group_rule\",\n \"deactivate_group_rule\",\n \"get_group\",\n \"replace_group\",\n \"delete_group\",\n \"list_assigned_applications_for_group\",\n \"list_group_owners\",\n \"assign_group_owner\",\n \"delete_group_owner\",\n \"list_group_assigned_roles\",\n \"assign_role_to_group\",\n \"get_group_assigned_role\",\n \"unassign_role_from_group\",\n \"list_application_targets_for_application_administrator_role_for_group\",\n \"assign_app_target_to_admin_role_for_group\",\n \"unassign_app_target_to_admin_role_for_group\",\n \"assign_app_instance_target_to_app_admin_role_for_group\",\n \"unassign_app_instance_target_to_app_admin_role_for_group\",\n \"list_group_targets_for_group_role\",\n \"assign_group_target_to_group_admin_role\",\n \"unassign_group_target_from_group_admin_role\",\n \"list_group_users\",\n \"assign_user_to_group\",\n \"unassign_user_from_group\"\n ],\n \"skill_dir\": \"groups\",\n \"skill_name\": \"groups-routes\",\n \"skill_path\": \"skills/groups/SKILL.md\",\n \"subagent_name\": \"groups-api\"\n },\n {\n \"common_prefix\": \"/api/v1/hook-keys\",\n \"description\": \"Handle 6 OpenAPI operation(s) under /api/v1/hook-keys for the hook keys route group.\",\n \"id\": \"hook_keys\",\n \"label\": \"hook keys\",\n \"operation_ids\": [\n \"list_hook_keys\",\n \"create_hook_key\",\n \"get_public_key\",\n \"get_hook_key\",\n \"replace_hook_key\",\n \"delete_hook_key\"\n ],\n \"skill_dir\": \"hook-keys\",\n \"skill_name\": \"hook-keys-routes\",\n \"skill_path\": \"skills/hook-keys/SKILL.md\",\n \"subagent_name\": \"hook-keys-api\"\n },\n {\n \"common_prefix\": \"/api/v1/iam\",\n \"description\": \"Handle 40 OpenAPI operation(s) under /api/v1/iam for the iam route group.\",\n \"id\": \"iam\",\n \"label\": \"iam\",\n \"operation_ids\": [\n \"list_users_with_role_assignments\",\n \"list_governance_bundles\",\n \"create_governance_bundle\",\n \"get_governance_bundle\",\n \"replace_governance_bundle\",\n \"delete_governance_bundle\",\n \"list_bundle_entitlements\",\n \"list_bundle_entitlement_values\",\n \"get_opt_in_status\",\n \"opt_in\",\n \"opt_out\",\n \"list_resource_sets\",\n \"create_resource_set\",\n \"get_resource_set\",\n \"replace_resource_set\",\n \"delete_resource_set\",\n \"list_bindings\",\n \"create_resource_set_binding\",\n \"get_binding\",\n \"delete_binding\",\n \"list_members_of_binding\",\n \"add_members_to_binding\",\n \"get_member_of_binding\",\n \"unassign_member_from_binding\",\n \"list_resource_set_resources\",\n \"add_resource_set_resource\",\n \"add_resource_set_resources\",\n \"get_resource_set_resource\",\n \"replace_resource_set_resource\",\n \"delete_resource_set_resource\",\n \"list_roles\",\n \"create_role\",\n \"get_role\",\n \"replace_role\",\n \"delete_role\",\n \"list_role_permissions\",\n \"get_role_permission\",\n \"create_role_permission\",\n \"replace_role_permission\",\n \"delete_role_permission\"\n ],\n \"skill_dir\": \"iam\",\n \"skill_name\": \"iam-routes\",\n \"skill_path\": \"skills/iam/SKILL.md\",\n \"subagent_name\": \"iam-api\"\n },\n {\n \"common_prefix\": \"/api/v1/identity-sources/{identitySourceId}\",\n \"description\": \"Handle 23 OpenAPI operation(s) under /api/v1/identity-sources/{identitySourceId} for the identity sources route group.\",\n \"id\": \"identity_sources\",\n \"label\": \"identity sources\",\n \"operation_ids\": [\n \"create_identity_source_groups\",\n \"get_identity_source_group\",\n \"update_identity_source_groups\",\n \"delete_identity_source_group\",\n \"get_identity_source_group_memberships\",\n \"create_identity_source_groups_memberships\",\n \"delete_identity_source_group_memberships\",\n \"list_identity_source_sessions\",\n \"create_identity_source_session\",\n \"get_identity_source_session\",\n \"delete_identity_source_session\",\n \"upload_identity_source_data_for_delete\",\n \"upload_identity_source_group_memberships_for_delete\",\n \"upload_identity_source_group_memberships_for_upsert\",\n \"upload_identity_source_groups_data_for_delete\",\n \"upload_identity_source_groups_for_upsert\",\n \"upload_identity_source_data_for_upsert\",\n \"start_import_from_identity_source\",\n \"create_identity_source_user\",\n \"get_identity_source_user\",\n \"replace_existing_identity_source_user\",\n \"update_identity_source_users\",\n \"delete_identity_source_user\"\n ],\n \"skill_dir\": \"identity-sources\",\n \"skill_name\": \"identity-sources-routes\",\n \"skill_path\": \"skills/identity-sources/SKILL.md\",\n \"subagent_name\": \"identity-sources-api\"\n },\n {\n \"common_prefix\": \"/api/v1/idps\",\n \"description\": \"Handle 27 OpenAPI operation(s) under /api/v1/idps for the idps route group.\",\n \"id\": \"idps\",\n \"label\": \"idps\",\n \"operation_ids\": [\n \"list_identity_providers\",\n \"create_identity_provider\",\n \"list_identity_provider_keys\",\n \"create_identity_provider_key\",\n \"get_identity_provider_key\",\n \"replace_identity_provider_key\",\n \"delete_identity_provider_key\",\n \"get_identity_provider\",\n \"replace_identity_provider\",\n \"delete_identity_provider\",\n \"list_csrs_for_identity_provider\",\n \"generate_csr_for_identity_provider\",\n \"get_csr_for_identity_provider\",\n \"revoke_csr_for_identity_provider\",\n \"publish_csr_for_identity_provider\",\n \"list_identity_provider_signing_keys\",\n \"list_active_identity_provider_signing_key\",\n \"generate_identity_provider_signing_key\",\n \"get_identity_provider_signing_key\",\n \"clone_identity_provider_key\",\n \"activate_identity_provider\",\n \"deactivate_identity_provider\",\n \"list_identity_provider_application_users\",\n \"get_identity_provider_application_user\",\n \"link_user_to_identity_provider\",\n \"unlink_user_from_identity_provider\",\n \"list_social_auth_tokens\"\n ],\n \"skill_dir\": \"idps\",\n \"skill_name\": \"idps-routes\",\n \"skill_path\": \"skills/idps/SKILL.md\",\n \"subagent_name\": \"idps-api\"\n },\n {\n \"common_prefix\": \"/api/v1/inlineHooks\",\n \"description\": \"Handle 9 OpenAPI operation(s) under /api/v1/inlineHooks for the inlineHooks route group.\",\n \"id\": \"inline_hooks\",\n \"label\": \"inlineHooks\",\n \"operation_ids\": [\n \"list_inline_hooks\",\n \"create_inline_hook\",\n \"get_inline_hook\",\n \"update_inline_hook\",\n \"replace_inline_hook\",\n \"delete_inline_hook\",\n \"execute_inline_hook\",\n \"activate_inline_hook\",\n \"deactivate_inline_hook\"\n ],\n \"skill_dir\": \"inline-hooks\",\n \"skill_name\": \"inline-hooks-routes\",\n \"skill_path\": \"skills/inline-hooks/SKILL.md\",\n \"subagent_name\": \"inline-hooks-api\"\n },\n {\n \"common_prefix\": \"/api/v1/logStreams\",\n \"description\": \"Handle 7 OpenAPI operation(s) under /api/v1/logStreams for the logStreams route group.\",\n \"id\": \"log_streams\",\n \"label\": \"logStreams\",\n \"operation_ids\": [\n \"list_log_streams\",\n \"create_log_stream\",\n \"get_log_stream\",\n \"replace_log_stream\",\n \"delete_log_stream\",\n \"activate_log_stream\",\n \"deactivate_log_stream\"\n ],\n \"skill_dir\": \"log-streams\",\n \"skill_name\": \"log-streams-routes\",\n \"skill_path\": \"skills/log-streams/SKILL.md\",\n \"subagent_name\": \"log-streams-api\"\n },\n {\n \"common_prefix\": \"/api/v1/logs\",\n \"description\": \"Handle 1 OpenAPI operation(s) under /api/v1/logs for the logs route group.\",\n \"id\": \"logs\",\n \"label\": \"logs\",\n \"operation_ids\": [\n \"list_log_events\"\n ],\n \"skill_dir\": \"logs\",\n \"skill_name\": \"logs-routes\",\n \"skill_path\": \"skills/logs/SKILL.md\",\n \"subagent_name\": \"logs-api\"\n },\n {\n \"common_prefix\": \"/api/v1/mappings\",\n \"description\": \"Handle 3 OpenAPI operation(s) under /api/v1/mappings for the mappings route group.\",\n \"id\": \"mappings\",\n \"label\": \"mappings\",\n \"operation_ids\": [\n \"list_profile_mappings\",\n \"get_profile_mapping\",\n \"update_profile_mapping\"\n ],\n \"skill_dir\": \"mappings\",\n \"skill_name\": \"mappings-routes\",\n \"skill_path\": \"skills/mappings/SKILL.md\",\n \"subagent_name\": \"mappings-api\"\n },\n {\n \"common_prefix\": \"/api/v1/meta\",\n \"description\": \"Handle 23 OpenAPI operation(s) under /api/v1/meta for the meta route group.\",\n \"id\": \"meta\",\n \"label\": \"meta\",\n \"operation_ids\": [\n \"get_application_user_schema\",\n \"update_application_user_profile\",\n \"get_group_schema\",\n \"update_group_schema\",\n \"list_log_stream_schemas\",\n \"get_log_stream_schema\",\n \"list_linked_object_definitions\",\n \"create_linked_object_definition\",\n \"get_linked_object_definition\",\n \"delete_linked_object_definition\",\n \"get_user_schema\",\n \"update_user_profile\",\n \"list_user_types\",\n \"create_user_type\",\n \"get_user_type\",\n \"update_user_type\",\n \"replace_user_type\",\n \"delete_user_type\",\n \"list_ui_schemas\",\n \"create_ui_schema\",\n \"get_ui_schema\",\n \"replace_ui_schemas\",\n \"delete_ui_schemas\"\n ],\n \"skill_dir\": \"meta\",\n \"skill_name\": \"meta-routes\",\n \"skill_path\": \"skills/meta/SKILL.md\",\n \"subagent_name\": \"meta-api\"\n },\n {\n \"common_prefix\": \"/api/v1/org\",\n \"description\": \"Handle 31 OpenAPI operation(s) under /api/v1/org for the org route group.\",\n \"id\": \"org\",\n \"label\": \"org\",\n \"operation_ids\": [\n \"get_org_settings\",\n \"update_org_settings\",\n \"replace_org_settings\",\n \"get_org_captcha_settings\",\n \"replaces_org_captcha_settings\",\n \"delete_org_captcha_settings\",\n \"list_org_contact_types\",\n \"get_org_contact_user\",\n \"replace_org_contact_user\",\n \"bulk_remove_email_address_bounces\",\n \"list_yubikey_otp_tokens\",\n \"upload_yubikey_otp_token_seed\",\n \"get_yubikey_otp_token_by_id\",\n \"get_third_party_admin_setting\",\n \"update_third_party_admin_setting\",\n \"get_org_preferences\",\n \"set_org_hide_okta_ui_footer\",\n \"set_org_show_okta_ui_footer\",\n \"get_aerial_consent\",\n \"grant_aerial_consent\",\n \"revoke_aerial_consent\",\n \"get_okta_communication_settings\",\n \"opt_in_users_to_okta_communication_emails\",\n \"opt_out_users_from_okta_communication_emails\",\n \"get_org_okta_support_settings\",\n \"list_okta_support_cases\",\n \"update_okta_support_case\",\n \"extend_okta_support\",\n \"grant_okta_support\",\n \"revoke_okta_support\",\n \"get_auto_assign_admin_app_setting\"\n ],\n \"skill_dir\": \"org\",\n \"skill_name\": \"org-routes\",\n \"skill_path\": \"skills/org/SKILL.md\",\n \"subagent_name\": \"org-api\"\n }\n]") +ROOT_SECURITY = json.loads("[]") +SECURITY_SCHEMES = json.loads("{\n \"apiToken\": {\n \"description\": \"Pass the API token as the Authorization header value prefixed with SSWS: `Authorization: SSWS {API Token}`\",\n \"in\": \"header\",\n \"name\": \"Authorization\",\n \"type\": \"apiKey\"\n },\n \"oauth2\": {\n \"description\": \"Pass the access_token as the value of the Authorization header: `Authorization: Bearer {access_token}`\",\n \"flows\": {\n \"authorizationCode\": {\n \"authorizationUrl\": \"/oauth2/v1/authorize\",\n \"scopes\": {\n \"okta.agentPools.manage\": \"Allows the app to create and manage agent pools in your Okta organization\",\n \"okta.agentPools.read\": \"Allows the app to read agent pools in your Okta organization\",\n \"okta.apiTokens.manage\": \"Allows the app to manage API Tokens in your Okta organization\",\n \"okta.apiTokens.read\": \"Allows the app to read API Tokens in your Okta organization\",\n \"okta.appGrants.manage\": \"Allows the app to create and manage grants in your Okta organization\",\n \"okta.appGrants.read\": \"Allows the app to read grants in your Okta organization\",\n \"okta.apps.interclientTrust.manage\": \"Allows the app to manage trusted relationship for native to web SSO\",\n \"okta.apps.interclientTrust.read\": \"Allows the app to read configured trusted relationship for native to web SSO\",\n \"okta.apps.manage\": \"Allows the app to create and manage Apps in your Okta organization\",\n \"okta.apps.read\": \"Allows the app to read information about Apps in your Okta organization\",\n \"okta.authenticators.manage\": \"Allows the app to manage all authenticators. For example, enrollments or resets.\",\n \"okta.authenticators.read\": \"Allows the app to read org authenticators information\",\n \"okta.authorizationServers.manage\": \"Allows the app to create and manage Authorization Servers in your Okta organization\",\n \"okta.authorizationServers.read\": \"Allows the app to read information about Authorization Servers in your Okta organization\",\n \"okta.behaviors.manage\": \"Allows the app to create and manage behavior detection rules in your Okta organization\",\n \"okta.behaviors.read\": \"Allows the app to read behavior detection rules in your Okta org\",\n \"okta.botProtection.manage\": \"Allows the app to manage bot protection configuration in your Okta org\",\n \"okta.botProtection.read\": \"Allows the app to read bot protection configuration in your Okta org\",\n \"okta.brands.manage\": \"Allows the app to create and manage Brands and Themes in your Okta organization\",\n \"okta.brands.read\": \"Allows the app to read information about Brands and Themes in your Okta organization\",\n \"okta.captchas.manage\": \"Allows the app to create and manage CAPTCHAs in your Okta organization\",\n \"okta.captchas.read\": \"Allows the app to read information about CAPTCHAs in your Okta organization\",\n \"okta.customTelephonyProvider.manage\": \"Allows the app to create and manage custom telephony provider credentials\",\n \"okta.customTelephonyProvider.read\": \"Allows the app to read custom telephony provider credentials\",\n \"okta.deviceAssurance.manage\": \"Allows the app to manage device assurances\",\n \"okta.deviceAssurance.read\": \"Allows the app to read device assurances\",\n \"okta.deviceIntegrations.manage\": \"Allows the app to manage device integrations\",\n \"okta.deviceIntegrations.read\": \"Allows the app to read device integrations\",\n \"okta.devicePostureChecks.manage\": \"Allows the app to manage device posture checks\",\n \"okta.devicePostureChecks.read\": \"Allows the app to read device posture checks\",\n \"okta.devices.manage\": \"Allows the app to manage device status transitions and delete a device\",\n \"okta.devices.read\": \"Allows the app to read the existing device's profile and search devices\",\n \"okta.directories.groups.manage\": \"Allows the app to manage AD/LDAP groups for your Okta organization\",\n \"okta.directories.groups.read\": \"Allows the app to read AD/LDAP groups for your Okta organization\",\n \"okta.domains.manage\": \"Allows the app to manage custom Domains for your Okta organization\",\n \"okta.domains.read\": \"Allows the app to read information about custom Domains for your Okta organization\",\n \"okta.dr.manage\": \"Allows the app to manage disaster recovery\",\n \"okta.dr.read\": \"Allows the app to read the disaster recovery status\",\n \"okta.emailDomains.manage\": \"Allows the app to manage Email Domains for your Okta organization\",\n \"okta.emailDomains.read\": \"Allows the app to read information about Email Domains for your Okta organization\",\n \"okta.emailServers.manage\": \"Allows the app to manage Email Servers for your Okta organization\",\n \"okta.emailServers.read\": \"Allows the app to read information about Email Servers for your Okta organization\",\n \"okta.eventHooks.manage\": \"Allows the app to create and manage Event Hooks in your Okta organization\",\n \"okta.eventHooks.read\": \"Allows the app to read information about Event Hooks in your Okta organization\",\n \"okta.features.manage\": \"Allows the app to create and manage Features in your Okta organization\",\n \"okta.features.read\": \"Allows the app to read information about Features in your Okta organization\",\n \"okta.groups.manage\": \"Allows the app to create and manage groups in your Okta organization\",\n \"okta.groups.read\": \"Allows the app to read information about groups and their members in your Okta organization\",\n \"okta.identitySources.manage\": \"Allows the custom identity sources to manage user entities in your Okta organization\",\n \"okta.identitySources.read\": \"Allows to read session information for custom identity sources in your Okta organization\",\n \"okta.idps.manage\": \"Allows the app to create and manage Identity Providers in your Okta organization\",\n \"okta.idps.read\": \"Allows the app to read information about Identity Providers in your Okta organization\",\n \"okta.inlineHooks.manage\": \"Allows the app to create and manage Inline Hooks in your Okta organization\",\n \"okta.inlineHooks.read\": \"Allows the app to read information about Inline Hooks in your Okta organization\",\n \"okta.linkedObjects.manage\": \"Allows the app to manage linked object definitions in your Okta organization\",\n \"okta.linkedObjects.read\": \"Allows the app to read linked object definitions in your Okta organization\",\n \"okta.logStreams.manage\": \"Allows the app to create and manage log streams in your Okta organization\",\n \"okta.logStreams.read\": \"Allows the app to read information about log streams in your Okta organization\",\n \"okta.logs.read\": \"Allows the app to read information about System Log entries in your Okta organization\",\n \"okta.networkZones.manage\": \"Allows the app to create and manage Network Zones in your Okta organization\",\n \"okta.networkZones.read\": \"Allows the app to read Network Zones in your Okta organization\",\n \"okta.oauthIntegrations.manage\": \"Allows the app to create and manage API service Integration instances in your Okta organization\",\n \"okta.oauthIntegrations.read\": \"Allows the app to read API service Integration instances in your Okta organization\",\n \"okta.orgs.manage\": \"Allows the app to manage organization-specific details for your Okta organization\",\n \"okta.orgs.read\": \"Allows the app to read organization-specific details about your Okta organization\",\n \"okta.personal.adminSettings.manage\": \"Allows the app to manage the personal admin settings for the signed-in user\",\n \"okta.personal.adminSettings.read\": \"Allows the app to read the personal admin settings for the signed-in user\",\n \"okta.policies.manage\": \"Allows the app to manage policies in your Okta organization\",\n \"okta.policies.read\": \"Allows the app to read information about policies in your Okta organization\",\n \"okta.principalRateLimits.manage\": \"Allows the app to create and manage Principal Rate Limits in your Okta organization\",\n \"okta.principalRateLimits.read\": \"Allows the app to read information about Principal Rate Limits in your Okta organization\",\n \"okta.profileMappings.manage\": \"Allows the app to manage user profile mappings in your Okta organization\",\n \"okta.profileMappings.read\": \"Allows the app to read user profile mappings in your Okta organization\",\n \"okta.pushProviders.manage\": \"Allows the app to create and manage push notification providers such as APNs and FCM\",\n \"okta.pushProviders.read\": \"Allows the app to read push notification providers such as APNs and FCM\",\n \"okta.rateLimits.manage\": \"Allows the app to create and manage rate limits in your Okta organization\",\n \"okta.rateLimits.read\": \"Allows the app to read information about rate limits in your Okta organization\",\n \"okta.realmAssignments.manage\": \"Allows a user to manage realm assignments\",\n \"okta.realmAssignments.read\": \"Allows a user to read realm assignments\",\n \"okta.realms.manage\": \"Allows the app to create new realms and to manage their details\",\n \"okta.realms.read\": \"Allows the app to read the existing realms and their details\",\n \"okta.roles.manage\": \"Allows the app to manage administrative role assignments for users in your Okta organization. Delegated admins with this permission can only manage user credential fields and not the credential values themselves.\",\n \"okta.roles.read\": \"Allows the app to read administrative role assignments for users in your Okta organization. Delegated admins with this permission can only read user credential fields and not the credential values themselves.\",\n \"okta.schemas.manage\": \"Allows the app to create and manage Schemas in your Okta organization\",\n \"okta.schemas.read\": \"Allows the app to read information about Schemas in your Okta organization\",\n \"okta.securityEventsProviders.manage\": \"Allows the app to create and manage Security Events Providers in your Okta organization\",\n \"okta.securityEventsProviders.read\": \"Allows the app to read information about Security Events Providers in your Okta organization\",\n \"okta.serviceAccounts.manage\": \"Allows the app to manage service accounts in your Okta organization\",\n \"okta.serviceAccounts.okta.manage\": \"Allows the app to manage Okta managed user accounts in your Okta org\",\n \"okta.serviceAccounts.okta.read\": \"Allows the app to read Okta managed user accounts in your Okta org\",\n \"okta.serviceAccounts.read\": \"Allows the app to read service accounts in your Okta organization\",\n \"okta.sessions.manage\": \"Allows the app to manage all sessions in your Okta organization\",\n \"okta.sessions.read\": \"Allows the app to read all sessions in your Okta organization\",\n \"okta.templates.manage\": \"Allows the app to manage all custom templates in your Okta organization\",\n \"okta.templates.read\": \"Allows the app to read all custom templates in your Okta organization\",\n \"okta.threatInsights.manage\": \"Allows the app to manage all ThreatInsight configurations in your Okta organization\",\n \"okta.threatInsights.read\": \"Allows the app to read all ThreatInsight configurations in your Okta organization\",\n \"okta.trustedOrigins.manage\": \"Allows the app to manage all Trusted Origins in your Okta organization\",\n \"okta.trustedOrigins.read\": \"Allows the app to read all Trusted Origins in your Okta organization\",\n \"okta.uischemas.manage\": \"Allows the app to manage all the UI Schemas in your Okta organization\",\n \"okta.uischemas.read\": \"Allows the app to read all the UI Schemas in your Okta organization\",\n \"okta.userRisk.manage\": \"Allows the app to manage a user's risk in your Okta org\",\n \"okta.userRisk.read\": \"Allows the app to read a user's risk in your Okta org\",\n \"okta.userTypes.manage\": \"Allows the app to manage user types in your Okta org\",\n \"okta.userTypes.read\": \"Allows the app to read user types in your Okta org\",\n \"okta.users.manage\": \"Allows the app to create new users and to manage all users' profile and credentials information\",\n \"okta.users.read\": \"Allows the app to read the existing users' profiles and credentials\",\n \"ssf.manage\": \"Allows the app to create and manage Shared Signals Framework (SSF) in your Okta organization\",\n \"ssf.read\": \"Allows the app to read information about Shared Signals Framework (SSF) in your Okta organization\"\n },\n \"tokenUrl\": \"/oauth2/v1/token\"\n }\n },\n \"type\": \"oauth2\"\n }\n}") +SECURITY_FIELDS = json.loads("{\n \"apiToken\": {\n \"field\": \"AUTHORIZATION\",\n \"kind\": \"apiKey\",\n \"location\": \"header\",\n \"name\": \"Authorization\"\n },\n \"oauth2\": {\n \"field\": \"OAUTH2\",\n \"kind\": \"oauth2\",\n \"scheme\": \"Bearer\"\n }\n}") +PATH_PARAMETER_RE = re.compile(r"{([^}/]+)}") +SOURCE_ROOT = Path(globals().get("__file__", "agent.py")).resolve().parent +SOURCE_SKILLS_DIR = SOURCE_ROOT / "skills" +RUNTIME_SKILLS_DIR = ".deepagents/openapi-skills/" + + +class OperationInput(BaseModel): + parameters: dict[str, Any] = Field( + default_factory=dict, + description="Path, query, header, and cookie parameters keyed by OpenAPI parameter name.", + ) + body: Any | None = Field(default=None, description="JSON request body, when the operation accepts one.") + + +class OktaManagementOpenapiAgent(A2AAgent): + name = "okta-management-openapi-agent" + description = "Identity management API for users, groups, apps, orgs, and admin workflows." + version = "2026.06.2" + consumer_setup = ConsumerSetup.from_fields( + ConsumerSetupField.config("OPENAPI_BASE_URL", label="API base URL", description="Override the default API server (https://{yourOktaDomain}).", required=False, input_type="url"), + ConsumerSetupField.secret("AUTHORIZATION", label="apiToken API key", description="Pass the API token as the Authorization header value prefixed with SSWS: `Authorization: SSWS {API Token}`", required=True), + ConsumerSetupField.secret("OAUTH2", label="oauth2 access token", description="Pass the access_token as the value of the Authorization header: `Authorization: Bearer {access_token}`", required=True), + ) + llm_provisioning = LLMProvisioning.PLATFORM + pricing = Pricing( + price_per_call_usd=0.0, + caller_pays_llm=True, + notes="Uses the caller's saved LLM credential through ctx.llm.", + ) + resources = Resources(cpu="200m", memory="512Mi") + egress = EgressPolicy( + allow_hosts=('{youroktadomain}',), + deny_internet_by_default=True, + ) + tools_used = ("openapi", "deepagents") + capabilities = { + "openapi_auto_agent": { + "operation_count": len(OPERATIONS), + "default_base_url": DEFAULT_BASE_URL, + "source_openapi_url": 'https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml', + "source_openapi_urls": ['https://raw.githubusercontent.com/okta/okta-management-openapi-spec/master/dist/current/management-minimal.yaml'], + "server_urls": ['https://{yourOktaDomain}'], + "regenerable": True, + "security_schemes": list(SECURITY_SCHEMES), + } + } + + @skill( + name="auto", + description="Use the OpenAPI service to complete a natural-language goal.", + tags=("openapi", "auto"), + timeout_seconds=900, + ) + async def auto(self, ctx: RunContext, goal: str) -> dict[str, Any]: + creds = ctx.llm + if not creds.api_key: + return { + "error": "llm_credentials_missing", + "final": ( + "LLM key required. Add an LLM credential in Settings > " + "LLM credentials before running this agent." + ), + "messages": [], + } + backend = ctx.workspace_backend() + skills_root = _seed_runtime_skills(backend, ctx) + graph = create_a2a_deep_agent( + ctx, + creds=creds, + backend=backend, + tools=[], + subagents=self._operation_subagents(ctx, skills_root), + system_prompt=self._system_prompt(), + ) + result = await graph.ainvoke({"messages": [{"role": "user", "content": goal}]}) + messages = result.get("messages", []) if isinstance(result, dict) else [] + final = _message_text(messages[-1]) if messages else result + return { + "final": final, + "messages": [_message_to_dict(message) for message in messages[-8:]], + } + + + + def _operation_subagents(self, ctx: RunContext, skills_root: str) -> list[dict[str, Any]]: + subagents: list[dict[str, Any]] = [] + for group in OPERATION_GROUPS: + skill_path = ( + f"{skills_root}{group['skill_dir']}/" + if skills_root + else "" + ) + subagent = { + "name": group["subagent_name"], + "description": group["description"], + "system_prompt": self._subagent_prompt(group), + "tools": self._operation_tools(ctx, set(group["operation_ids"])), + } + if skill_path: + subagent["skills"] = [skill_path] + subagents.append(subagent) + return subagents + + def _operation_tools( + self, + ctx: RunContext, + operation_ids: set[str] | None = None, + ) -> list[StructuredTool]: + tools: list[StructuredTool] = [] + for operation_id, operation in OPERATIONS.items(): + if operation_ids is not None and operation_id not in operation_ids: + continue + async def call( + parameters: dict[str, Any] | None = None, + body: Any | None = None, + *, + _operation_id: str = operation_id, + ) -> dict[str, Any]: + return await self._request( + ctx, + _operation_id, + parameters=parameters or {}, + body=body, + ) + + tools.append( + StructuredTool.from_function( + coroutine=call, + name=operation["skill_name"], + description=self._tool_description(operation), + args_schema=OperationInput, + ) + ) + return tools + + def _system_prompt(self) -> str: + if OPERATION_GROUPS: + lines = [ + "You coordinate route-specific OpenAPI subagents.", + "Delegate API work to the matching subagent with the task tool.", + "Do not invent API responses; ask subagents to call their tools for real results.", + "If a subagent reports missing consumer setup, tell the user which setup field is required.", + "If a subagent reports that the generated OpenAPI agent may be stale, ask whether the user wants to refresh it from the latest OpenAPI spec.", + "", + "Available route groups:", + ] + for group in OPERATION_GROUPS: + lines.append( + f"- {group['subagent_name']}: {group['description']}" + ) + return "\n".join(lines) + lines = [ + "You operate an API through generated OpenAPI tools.", + "Call tools to get real results. Do not invent API responses.", + "For write, update, or delete operations, explain the intended action before calling the tool.", + "If an operation reports missing consumer setup, tell the user which setup field is required.", + "If an operation returns 404, 405, 410, or a schema/validation error that suggests the live API no longer matches these tools, tell the user this generated agent may need to be refreshed from the latest OpenAPI spec and ask whether they want to refresh it.", + "", + "Available operations:", + ] + for operation in OPERATIONS.values(): + marker = "WRITE" if operation.get("destructive") else "READ" + lines.append( + f"- {operation['skill_name']}: {marker} {operation['method']} {operation['path']} — {operation['summary']}" + ) + return "\n".join(lines) + + def _subagent_prompt(self, group: dict[str, Any]) -> str: + lines = [ + "You operate one route group from a generated OpenAPI API.", + "Use the available operation tools to make real API calls. Do not invent API responses.", + "Read the route group's SKILL.md when it applies; it lists every route you cover.", + "For write, update, or delete operations, explain the intended action before calling the tool.", + "If an operation reports missing consumer setup, return the exact setup field name.", + "If an operation returns 404, 405, 410, or a schema/validation error that suggests the live API no longer matches these tools, say the generated agent may need to be refreshed from the latest OpenAPI spec.", + "", + f"Route group: {group['label']}", + f"Common prefix: {group.get('common_prefix') or '/'}", + "Available operation tools:", + ] + for operation_id in group["operation_ids"]: + operation = OPERATIONS[operation_id] + marker = "WRITE" if operation.get("destructive") else "READ" + lines.append( + f"- {operation['skill_name']}: {marker} {operation['method']} {operation['path']} - {operation['summary']}" + ) + return "\n".join(lines) + + def _tool_description(self, operation: dict[str, Any]) -> str: + parts = [ + f"{operation['method']} {operation['path']}", + str(operation.get("description") or operation.get("summary") or ""), + ] + if operation.get("parameters"): + parts.append( + "Parameters: " + + ", ".join( + f"{p['name']} in {p['in']}{' required' if p.get('required') else ''}" + for p in operation["parameters"] + ) + ) + if operation.get("request_body") is not None: + parts.append("Accepts a JSON request body.") + return "\n".join(part for part in parts if part) + + async def _request( + self, + ctx: RunContext, + operation_id: str, + *, + parameters: dict[str, Any], + body: Any | None, + ) -> dict[str, Any]: + operation = OPERATIONS[operation_id] + default_base_url = str(operation.get("base_url") or DEFAULT_BASE_URL).rstrip("/") + base_url_field = str(operation.get("base_url_field") or "OPENAPI_BASE_URL") + base_url = str(ctx.consumer_config(base_url_field, default_base_url) or default_base_url).rstrip("/") + url, query, headers = self._request_parts(ctx, operation, parameters) + request_kwargs: dict[str, Any] = { + "params": query, + "headers": headers, + } + if body is not None: + if isinstance(body, (bytes, bytearray)): + body = body.decode("utf-8", errors="replace") + if isinstance(body, str): + stripped = body.strip() + if stripped and stripped[0] in "{[": + try: + body = json.loads(stripped) + except ValueError: + pass + request_kwargs["json"] = body + async with httpx.AsyncClient(timeout=60.0, follow_redirects=True) as client: + response = await client.request( + operation["method"], + f"{base_url}{url}", + **request_kwargs, + ) + content_type = response.headers.get("content-type", "") + try: + payload: Any = response.json() if "json" in content_type else response.text + except ValueError: + payload = response.text + if response.status_code >= 400: + out = { + "ok": False, + "status_code": response.status_code, + "operation_id": operation_id, + "error": payload, + } + if response.status_code in {404, 405, 410, 422}: + out["stale_openapi_hint"] = ( + "This generated OpenAPI agent may be stale. Ask the user " + "whether they want to refresh it from the latest OpenAPI spec." + ) + return out + return { + "ok": True, + "status_code": response.status_code, + "operation_id": operation_id, + "result": payload, + } + + def _request_parts( + self, + ctx: RunContext, + operation: dict[str, Any], + parameters: dict[str, Any], + ) -> tuple[str, dict[str, Any], dict[str, str]]: + path = operation["path"] + query: dict[str, Any] = {} + headers: dict[str, str] = {} + cookies: dict[str, Any] = {} + for param in operation.get("parameters") or []: + name = param["name"] + if name not in parameters: + if param.get("required"): + raise ValueError(f"missing required parameter {name!r}") + continue + value = parameters[name] + location = param["in"] + if location == "path": + path = path.replace("{" + name + "}", str(value)) + elif location == "query": + query[name] = value + elif location == "header": + headers[name] = str(value) + elif location == "cookie": + cookies[name] = value + unresolved = PATH_PARAMETER_RE.findall(path) + if unresolved: + missing = ", ".join(sorted(set(unresolved))) + raise ValueError("missing required path parameter(s): " + missing) + if cookies: + headers["cookie"] = "; ".join(f"{key}={value}" for key, value in cookies.items()) + auth_headers, auth_query = self._auth_for_operation(ctx, operation) + headers.update(auth_headers) + query.update(auth_query) + return path, query, headers + + def _auth_for_operation(self, ctx: RunContext, operation: dict[str, Any]) -> tuple[dict[str, str], dict[str, Any]]: + requirements = operation.get("security") + if requirements is None: + requirements = ROOT_SECURITY + if requirements == []: + return {}, {} + missing: list[str] = [] + for requirement in requirements or []: + if not isinstance(requirement, dict) or not requirement: + return {}, {} + headers: dict[str, str] = {} + query: dict[str, Any] = {} + ok = True + for scheme_name in requirement: + mapping = SECURITY_FIELDS.get(scheme_name) or {} + secret_name = mapping.get("field") + value = _consumer_secret_optional(ctx, secret_name) if secret_name else "" + if not value: + ok = False + if secret_name: + missing.append(secret_name) + continue + kind = mapping.get("kind") + if kind == "apiKey": + prefix = mapping.get("prefix") or "" + sent_value = f"{prefix}{value}" + if mapping.get("location") == "query": + query[mapping.get("name") or scheme_name] = sent_value + else: + headers[mapping.get("name") or scheme_name] = sent_value + elif kind in {"http", "oauth2"}: + scheme = mapping.get("scheme") or "Bearer" + if scheme.lower() == "basic": + token = base64.b64encode(value.encode("utf-8")).decode("ascii") + headers["authorization"] = f"Basic {token}" + else: + headers["authorization"] = f"{scheme} {value}" + else: + ok = False + if ok: + return headers, query + if missing: + raise ConsumerSetupMissing( + "operation requires consumer setup secret(s): " + + ", ".join(sorted(set(missing))) + ) + return {}, {} + + +def _consumer_secret_optional(ctx: RunContext, name: str | None) -> str: + if not name: + return "" + try: + return ctx.consumer_secret(name) + except ConsumerSetupMissing: + return "" + + +def _runtime_skills_root(ctx: RunContext) -> str: + workspace = getattr(ctx, "_workspace", None) + prefixes = tuple(getattr(workspace, "write_prefixes", ()) or ()) + if not prefixes: + outputs_prefix = getattr(workspace, "outputs_prefix", None) + prefixes = (outputs_prefix or "outputs/",) + prefix = str(prefixes[0]).strip("/") + return f"/{prefix}/{RUNTIME_SKILLS_DIR}" if prefix else f"/{RUNTIME_SKILLS_DIR}" + + +def _seed_runtime_skills(backend: Any, ctx: RunContext) -> str: + if not SOURCE_SKILLS_DIR.exists(): + return "" + runtime_root = _runtime_skills_root(ctx) + uploads: list[tuple[str, bytes]] = [] + for path in SOURCE_SKILLS_DIR.rglob("*"): + if not path.is_file(): + continue + rel = path.relative_to(SOURCE_SKILLS_DIR).as_posix() + uploads.append((runtime_root + rel, path.read_bytes())) + if not uploads: + return "" + backend.upload_files(uploads) + return runtime_root + + +def _message_text(message: Any) -> Any: + content = getattr(message, "content", message) + return content + + +def _message_to_dict(message: Any) -> dict[str, Any]: + if isinstance(message, BaseMessage): + return message.model_dump(mode="json") + if hasattr(message, "model_dump"): + return message.model_dump(mode="json") + if isinstance(message, dict): + return message + return {"content": str(message)} + + +agent = OktaManagementOpenapiAgent() diff --git a/openapi.json b/openapi.json new file mode 100644 index 0000000..09cd62f --- /dev/null +++ b/openapi.json @@ -0,0 +1,129716 @@ +{ + "components": { + "examples": { + "APIDevicesListAllResponse": { + "summary": "List all devices with embedded users", + "value": [ + { + "_embedded": { + "users": [] + }, + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g4/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PATCH", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g4" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g4/users" + } + }, + "created": "2019-10-02T18:03:07.000Z", + "id": "guo4a5u7YAHhjXrMK0g4", + "lastUpdated": "2019-10-02T18:03:07.000Z", + "profile": { + "diskEncryptionType": "ALL_INTERNAL_VOLUMES", + "displayName": "Example device name 1", + "platform": "WINDOWS", + "registered": true, + "secureHardwarePresent": false, + "serialNumber": "XXDDRFCFRGF3M8MD6D", + "sid": "S-1-11-111" + }, + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "Example device name 1" + }, + "resourceId": "guo4a5u7YAHhjXrMK0g4", + "resourceType": "UDDevice", + "status": "CREATED" + }, + { + "_embedded": { + "users": [ + { + "created": "2021-10-01T16:52:41.000Z", + "managementStatus": "MANAGED", + "screenLockType": "BIOMETRIC", + "user": { + "_links": { + "changePassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/credentials/change_password" + }, + "changeRecoveryQuestion": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/credentials/change_recovery_question", + "method": "POST" + }, + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/deactivate" + }, + "expirePassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/expire_password", + "method": "POST" + }, + "forgotPassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/credentials/forgot_password", + "method": "POST" + }, + "resetPassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/reset_password", + "method": "POST" + }, + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/osc7ut9Uu76oHVUZc0w4" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7" + }, + "suspend": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/suspend", + "method": "POST" + }, + "type": { + "href": "https://{yourOktaDomain}/api/v1/meta/types/user/oty7ut9Uu76oHVUZc0w4" + } + }, + "activated": "2020-08-12T06:46:50.000Z", + "created": "2020-08-12T06:46:50.000Z", + "credentials": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + }, + "recovery_question": { + "question": "What is the food you least liked as a child?" + } + }, + "id": "00u17vh0q8ov8IU881d7", + "lastLogin": "2021-10-14T09:04:48.000Z", + "lastUpdated": "2021-01-27T21:05:32.000Z", + "passwordChanged": "2020-08-12T06:46:50.000Z", + "profile": { + "email": "email@email.com", + "firstName": "fname", + "lastName": "lname", + "login": "email@email.com", + "mobilePhone": null, + "secondEmail": null + }, + "status": "ACTIVE", + "statusChanged": "2021-01-27T21:05:32.000Z", + "type": { + "id": "oty7ut9Uu76oHVUZc0w4" + } + } + } + ] + }, + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g5/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PATCH", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g5" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g5/users" + } + }, + "created": "2023-06-21T23:24:02.000Z", + "id": "guo4a5u7YAHhjXrMK0g5", + "lastUpdated": "2023-06-21T23:24:02.000Z", + "profile": { + "diskEncryptionType": "USER", + "displayName": "Example device name 2", + "manufacturer": "Google", + "model": "Pixel 6", + "osVersion": "13:2023-05-05", + "platform": "ANDROID", + "registered": true, + "secureHardwarePresent": true + }, + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "Example device name 2" + }, + "resourceId": "guo4a5u7YAHhjXrMK0g5", + "resourceType": "UDDevice", + "status": "ACTIVE" + } + ] + }, + "APIDevicesListAllUserSummaryResponse": { + "summary": "List all devices with embedded user summaries", + "value": [ + { + "_embedded": { + "users": [] + }, + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g4/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PATCH", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g4" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g4/users" + } + }, + "created": "2019-10-02T18:03:07.000Z", + "id": "guo4a5u7YAHhjXrMK0g4", + "lastUpdated": "2019-10-02T18:03:07.000Z", + "profile": { + "diskEncryptionType": "ALL_INTERNAL_VOLUMES", + "displayName": "Example device name 1", + "platform": "WINDOWS", + "registered": true, + "secureHardwarePresent": false, + "serialNumber": "XXDDRFCFRGF3M8MD6D", + "sid": "S-1-11-111" + }, + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "Example device name 1" + }, + "resourceId": "guo4a5u7YAHhjXrMK0g4", + "resourceType": "UDDevice", + "status": "CREATED" + }, + { + "_embedded": { + "users": [ + { + "created": "2021-10-01T16:52:41.000Z", + "managementStatus": "MANAGED", + "screenLockType": "BIOMETRIC", + "user": { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7" + } + }, + "id": "00u17vh0q8ov8IU881d7", + "profile": { + "email": "email@email.com", + "firstName": "fname", + "lastName": "lname", + "login": "email@email.com" + }, + "realmId": "00u17vh0q8ov8IU8T0g5" + } + } + ] + }, + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g5/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PATCH", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g5" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7YAHhjXrMK0g5/users" + } + }, + "created": "2023-06-21T23:24:02.000Z", + "id": "guo4a5u7YAHhjXrMK0g5", + "lastUpdated": "2023-06-21T23:24:02.000Z", + "profile": { + "diskEncryptionType": "USER", + "displayName": "Example device name 2", + "manufacturer": "Google", + "model": "Pixel 6", + "osVersion": "13:2023-05-05", + "platform": "ANDROID", + "registered": true, + "secureHardwarePresent": true + }, + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "Example device name 2" + }, + "resourceId": "guo4a5u7YAHhjXrMK0g5", + "resourceType": "UDDevice", + "status": "ACTIVE" + } + ] + }, + "APIDevicesListAllUsersResponse": { + "summary": "Response example", + "value": [ + { + "created": "2021-08-20T17:13:35.000Z", + "managementStatus": "NOT_MANAGED", + "screenLockType": "BIOMETRIC", + "user": { + "_links": { + "changePassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/credentials/change_password", + "method": "POST" + }, + "changeRecoveryQuestion": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/credentials/change_recovery_question", + "method": "POST" + }, + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/deactivate", + "method": "POST" + }, + "expirePassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/expire_password", + "method": "POST" + }, + "forgotPassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/credentials/forgot_password", + "method": "POST" + }, + "resetFactors": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/reset_factors", + "method": "POST" + }, + "resetPassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/reset_password", + "method": "POST" + }, + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/osc17vh0n2EHVnbYF1d7" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7" + }, + "suspend": { + "href": "https://{yourOktaDomain}/api/v1/users/00u17vh0q8ov8IU881d7/lifecycle/suspend", + "method": "POST" + }, + "type": { + "href": "https://{yourOktaDomain}/api/v1/meta/types/user/oty17vh0n2EHVnbYF1d7" + } + }, + "activated": null, + "created": "2021-08-20T16:08:25.000Z", + "credentials": { + "password": null, + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00u17vh0q8ov8IU881d7", + "lastLogin": "2023-04-18T17:54:12.000Z", + "lastUpdated": "2021-12-20T18:27:30.000Z", + "passwordChanged": "2021-12-20T18:27:30.000Z", + "profile": { + "email": "bunk.moreland@example.com", + "firstName": "Bunk", + "lastName": "Moreland", + "login": "bunk.moreland@example.com", + "mobilePhone": null, + "secondEmail": null + }, + "status": "ACTIVE", + "statusChanged": "2021-08-20T16:39:41.000Z", + "type": { + "id": "oty17vh0n2EHVnbYF1d7" + } + } + } + ] + }, + "APIPushProvidersListAllResponse": { + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/push-providers/{pushProviderId}" + } + }, + "configuration": { + "fileName": "fileName.p8", + "keyId": "ABC123DEFG", + "teamId": "DEF123GHIJ" + }, + "id": "ppchvbeucdTgqeiGxR0g4", + "lastUpdatedDate": "2022-01-00T00:00:00.000Z", + "name": "Example Push Provider 1", + "providerType": "APNS" + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/push-providers/{pushProviderId}" + } + }, + "configuration": { + "fileName": "fileName.json", + "projectId": "PROJECT_ID" + }, + "id": "ppctekcmngGaqeiBxB0g4", + "lastUpdatedDate": "2022-01-00T00:00:00.000Z", + "name": "Example Push Provider 2", + "providerType": "FCM" + } + ] + }, + "APIServiceIntegrationInstanceSecretListResponse": { + "summary": "Secrets list response example", + "value": [ + { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4" + } + }, + "client_secret": "***DhOW", + "created": "2023-02-21T20:08:24.000Z", + "id": "ocs2f4zrZbs8nUa7p0g4", + "lastUpdated": "2023-02-21T20:08:24.000Z", + "secret_hash": "yk4SVx4sUWVJVbHt6M-UPA", + "status": "INACTIVE" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate" + } + }, + "client_secret": "***MQGQ", + "created": "2023-04-06T21:32:33.000Z", + "id": "ocs2f50kZB0cITmYU0g4", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "secret_hash": "0WOOvBSzV9clc4Nr7Rbaug", + "status": "ACTIVE" + } + ] + }, + "APIServiceIntegrationListResponse": { + "summary": "List response example", + "value": [ + { + "_links": { + "client": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oa72lrepvp4WqEET1d9" + }, + "logo": { + "href": "https://{logoDomain}/{logoPath}/my_app_cie_small_logo", + "name": "small" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa72lrepvp4WqEET1d9" + } + }, + "configGuideUrl": "https://{docDomain}/my-app-cie/configuration-guide", + "createdAt": "2023-02-21T20:08:24.000Z", + "createdBy": "00uu3u0ujW1P6AfZC2d5", + "grantedScopes": [ + "okta.logs.read", + "okta.groups.read", + "okta.users.read" + ], + "id": "0oa72lrepvp4WqEET1d9", + "name": "My App Cloud Identity Engine", + "type": "my_app_cie" + } + ] + }, + "APIServiceIntegrationResponse": { + "summary": "Response example", + "value": { + "_links": { + "client": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oa72lrepvp4WqEET1d9" + }, + "logo": { + "href": "https://{logoDomain}/{logoPath}/my_app_cie_small_logo", + "name": "small" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa72lrepvp4WqEET1d9" + } + }, + "configGuideUrl": "https://{docDomain}/my-app-cie/configuration-guide", + "createdAt": "2023-02-21T20:08:24.000Z", + "createdBy": "00uu3u0ujW1P6AfZC2d5", + "grantedScopes": [ + "okta.logs.read", + "okta.groups.read", + "okta.users.read" + ], + "id": "0oa72lrepvp4WqEET1d9", + "name": "My App Cloud Identity Engine", + "type": "my_app_cie" + } + }, + "APIServiceWithPropertiesIntegrationResponse": { + "summary": "Response example with app properties", + "value": { + "_links": { + "client": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oa72lrepvp4WqEET1d9" + }, + "logo": { + "href": "https://{logoDomain}/{logoPath}/my_app_cie_small_logo", + "name": "small" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa72lrepvp4WqEET1d9" + } + }, + "configGuideUrl": "https://{docDomain}/my-app-cie/configuration-guide", + "createdAt": "2023-02-21T20:08:24.000Z", + "createdBy": "00uu3u0ujW1P6AfZC2d5", + "grantedScopes": [ + "okta.logs.read", + "okta.groups.read", + "okta.users.read" + ], + "id": "0oa72lrepvp4WqEET1d9", + "name": "My App Cloud Identity Engine", + "properties": { + "baseUrl": "https://example.com", + "orgId": "42" + }, + "type": "my_app_cie" + }, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "APIUserListDevicesResponse": { + "value": [ + { + "created": "2020-11-03T21:47:01.000Z", + "device": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PATCH", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4" + }, + "suspend": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/suspend" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/users" + } + }, + "created": "2020-11-03T21:47:01.000Z", + "id": "guo8jx5vVoxfvJeLb0w4", + "lastUpdated": "2020-11-03T23:46:27.000Z", + "profile": { + "diskEncryptionType": "NONE", + "displayName": "DESKTOP-EHAD3IE", + "manufacturer": "International Corp", + "model": "VMware7,1", + "osVersion": "10.0.18362", + "platform": "WINDOWS", + "registered": true, + "secureHardwarePresent": false, + "serialNumber": "56 4d 4f 95 74 c5 d3 e7-fc 3a 57 9c c2 f8 5d ce", + "sid": "S-1-5-21-3992267483-1860856704-2413701314-500", + "udid": "954F4D56-C574-E7D3-FC3A-579CC2F85DCE" + }, + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "DESKTOP-EHAD3IE" + }, + "resourceId": "guo8jx5vVoxfvJeLb0w4", + "resourceType": "UDDevice", + "status": "ACTIVE" + }, + "deviceUserId": "lnk46w61OLJz1uSQW0g4" + } + ] + }, + "ActivateFactorCallResponse": { + "summary": "call", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/clf1o51EADOTFXHHBXBP" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/clf1o51EADOTFXHHBXBP/verify" + } + }, + "created": "2014-08-06T16:56:31.000Z", + "factorType": "call", + "id": "clf1o51EADOTFXHHBXBP", + "lastUpdated": "2014-08-06T16:56:31.000Z", + "profile": { + "phoneExtension": "1234", + "phoneNumber": "+1-555-415-1337" + }, + "provider": "OKTA", + "status": "ACTIVE", + "vendorName": "OKTA" + } + }, + "ActivateFactorEmailResponse": { + "summary": "email", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3/verify" + } + }, + "factorType": "email", + "id": "emfnf3gSScB8xXoXK0g3", + "profile": { + "email": "changed@clouditude.net" + }, + "provider": "OKTA", + "status": "ACTIVE", + "vendorName": "OKTA" + } + }, + "ActivateFactorPushResponse": { + "summary": "push", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opf3hkfocI4JTLAju0g4" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opf3hkfocI4JTLAju0g4/verify" + } + }, + "created": "2015-03-16T18:01:28.000Z", + "factorType": "push", + "id": "opf3hkfocI4JTLAju0g4", + "lastUpdated": "2015-08-27T14:25:17.000Z", + "profile": { + "credentialId": "dade.murphy@example.com", + "deviceType": "SmartPhone_IPhone", + "name": "Gibson", + "platform": "IOS", + "version": "9.0" + }, + "provider": "OKTA", + "status": "ACTIVE", + "vendorName": "OKTA" + } + }, + "ActivateFactorSmsResponse": { + "summary": "sms", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/sms1o51EADOTFXHHBXBP" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/sms1o51EADOTFXHHBXBP/verify" + } + }, + "created": "2014-08-06T16:56:31.000Z", + "factorType": "sms", + "id": "sms1o51EADOTFXHHBXBP", + "lastUpdated": "2014-08-06T16:56:31.000Z", + "profile": { + "phoneNumber": "+1-555-415-1337" + }, + "provider": "OKTA", + "status": "ACTIVE", + "vendorName": "OKTA" + } + }, + "ActivateFactorTotpResponse": { + "summary": "token:software:totp", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG/verify" + } + }, + "created": "2014-07-16T16:13:56.000Z", + "factorType": "token:software:totp", + "id": "ostf1fmaMGJLMNGNLIVG", + "lastUpdated": "2014-08-06T00:31:07.000Z", + "profile": { + "credentialId": "dade.murphy@example.com" + }, + "provider": "OKTA", + "status": "ACTIVE", + "vendorName": "OKTA" + } + }, + "ActivateFactorU2fRequest": { + "summary": "u2f", + "value": { + "clientData": "eyJ0eXAiOiJuYXZpZ2F0b3IuaWQuZmluaXNoRW5yb2xsbWVudCIsImNoYWxsZW5nZSI6IlhxR0h0RTBoUkxuVEoxYUF5U1oyIiwib3JpZ2luIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6MzAwMCIsImNpZF9wdWJrZXkiOiJ1bnVzZWQifQ", + "registrationData": "BQTEMUyOM8h1TiZG4DL-RdMr-tYgTYSf62Y52AmwEFTiSYWIRVO5L-MwWdRJOthmV3J3JrqpmGfmFb820-awx1YIQFlTvkMhxItHlpkzahEqicpw7SIH9yMfTn2kaDcC6JaLKPfV5ds0vzuxF1JJj3gCM01bRC-HWI4nCVgc-zaaoRgwggEcMIHDoAMCAQICCwD52fCSMoNczORdMAoGCCqGSM49BAMCMBUxEzARBgNVBAMTClUyRiBJc3N1ZXIwGhcLMDAwMTAxMDAwMFoXCzAwMDEwMTAwMDBaMBUxEzARBgNVBAMTClUyRiBEZXZpY2UwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAAQFKJupuUgPQcRHUphaW5JPfLvkkwlEwlHKk_ntSp7MS4aTHJyGnpziqncrjiTC_oUVtb-wN-y_t_IMIjueGkhxMAoGCCqGSM49BAMCA0gAMEUCIQDBo6aOLxanIUYnBX9iu3KMngPnobpi0EZSTkVtLC8_cwIgC1945RGqGBKfbyNtkhMifZK05n7fU-gW37Bdnci5D94wRQIhAJv3VvclbRkHAQhaUR8rr8qFTg9iF-GtHoXU95vWaQdyAiAbEr-440U4dQAZF-Sj8G2fxgh5DkgkkWpyUHZhz7N9ew" + } + }, + "ActivateFactorU2fResponse": { + "summary": "u2f", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fuf2rovRxogXJ0nDy0g4" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fuf2rovRxogXJ0nDy0g4/verify" + } + }, + "created": "2018-05-24T20:43:19.000Z", + "factorType": "u2f", + "id": "fuf2rovRxogXJ0nDy0g4", + "lastUpdated": "2018-05-24T21:43:32.000Z", + "profile": { + "credentialId": "WVO-QyHEi0eWmTNqESqJynDtIgf3Ix9OfaRoNwLoloso99Xl2zS_O7EXUkmPeAIzTVtEL4dYjicJWBz7NpqhGA", + "version": "U2F_V2" + }, + "provider": "FIDO", + "status": "ACTIVE", + "vendorName": "FIDO" + } + }, + "ActivateFactorWebauthnRequest": { + "summary": "webAuthn", + "value": { + "attestation": "o2NmbXRmcGFja2VkZ2F0dFN0bXSiY2FsZyZjc2lnWEgwRgIhAMvf2+dzXlHZN1um38Y8aFzrKvX0k5dt/hnDu9lahbR4AiEAuwtMg3IoaElWMp00QrP/+3Po/6LwXfmYQVfsnsQ+da1oYXV0aERhdGFYxkgb9OHGifjS2dG03qLRqvXrDIRyfGAuc+GzF1z20/eVRV2wvl6tzgACNbzGCmSLCyXx8FUDAEIBvWNHOcE3QDUkDP/HB1kRbrIOoZ1dR874ZaGbMuvaSVHVWN2kfNiO4D+HlAzUEFaqlNi5FPqKw+mF8f0XwdpEBlClAQIDJiABIVgg0a6oo3W0JdYPu6+eBrbr0WyB3uJLI3ODVgDfQnpgafgiWCB4fFo/5iiVrFhB8pNH2tbBtKewyAHuDkRolcCnVaCcmQ==", + "clientData": "eyJjaGFsbGVuZ2UiOiJVSk5wYW9sVWt0dF9vcEZPNXJMYyIsIm9yaWdpbiI6Imh0dHBzOi8vcmFpbi5va3RhMS5jb20iLCJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIn0=" + } + }, + "ActivateFactorWebauthnResponse": { + "summary": "webAuthn", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fwf2rovRxogXJ0nDy0g4" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fwf2rovRxogXJ0nDy0g4/verify" + } + }, + "created": "2018-05-24T20:43:19.000Z", + "factorType": "webauthn", + "id": "fwf2rovRxogXJ0nDy0g4", + "lastUpdated": "2018-05-24T21:43:32.000Z", + "profile": { + "authenticatorName": "MacBook Touch ID", + "credentialId": "l3Br0n-7H3g047NqESqJynFtIgf3Ix9OfaRoNwLoloso99Xl2zS_O7EXUkmPeAIzTVtEL4dYjicJWBz7NpqhGA" + }, + "provider": "FIDO", + "status": "ACTIVE", + "vendorName": "FIDO" + } + }, + "ActivateIdPResponse": { + "summary": "Activate an IdP", + "value": { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62bfdiumsUndnZ0h7&\n client_id={clientId}&response_type={responseType}&response_mode={responseMode}&\n scope={scopes}&redirect_uri={redirectUri}&state={state}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2016-03-24T23:21:49.000Z", + "id": "0oa62bfdiumsUndnZ0h7", + "lastUpdated": "2016-03-25T19:14:23.000Z", + "name": "Google", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.email" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://accounts.google.com/o/oauth2/auth" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://www.googleapis.com/oauth2/v3/token" + } + }, + "scopes": [ + "profile", + "email", + "openid" + ], + "type": "OIDC" + }, + "status": "ACTIVE", + "type": "GOOGLE" + } + }, + "ActivateNetworkZone": { + "summary": "Activated network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3" + } + }, + "created": "2021-06-24T20:37:32.000Z", + "gateways": [ + { + "type": "CIDR", + "value": "1.2.3.4/24" + } + ], + "id": "nzowc1U5Jh5xuAK0o0g3", + "lastUpdated": "2021-06-24T20:37:32.000Z", + "name": "MyIpZone", + "proxies": [ + { + "type": "RANGE", + "value": "3.3.4.5-3.3.4.15" + } + ], + "status": "ACTIVE", + "system": false, + "type": "IP", + "usage": "POLICY" + } + }, + "ActiveAuthorizationServerKey": { + "summary": "Active authorization server key", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc" + } + }, + "alg": "RS256", + "e": "AQAB", + "kid": "RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc", + "kty": "RSA", + "n": "g0MirhrysJMPm_wK45jvMbbyanfhl-jmTBv0o69GeifPaISaXGv8LKn3-CyJvUJcjjeHE17KtumJWVxUDRzFqtIMZ1ctCZyIAuWO0n LKilg7_EIDXJrS8k14biqkPO1lXGFwtjo3zLHeFSLw6sWf-CEN9zv6Ff3IAXb-RMYpfh-bVrxIgWsWCxjLW-UKI3la-gs0nWHH2PJr5HLJuI JIOL5HLJuIJIOLWahqTnm_r1LSCSYr6N4C-fh--w2_BW8DzTHalBYe76bNr0d7AqtR4tGazmrvrc79Wa2bjyxmhhN1u9jSaZQqq-3VZEod8q3, WHH2PJ5v1LoXniJQ4a2W8nDVqb6h4E8MUKYOpljTfQ", + "status": "ACTIVE", + "use": "sig" + } + }, + "ActiveIdPSigningKeyCredentialResponse": { + "summary": "IdP active signing key credential", + "value": [ + { + "created": "2025-04-14T16:29:59.000Z", + "e": "AQAB", + "expiresAt": "2035-04-14T16:29:59.000Z", + "kid": "your-key-id", + "kty": "RSA", + "lastUpdated": "2025-04-14T16:29:59.000Z", + "n": "wdmW7pNqxzmlrsWbHq6rQJDiMu4T344AKEzQ1jGffyCLCU-HKk5WqIVtQ4EJ5FU3Rk6kNeoTdkQbxn7t2QFj37ScHZkxXDbNEhFbZpvGh7-rYBG7TCnk8jO9ct_bpT-PCLCgC9L_67H2eCXXN-_gFVZAx7KEibb4NgUET2p34b5scGI2LwEefS-z8UBGlNkg9+SmI9PvjMXplFKazb6qlb27fp0PSfC4S5g8kOCqEGC9oNOCBHO5jyzlzcFq04AIaAX9N1X13UULrj-262O1-RCnQNTadbdrO6FXwfQ6lsLmvWCFBVzLTqxYxCGNY85lhAH1zjoEvXnInKYgnvmcuw", + "use": "sig", + "x5c": [ + "MIIDmDCCAoCgAwIBAgIGAZY1ItxEMA0GCSqGSIb3DQEBCwUAMIGMMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxDTALBgNVBAMMBHJhaW4xHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjUwNDE0MTYyODU5WhcNMzUwNDE0MTYyOTU5WjCBjDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMQ0wCwYDVQQDDARyYWluMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwdmW7pNqxzmlrsWbHq6rQJDiMu4T344AKEzQ1jGffyCLCU+HKk5WqIVtQ4EJ5FU3Rk6kNeoTdkQbxn7t2QFj37ScHZkxXDbNEhFbZpvGh7+rYBG7TCnk8jO9ct/bpT+PCLCgC9L/67H2eCXXN+/gFVZAx7KEibb4NgUET2p34b5scGI2LwEefS+z8UBGlNkg9+SmI9PvjMXplFKazb6qlb27fp0PSfC4S5g8kOCqEGC9oNOCBHO5jyzlzcFq04AIaAX9N1X13UULrj+262O1+RCnQNTadbdrO6FXwfQ6lsLmvWCFBVzLTqxYxCGNY85lhAH1zjoEvXnInKYgnvmcuwIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQCXAU2SAJeWoQKz32ShqIwt2ESJS+IoIc+daB/e8mEPUoOgYscjdoUaWBsqXG7RizxrYNub0PXMb90f6Xdk5R4QjB/WqkR/+iupLfIxS1CbTNIzxudY2sfkSC0w8NOq77v4nE786NWDOlOaOOTn/aGLc57rBqwz6spQzNkabtAPw7umm7MpJBJ1K7yNAlwkoRTCM7rsxCvzjGf4OFe+1MaV0MlEr76wkIs6SqGodzPFFnbl2GzKf7NlL0FAdjWsJP9560b8MybAhHpXiQx8AsNW2Ggjvo2ejQKB3Yw/BaHLfcjgij/lcumfQD/P8Pox4trjSuQoRkKXxfdQvlnS9pB7" + ], + "x5t#S256": "pX0kpGWPotMaEqqtIoOH9L-sFBa-htNFu0MZiJz1Hi4" + } + ] + }, + "AddMappingBody": { + "summary": "Update an existing profile mapping by adding one or more properties", + "value": { + "properties": { + "fullName": { + "expression": "user.firstName + user.lastName", + "pushStatus": "PUSH" + }, + "nickName": { + "expression": "user.nickName", + "pushStatus": "PUSH" + } + } + } + }, + "AddMappingResponse": { + "summary": "Update an existing profile mapping by adding one or more properties", + "value": { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/mappings/prm1k48weFSOnEUnw0g4" + } + }, + "id": "prm1k47ghydIQOTBW0g4", + "properties": { + "fullName": { + "expression": "user.firstName + user.lastName", + "pushStatus": "PUSH" + }, + "nickName": { + "expression": "user.nickName", + "pushStatus": "PUSH" + } + }, + "source": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscsbePhQ3yqt4cVv0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/types/user/otysbePhQ3yqt4cVv0g3" + } + }, + "id": "otysbePhQ3yqt4cVv0g3", + "name": "user", + "type": "user" + }, + "target": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/apps/0oa1qmn4LZQQEH0wZ0g4/default" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1qmn4LZQQEH0wZ0g4" + } + }, + "id": "0oa1qmn4LZQQEH0wZ0g4", + "name": "okta_org2org", + "type": "appuser" + } + } + }, + "AddOAuth2ResourceServerJsonWebKeyRequest": { + "summary": "JSON Web Key request example", + "value": { + "e": "AQAB", + "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", + "status": "INACTIVE", + "use": "enc" + } + }, + "AdminConsoleSettingsExample": { + "summary": "Default Okta Admin Console settings", + "value": { + "sessionIdleTimeoutMinutes": 15, + "sessionMaxLifetimeMinutes": 720 + } + }, + "AerialConsentDetails": { + "description": "Example response of consent details", + "value": { + "accountId": "0200bs0617vvhv2v675mch1cukp", + "grantDate": "2023-04-06T21:32:33.000Z", + "grantedBy": "00uabcdefg1234567890" + } + }, + "AerialConsentInvalidAccountIdResponse": { + "description": "Aerial account ID is invalid", + "value": { + "errorCauses": [ + { + "errorSummary": "Invalid aerial account ID." + } + ], + "errorCode": "E0000001", + "errorId": "oaewjePjfdBT7m71KkPz0Ipaw", + "errorLink": "E0000001", + "errorSummary": "API validation failed: account" + } + }, + "AerialConsentOrgAlreadyLinkedResponse": { + "description": "The revoke operation isn't possible when the org is already linked", + "value": { + "errorCauses": [ + { + "errorSummary": "The org is already linked to an Account." + } + ], + "errorCode": "E0000001", + "errorId": "oae_wheRkaxRT-EFAXwBmBKLg", + "errorLink": "E0000001", + "errorSummary": "API validation failed: account" + } + }, + "AerialGrantAlreadyPresentErrorResponse": { + "description": "Grant is already present", + "value": { + "errorCauses": [ + { + "errorSummary": "The org already has a consent grant added to Aerial." + } + ], + "errorCode": "E0000001", + "errorId": "oaewjePjfdBT7m71KkPz0Ipaw", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: account" + } + }, + "AerialGrantNotFoundResponse": { + "description": "No grant found for org", + "value": { + "errorCauses": [], + "errorCode": "E0000007", + "errorId": "sampleFYH_dTSSTdpPYIAdHJw", + "errorLink": "E0000007", + "errorSummary": "Not found: Resource not found: grant (String)" + } + }, + "AllAssignmentsOperationResponse": { + "value": { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/operations/rre4mje4ez7B2a7B60g7", + "method": "GET", + "rel": "self" + } + }, + "assignmentOperation": { + "configuration": { + "id": "ALL", + "name": "All Assignments" + } + }, + "completed": "2023-10-25T21:02:54.000Z", + "created": "2023-10-25T21:02:54.000Z", + "id": "rre4mje4ez7B2a7B60g7", + "numUserMoved": 50, + "started": "2023-10-25T21:02:54.000Z", + "status": "COMPLETED", + "type": "realm:assignment" + } + }, + "AllCustomAAGUIDResponse": { + "summary": "List of custom AAGUIDs", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "PATCH", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/aaguids/cb69481e-8ff7-4039-93ec-0a272911111" + } + }, + "aaguid": "cb69481e-8ff7-4039-93ec-0a272911111", + "attestationRootCertificates": [ + { + "exp": "2035-05-26T16:04:58.000Z", + "iss": "Yubico U2F Root CA Serial 457200631", + "x5c": "X5C...", + "x5t#S256": "SHA-256 x5t of the X.509 root certificate" + } + ], + "authenticatorCharacteristics": { + "fipsCompliant": false, + "hardwareProtected": false, + "platformAttached": false + }, + "name": "My Security Key" + } + ] + }, + "AllowOktaSupportAccessStatus": { + "summary": "Allow Okta Support access", + "value": { + "caseNumber": "1011001", + "impersonation": { + "expiration": "2024-01-24T11:13:14.000Z", + "status": "ENABLED" + } + } + }, + "AllowOktaSupportAccessStatusRequest": { + "summary": "Allow Okta Support access", + "value": { + "impersonation": { + "status": "ENABLED" + } + } + }, + "AllowSelfAssigned": { + "summary": "Allow self-assigned Okta Support cases", + "value": { + "caseNumber": "1011001", + "selfAssigned": { + "status": "APPROVED" + } + } + }, + "AllowSelfAssignedRequest": { + "summary": "Allow self-assigned Okta Support cases", + "value": { + "selfAssigned": { + "status": "APPROVED" + } + } + }, + "ApiServiceExample": { + "summary": "API Service Configuration example", + "value": { + "authenticationMethod": "client_secret_basic", + "scopes": [ + "okta.users.manage", + "okta.groups.read" + ], + "setupInstructionsUri": "https://doc.example.com/api-service-setup" + } + }, + "ApiTokenListMetadataResponse": { + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/api-tokens/00Tabcdefg1234567890" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00uabcdefg1234567890" + } + }, + "clientName": "Okta API", + "created": "2021-11-09T20:38:10.000Z", + "expiresAt": "2021-12-11T20:38:10.000Z", + "id": "00Tabcdefg1234567890", + "lastUpdated": "2021-11-11T20:38:10.000Z", + "name": "My API Token", + "network": { + "connection": "ANYWHERE" + }, + "tokenWindow": "P30D", + "userId": "00uabcdefg1234567890" + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/api-tokens/00T1234567890abcdefg" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00uabcdefg1234567890" + } + }, + "clientName": "Okta API", + "created": "2021-11-09T20:38:10.000Z", + "expiresAt": "2021-11-11T20:43:10.000Z", + "id": "00T1234567890abcdefg", + "lastUpdated": "2021-11-11T20:38:10.000Z", + "name": "Another API Token", + "tokenWindow": "PT5M", + "userId": "00uabcdefg1234567890" + } + ] + }, + "ApiTokenMetadataResponse": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/api-tokens/00Tabcdefg1234567890" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00uXXXXXXXXXXXXXXXXX" + } + }, + "clientName": "Okta API", + "created": "2021-11-09T20:38:10.000Z", + "expiresAt": "2021-12-11T20:38:10.000Z", + "id": "00Tabcdefg1234567890", + "lastUpdated": "2021-11-11T20:38:10.000Z", + "name": "My API Token", + "network": { + "connection": "ANYWHERE" + }, + "tokenWindow": "P30D", + "userId": "00uXXXXXXXXXXXXXXXXX" + } + }, + "AppCsrJsonResponse": { + "summary": "CSR object in JSON format", + "value": { + "_links": { + "publish": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50/lifecycle/publish" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50" + } + }, + "created": "2017-03-28T01:11:10.000Z", + "csr": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9/tKvvbFN59T4raoCs/78KRm4fSefHQOv1TKLXo4wTLbsqYWRWc5u0sd5orUMQgPQOyj3i6qh13mALY4BzrT057EG1BUNjGg29QgYlnOk2iX890e5BIDMQQEIKFrvOi2V8cLUkLvE2ydRn0VO1Q1frbUkYeStJYC5Api2JQsYRwa+1ZeDH1ITnIzUaugWhW2WB2lSnwZkenne5KtffxMPYVu+IhNRHoKaRA6Z51YNhMJIx17JM2hs/H4Ka3drk6kzDf7ofk/yBpb9yBWyU7CTSQhdoHidxqFprMDaT66W928t3AeOENHBuwn8c2K9WeGG+bELNyQRJVmawIDAQABoCowKAYJKoZIhvcNAQkOMRswGTAXBgNVHREEEDAOggxkZXYub2t0YS5jb20wDQYJKoZIhvcNAQELBQADggEBAA2hsVJRVM+A83X9MekjTnIbt19UNT8wX7wlE9jUKirWsxceLiZBpVGn9qfKhhVIpvdaIRSeoFYS2Kg/m1G6bCvjmZLcrQ5FcEBjZH2NKfNppGVnfC2ugtUkBtCB+UUzOhKhRKJtGugenKbP33zRWWIqnd2waF6Cy8TIuqQVPbwEDN9bCbAs7ND6CFYNguY7KYjWzQOeAR716eqpEEXuPYAS4nx/ty4ylonR8cv+gpq51rvq80A4k/36aoeM0Y6I4w64vhTfuvWW2UYFUD+/+y2FA2CSP4JfctySrf1s525v6fzTFZ3qZbB5OZQtP2b8xYWktMzywsxGKDoVDB4wkH4=", + "id": "h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50", + "kty": "RSA" + } + }, + "AppCsrPkcs10Response": { + "summary": "CSR in DER format", + "value": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9" + }, + "AppFeatureListResponseEx": { + "summary": "List app feature response", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/features/USER_PROVISIONING" + } + }, + "capabilities": { + "create": { + "lifecycleCreate": { + "status": "DISABLED" + } + }, + "update": { + "lifecycleDeactivate": { + "status": "DISABLED" + }, + "password": { + "change": "KEEP_EXISTING", + "seed": "RANDOM", + "status": "DISABLED" + }, + "profile": { + "status": "DISABLED" + } + } + }, + "description": "User provisioning settings from Okta to a downstream application", + "name": "USER_PROVISIONING", + "status": "ENABLED" + } + ] + }, + "AppFeatureResponseEx": { + "summary": "App feature response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/features/USER_PROVISIONING" + } + }, + "capabilities": { + "create": { + "lifecycleCreate": { + "status": "DISABLED" + } + }, + "update": { + "lifecycleDeactivate": { + "status": "DISABLED" + }, + "password": { + "change": "KEEP_EXISTING", + "seed": "RANDOM", + "status": "DISABLED" + }, + "profile": { + "status": "DISABLED" + } + } + }, + "description": "User provisioning settings from Okta to a downstream application", + "name": "USER_PROVISIONING", + "status": "ENABLED" + } + }, + "AppGrantsEx": { + "summary": "App grants example", + "value": { + "_embedded": { + "scope": { + "id": "okta.users.read" + } + }, + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}", + "title": "Application name" + }, + "client": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/{clientId}", + "title": "Client name" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}/grants/oag91n9ruw3dsaXzP0h6" + } + }, + "clientId": "{clientId}", + "created": "2023-02-21T16:54:00.000Z", + "createdBy": { + "id": "00u6eltha0nrSc47i0h7", + "type": "User" + }, + "id": "oag91n9ruw3dsaXzP0h6", + "issuer": "{yourOktaDomain}", + "lastUpdated": "2023-02-21T16:54:00.000Z", + "scopeId": "okta.users.read", + "source": "ADMIN", + "status": "ACTIVE" + } + }, + "AppGrantsPostEx": { + "summary": "App grants example", + "value": { + "issuer": "{yourOktaDomain}", + "scopeId": "okta.users.read" + } + }, + "AppResponseBaseEx": { + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "id": "0oafxqCAJWWGELFTYASJ", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "status": "ACTIVE" + } + }, + "AppUserAssignProvRequest": { + "summary": "SSO and provisioning application user request example", + "value": { + "credentials": { + "userName": "saml.jackson@example.com" + }, + "id": "00u15s1KDETTQMQYABRL", + "profile": { + "profile": "Standard User", + "role": "Developer", + "salesforceGroups": [ + "Employee" + ] + }, + "scope": "USER" + } + }, + "AppUserAssignSSORequest": { + "summary": "SSO application user request example", + "value": { + "credentials": { + "userName": "rae.cloud@example.com" + }, + "id": "00ud4tVDDXYVKPXKVLCO", + "scope": "USER" + } + }, + "AppUserCredUpdateResponse": { + "summary": "Application user credential update", + "value": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00ud4tVDDXYVKPXKVLCO" + } + }, + "created": "2024-01-27T03:52:45.000Z", + "credentials\"": { + "password": {}, + "userName": "rae.cloud@example.com" + }, + "externalId": null, + "id": "00ud4tVDDXYVKPXKVLCO", + "lastUpdated": "2024-01-27T05:15:30.000Z", + "passwordChanged": "2024-01-27T05:15:30.000Z", + "profile": { + "birthdate": null, + "country": null, + "email": "rae.cloud@example.com", + "family_name": "Cloud", + "formatted": null, + "gender": null, + "given_name": "Rae", + "locale": "en_US", + "locality": null, + "middle_name": null, + "name": "Rae Cloud", + "nickname": null, + "phone_number": null, + "picture": null, + "postal_code": null, + "profile": null, + "region": null, + "street_address": null, + "website": null, + "zoneinfo": "America/Los_Angeles" + }, + "scope": "USER", + "status": "ACTIVE", + "statusChanged": "2024-01-27T03:52:45.000Z", + "syncState": "DISABLED" + } + }, + "AppUserListEx": { + "summary": "List application user example", + "value": [ + { + "_embedded": { + "user": { + "_links": { + "changePassword": { + "href": "https://rain.okta1.com/api/v1/users/00u1dnq5S0CfjlkpABCD/credentials/change_password", + "method": "POST" + }, + "changeRecoveryQuestion": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD/credentials/change_recovery_question", + "method": "POST" + }, + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD/lifecycle/deactivate", + "method": "POST" + }, + "expirePassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD/lifecycle/expire_password", + "method": "POST" + }, + "resetPassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD/lifecycle/reset_password", + "method": "POST" + }, + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscarho9g7PythoN23z9" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD" + }, + "suspend": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD/lifecycle/suspend", + "method": "POST" + }, + "type": { + "href": "https://{yourOktaDomain}/api/v1/meta/types/user/otyzhh29g7Python90g3" + } + }, + "activated": "2024-01-09T15:36:05.000Z", + "created": "2024-01-09T15:36:04.000Z", + "credentials": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00u1dnq5S0CfjlkpABCD", + "lastLogin": null, + "lastUpdated": "2024-01-09T15:36:05.000Z", + "passwordChanged": "2024-01-09T15:36:05.000Z", + "profile": { + "email": "saml.test@example.com", + "firstName": "Saml", + "lastName": "Test", + "login": "saml.test@example.com", + "mobilePhone": null, + "secondEmail": null + }, + "status": "ACTIVE", + "statusChanged": "2024-01-09T15:36:05.000Z", + "type": { + "id": "otyzhh29g7Python90g3" + } + } + }, + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oajiqIRNXPPJBNZMGYL" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD" + } + }, + "created": "2024-01-31T18:25:01.000Z", + "credentials": { + "userName": "saml.test@example.com" + }, + "externalId": "00u5edt3PNbbjzvIABCD", + "id": "00u1dnq5S0CfjlkpABCD", + "lastSync": "2024-01-31T18:25:03.000Z", + "lastUpdated": "2024-01-31T18:25:03.000Z", + "passwordChanged": null, + "profile": { + "displayName": "Saml O Test", + "email": "saml.test@example.com", + "firstName": "Saml", + "lastName": "Test", + "mobilePhone": null, + "profile": "Standard Platform User", + "role": "Tester", + "salesforceGroups": [], + "secondEmail": null, + "streetAddress": null + }, + "scope": "USER", + "status": "PROVISIONED", + "statusChanged": "2024-01-31T18:25:03.000Z", + "syncState": "SYNCHRONIZED" + } + ] + }, + "AppUserProfUpdateResponse": { + "summary": "Application user profile update", + "value": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00ud4tVDDXYVKPXKVLCO" + } + }, + "created": "2024-01-27T03:52:45.000Z", + "credentials\"": { + "userName": "rae.cloud@example.com" + }, + "externalId": null, + "id": "00ud4tVDDXYVKPXKVLCO", + "lastUpdated": "2024-01-27T05:05:32.000Z", + "passwordChanged": null, + "profile": { + "birthdate": null, + "country": null, + "email": "rae.cloud@example.com", + "family_name": "Cloud", + "formatted": null, + "gender": null, + "given_name": "Rae", + "locale": "en_US", + "locality": null, + "middle_name": "Mae", + "name": "Rae Mae Cloud", + "nickname": null, + "phone_number": null, + "picture": null, + "postal_code": null, + "profile": null, + "region": null, + "street_address": null, + "website": null, + "zoneinfo": "America/Los_Angeles" + }, + "scope": "USER", + "status": "ACTIVE", + "statusChanged": "2024-01-27T03:52:45.000Z", + "syncState": "DISABLED" + } + }, + "AppUserProvExpandResponse": { + "summary": "Application user expand example", + "value": { + "_embedded": { + "user": { + "_links": { + "changePassword": { + "href": "https://rain.okta1.com/api/v1/users/00u1dnq5S0CfjlkpABCD/credentials/change_password", + "method": "POST" + }, + "changeRecoveryQuestion": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD/credentials/change_recovery_question", + "method": "POST" + }, + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD/lifecycle/deactivate", + "method": "POST" + }, + "expirePassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD/lifecycle/expire_password", + "method": "POST" + }, + "resetPassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD/lifecycle/reset_password", + "method": "POST" + }, + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscarho9g7PythoN23z9" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD" + }, + "suspend": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD/lifecycle/suspend", + "method": "POST" + }, + "type": { + "href": "https://{yourOktaDomain}/api/v1/meta/types/user/otyzhh29g7Python90g3" + } + }, + "activated": "2024-01-09T15:36:05.000Z", + "created": "2024-01-09T15:36:04.000Z", + "credentials": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00u1dnq5S0CfjlkpABCD", + "lastLogin": null, + "lastUpdated": "2024-01-09T15:36:05.000Z", + "passwordChanged": "2024-01-09T15:36:05.000Z", + "profile": { + "email": "saml.test@example.com", + "firstName": "Saml", + "lastName": "Test", + "login": "saml.test@example.com", + "mobilePhone": null, + "secondEmail": null + }, + "status": "ACTIVE", + "statusChanged": "2024-01-09T15:36:05.000Z", + "type": { + "id": "otyzhh29g7Python90g3" + } + } + }, + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oajiqIRNXPPJBNZMGYL" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1dnq5S0CfjlkpABCD" + } + }, + "created": "2024-01-31T18:25:01.000Z", + "credentials": { + "userName": "saml.test@example.com" + }, + "externalId": "00u5edt3PNbbjzvIABCD", + "id": "00u1dnq5S0CfjlkpABCD", + "lastSync": "2024-01-31T18:25:03.000Z", + "lastUpdated": "2024-01-31T18:25:03.000Z", + "passwordChanged": null, + "profile": { + "displayName": "Saml O Test", + "email": "saml.test@example.com", + "firstName": "Saml", + "lastName": "Test", + "mobilePhone": null, + "profile": "Standard Platform User", + "role": "Tester", + "salesforceGroups": [], + "secondEmail": null, + "streetAddress": null + }, + "scope": "USER", + "status": "PROVISIONED", + "statusChanged": "2024-01-31T18:25:03.000Z", + "syncState": "SYNCHRONIZED" + } + }, + "AppUserProvResponse": { + "summary": "SSO and provisioning application user response example", + "value": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2014-08-16T02:35:14.000Z", + "credentials": { + "userName": "saml.jackson@example.com" + }, + "externalId": "005o0000000ogQ9AAI", + "id": "00u15s1KDETTQMQYABRL", + "lastSync": "2014-08-16T02:56:49.000Z", + "lastUpdated": "2014-08-16T02:56:49.000Z", + "passwordChanged": null, + "profile": { + "email": "saml.jackson@example.com", + "firstName": "Saml", + "lastName": "Jackson", + "mobilePhone": null, + "profile": "Standard User", + "role": "Developer", + "salesforceGroups": [ + "Employee" + ], + "secondEmail": null + }, + "scope": "USER", + "status": "PROVISIONED", + "statusChanged": "2014-08-16T02:56:49.000Z", + "syncState": "SYNCHRONIZED" + } + }, + "AppUserSSOResponse": { + "summary": "SSO application user response example", + "value": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00ud4tVDDXYVKPXKVLCO" + } + }, + "created": "2024-01-27T03:52:45.000Z", + "credentials\"": { + "userName": "rae.cloud@example.com" + }, + "externalId": null, + "id": "00ud4tVDDXYVKPXKVLCO", + "lastUpdated": "2024-01-27T03:52:45.000Z", + "passwordChanged": null, + "profile": { + "birthdate": null, + "country": null, + "email": "rae.cloud@example.com", + "family_name": "Cloud", + "formatted": null, + "gender": null, + "given_name": "Rae", + "locale": "en_US", + "locality": null, + "middle_name": null, + "name": "Rae Cloud", + "nickname": null, + "phone_number": null, + "picture": null, + "postal_code": null, + "profile": null, + "region": null, + "street_address": null, + "website": null, + "zoneinfo": "America/Los_Angeles" + }, + "scope": "USER", + "status": "ACTIVE", + "statusChanged": "2024-01-27T03:52:45.000Z", + "syncState": "DISABLED" + } + }, + "AppUserSchemaAddRequest": { + "value": { + "definitions": { + "custom": { + "id": "#custom", + "properties": { + "salesforceUserName": { + "description": "User's username for Salesforce", + "externalName": "salesforceUserName", + "maxLength": 20, + "minLength": 1, + "required": false, + "title": "Salesforce username", + "type": "string" + } + }, + "required": [], + "type": "object" + } + } + } + }, + "AppUserSchemaResponse": { + "value": { + "$schema": "http://json-schema.org/draft-04/schema#", + "created": "2017-07-18T22:35:30.000Z", + "definitions": { + "base": { + "id": "#base", + "properties": { + "userName": { + "maxLength": 100, + "required": true, + "scope": "NONE", + "title": "Username", + "type": "string" + } + }, + "required": [ + "userName" + ], + "type": "object" + }, + "custom": { + "id": "#custom", + "properties": { + "salesforceUserName": { + "description": "User's username for Salesforce", + "externalName": "salesforceUserName", + "maxLength": 20, + "minLength": 1, + "scope": "NONE", + "title": "Salesforce username", + "type": "string" + } + }, + "required": [], + "type": "object" + } + }, + "id": "https://{yourOktaDomain}/meta/schemas/apps/0oa25gejWwdXNnFH90g4/default", + "lastUpdated": "2017-07-18T23:18:43.000Z", + "name": "Example app", + "properties": { + "profile": { + "allOf": [ + { + "$ref": "#/definitions/base" + }, + { + "$ref": "#/definitions/custom" + } + ] + } + }, + "title": "Example app user", + "type": "object" + } + }, + "AppUserUpdateCredRequest": { + "summary": "Application User credentials update", + "value": { + "credentials": { + "password": { + "value": "updatedP@55word" + }, + "userName": "rae.cloud@example.com" + } + } + }, + "AppUserUpdateProfileRequest": { + "summary": "Application user profile update", + "value": { + "profile": { + "middle_name": "Mae", + "name": "Rae Mae Cloud" + } + } + }, + "AppleIdPResponse": { + "summary": "Apple IdP", + "value": { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa18hsHsG3boVejU0g4&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri=${redirectUri}&state={state}&nonce={nonce}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2020-06-05T20:57:51.000Z", + "id": "0oa18hsHsG3boVejU0g4", + "issuerMode": "ORG_URL", + "lastUpdated": "2020-06-05T20:57:51.000Z", + "name": "Apple IdP", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.email" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id" + }, + "signing": { + "kid": "test key ID", + "privateKey": "MIGTAgEAMBM........Cb9PnybCnzDv+3cWSGWqpAIsQQZ", + "teamId": "test team ID" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://appleid.apple.com/auth/authorize" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://appleid.apple.com/auth/token" + } + }, + "scopes": [ + "openid", + "email", + "name" + ], + "type": "OIDC" + }, + "status": "ACTIVE", + "type": "APPLE" + } + }, + "AssignGroupOwnerRequest": { + "summary": "Assign a group owner request example", + "value": { + "id": "00u1cmc03xjzePoWD0h8", + "type": "USER" + } + }, + "AssignGroupOwnerResponse": { + "summary": "Assign a group owner response example", + "value": { + "displayName": "Oliver Putnam", + "id": "00u1cmc03xjzePoWD0h8", + "lastUpdated": "Wed Mar 29 18:34:31 UTC 2023", + "originId": null, + "originType": "OKTA_DIRECTORY", + "resolved": true, + "type": "USER" + } + }, + "AuthenticatorEnrollmentCreateRequestPhone": { + "summary": "Enroll phone - SMS authenticator request", + "value": { + "authenticatorId": "aut5l4ttFyGEWdy6V0k7", + "profile": { + "phoneNumber": "+14086673418" + } + } + }, + "AuthenticatorEnrollmentCreateRequestTac": { + "summary": "Enroll TAC authenticator request", + "value": { + "authenticatorId": "autnmtl4xbt8RQVzA0g4", + "profile": { + "multiUse": false, + "ttl": 11 + } + } + }, + "AuthenticatorEnrollmentResponseListAll": { + "summary": "List of authenticator enrollments", + "value": [ + { + "_links": { + "authenticator": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/auth60xfl7VbebsFr0g6" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7/authenticator-enrollments/eae4za57woixzodEK0g7" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "eae4za57woixzodEK0g7", + "key": "okta_email", + "lastUpdated": "2020-07-28T21:45:52.000Z", + "name": "Email", + "nickname": null, + "profile": { + "email": "joe@example.com" + }, + "status": "ACTIVE", + "type": "email" + }, + { + "_links": { + "authenticator": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/auth60xfl7VbebsFr0g6" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7/authenticator-enrollments/laeh60xfl7VbebsFr0g6" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "laeh60xfl7VbebsFr0g6", + "key": "okta_password", + "lastUpdated": "2020-07-26T21:05:23.000Z", + "name": "Password", + "nickname": null, + "status": "ACTIVE", + "type": "password" + }, + { + "_links": { + "authenticator": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/auth60xfl7VbebsFr0g6" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7/authenticator-enrollments/laeh60xfl7VbebsFr0g6" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "sms8evhwh0Ne35iPR0g7", + "key": "phone_number", + "lastUpdated": "2020-07-29T00:21:29.000Z", + "name": "Phone", + "nickname": "Joe's Work Phone", + "profile": { + "phoneNumber": "+1 XXX-XXX-6065" + }, + "status": "ACTIVE", + "type": "phone" + } + ] + }, + "AuthenticatorEnrollmentResponsePhoneDisclosed": { + "summary": "Phone number disclosed - SMS authenticator enrollment response", + "value": { + "_links": { + "authenticator": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/auth60xfl7VbebsFr0g6" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7/authenticator-enrollments/sms8evhwh0Ne35iPR0g7" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "sms8evhwh0Ne35iPR0g7", + "key": "phone_number", + "lastUpdated": "2020-07-29T00:21:29.000Z", + "name": "Phone", + "nickname": "Ann's Home Phone", + "profile": { + "phoneNumber": 14085551235 + }, + "status": "ACTIVE", + "type": "phone" + } + }, + "AuthenticatorEnrollmentResponsePhoneSms": { + "summary": "phone - SMS authenticator enrollment response", + "value": { + "_links": { + "authenticator": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/auth60xfl7VbebsFr0g6" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7/authenticator-enrollments/sms8evhwh0Ne35iPR0g7" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "sms8evhwh0Ne35iPR0g7", + "key": "phone_number", + "lastUpdated": "2020-07-29T00:21:29.000Z", + "name": "Phone", + "nickname": "Joe's Work Phone", + "profile": { + "phoneNumber": "+1 XXX-XXX-6065" + }, + "status": "ACTIVE", + "type": "phone" + } + }, + "AuthenticatorEnrollmentResponsePhoneVoice": { + "summary": "phone - voice authenticator enrollment response", + "value": { + "_links": { + "authenticator": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/auth60xfl7VbebsFr0g6" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7/authenticator-enrollments/clf8evhwh0Ne35iPR0g7" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "clf8evhwh0Ne35iPR0g7", + "key": "phone_number", + "lastUpdated": "2020-07-29T00:21:29.000Z", + "name": "Phone", + "nickname": "Joe's Work Phone", + "profile": { + "phoneNumber": "+1 XXX-XXX-6065" + }, + "status": "ACTIVE", + "type": "phone" + } + }, + "AuthenticatorEnrollmentResponseTac": { + "summary": "TAC authenticator enrollment response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7/authenticator-enrollments/clf8evhwh0Ne35iPR0g7" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u4za57vqNsQAN8S0g7" + } + }, + "created": "2025-05-28T17:21:14.000Z", + "id": "tac8evhwh0Ne35iPR0g7", + "key": "tac", + "lastUpdated": "2025-05-28T17:21:14.000Z", + "name": "Temporary Access Code", + "profile": { + "expiresAt": "2025-05-28T19:21:14", + "multiUse": true, + "tac": "n@C*bU26" + }, + "status": "ACTIVE", + "type": "tac" + } + }, + "AuthenticatorMethodInactiveVoice": { + "summary": "Phone authenticator - Voice method", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/voice/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/voice" + } + }, + "status": "INACTIVE", + "type": "voice" + } + }, + "AuthenticatorMethodPhone": { + "summary": "List of phone authenticator methods", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/sms/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/sms" + } + }, + "status": "ACTIVE", + "type": "sms" + }, + { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/voice/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/voice" + } + }, + "status": "INACTIVE", + "type": "voice" + } + ] + }, + "AuthenticatorMethodSms": { + "summary": "Phone authenticator - SMS method", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow\"": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/sms/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/sms" + } + }, + "status": "ACTIVE", + "type": "sms" + } + }, + "AuthenticatorMethodTac": { + "summary": "Temporary Access Code authenticator method", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut3l0cm6voCtVWK20g7/methods/tac/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut3l0cm6voCtVWK20g7/methods/tac" + } + }, + "status": "ACTIVE", + "type": "tac" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "AuthenticatorMethodWebAuthn": { + "summary": "Passkey (FIDO2 WebAuthn) authenticator method", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/webauthn" + } + }, + "settings": { + "attachment": "ANY", + "userVerification": "DISCOURAGED" + }, + "status": "ACTIVE", + "type": "webauthn" + } + }, + "AuthenticatorMethodWebAuthnWithRebrandSettings": { + "summary": "Passkeys method with rebranded and new settings", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/webauthn" + }, + "verify-rp-id-domain": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/webauthn/verify-rp-id-domain" + } + }, + "settings": { + "allowSyncablePasskeys": true, + "attachment": "ANY", + "certBasedAttestationValidation": false, + "fipsCompliant": false, + "hardwareProtected": false, + "residentKeyRequirement": "REQUIRED", + "rpId": { + "domain": { + "dnsRecord": { + "fqdn": "_oktaverification.mycustomdomain.com,", + "recordType": "TXT", + "verificationValue": "5e2dc662c8ce4f4aa4cd1cd292490d35" + }, + "name": "mycustomdomain.com", + "validationStatus": "NOT_STARTED" + }, + "enabled": false + }, + "showSignInWithAPasskeyButton": false, + "userVerification": "PREFERRED", + "userVerificationForVerify": "PREFERRED" + }, + "status": "ACTIVE", + "type": "webauthn" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "AuthenticatorMethodWebAuthnWithRpId": { + "summary": "Passkey (FIDO2 WebAuthn) authenticator method with a custom RP ID", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/webauthn" + }, + "verify-rp-id-domain": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods/webauthn/verify-rp-id-domain" + } + }, + "settings": { + "attachment": "ANY", + "rpId": { + "domain": { + "dnsRecord": { + "fqdn": "_oktaverification.mycustomdomain.com,", + "recordType": "TXT", + "verificationValue": "5e2dc662c8ce4f4aa4cd1cd292490d35" + }, + "name": "mycustomdomain.com", + "validationStatus": "NOT_STARTED" + }, + "enabled": false + }, + "userVerification": "DISCOURAGED" + }, + "status": "ACTIVE", + "type": "webauthn" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "AuthenticatorRequestDuo": { + "summary": "Duo", + "value": { + "key": "duo", + "name": "Duo Security", + "provider": { + "configuration": { + "host": "https://api-xxxxxxxx.duosecurity.com", + "integrationKey": "testIntegrationKey", + "secretKey": "testSecretKey", + "userNameTemplate": { + "template": "oktaId" + } + }, + "type": "DUO" + } + } + }, + "AuthenticatorRequestTac": { + "summary": "Temporary Access Code", + "value": { + "key": "tac", + "name": "Temporary Access Code", + "provider": { + "configuration": { + "complexity": { + "letters": true, + "numbers": true, + "specialCharacters": true + }, + "defaultTtl": 120, + "length": 16, + "maxTtl": 14400, + "minTtl": 10, + "multiUseAllowed": true + }, + "type": "tac" + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "AuthenticatorRequestWebAuthnWithNameAndDescription": { + "value": { + "description": "Custom description for Passkey (FIDO2 WebAuthn) authenticator", + "key": "webauthn", + "name": "Custom Passkey (FIDO2 WebAuthn) authenticator name" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "AuthenticatorResponseDuo": { + "summary": "Duo", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut5gnvcjUHIWb25J0g4" + } + }, + "created": "2022-07-15T21:14:02.000Z", + "id": "aut9gnvcjUHIWb37J0g4", + "key": "duo", + "lastUpdated": "2022-07-15T21:14:02.000Z", + "name": "Duo Security", + "provider": { + "configuration": { + "host": "https://api-xxxxxxxx.duosecurity.com", + "userNameTemplate": { + "template": "oktaId" + } + }, + "type": "DUO" + }, + "settings": {}, + "status": "ACTIVE", + "type": "app" + } + }, + "AuthenticatorResponseEmail": { + "summary": "Email", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "aut1nbsPHh7jNjjyP0g4", + "key": "okta_email", + "lastUpdated": "2020-07-28T21:45:52.000Z", + "name": "Email", + "settings": { + "allowedFor": "any", + "tokenLifetimeInMinutes": 5 + }, + "status": "ACTIVE", + "type": "email" + } + }, + "AuthenticatorResponseInactiveWebAuthn": { + "summary": "Inactive Passkey (FIDO2 WebAuthn) authenticator", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4" + } + }, + "created": "2020-07-26T21:16:37.000Z", + "id": "aut1nd8PQhGcQtSxB0g4", + "key": "webauthn", + "lastUpdated": "2020-07-27T18:59:30.000Z", + "name": "Security Key or Biometric", + "status": "INACTIVE", + "type": "security_key" + } + }, + "AuthenticatorResponsePassword": { + "summary": "Password", + "value": { + "_links": { + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbtrJKKA9m45a0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbtrJKKA9m45a0g4" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "aut1nbtrJKKA9m45a0g4", + "key": "okta_password", + "lastUpdated": "2020-07-26T21:05:23.000Z", + "name": "Password", + "status": "ACTIVE", + "type": "password" + } + }, + "AuthenticatorResponsePhone": { + "summary": "Phone", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4/lifecycle/activate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "aut1nbuyD8m1ckAYc0g4", + "key": "phone_number", + "lastUpdated": "2020-07-29T00:21:29.000Z", + "name": "Phone", + "settings": { + "allowedFor": "none" + }, + "status": "INACTIVE", + "type": "phone" + } + }, + "AuthenticatorResponseSecurityQuestion": { + "summary": "Security question", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbvIgEenhwE6c0g4/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbvIgEenhwE6c0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbvIgEenhwE6c0g4" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "aut1nbvIgEenhwE6c0g4", + "key": "security_question", + "lastUpdated": "2020-07-26T21:05:23.000Z", + "name": "Security Question", + "status": "ACTIVE", + "type": "security_question" + } + }, + "AuthenticatorResponseTac": { + "summary": "Temporary Access Code", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut3l0cm6voCtVWK20g7/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut3l0cm6voCtVWK20g7/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut3l0cm6voCtVWK20g7" + } + }, + "created": "2022-07-15T21:14:02.000Z", + "id": "aut3l0cm6voCtVWK20g7", + "key": "tac", + "lastUpdated": "2022-07-15T21:14:02.000Z", + "name": "Temporary Access Code", + "provider": { + "configuration": { + "complexity": { + "letters": true, + "numbers": true, + "specialCharacters": true + }, + "defaultTtl": 120, + "length": 16, + "maxTtl": 14400, + "minTtl": 10, + "multiUseAllowed": true + }, + "type": "tac" + }, + "status": "ACTIVE", + "type": "tac" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "AuthenticatorResponseWebAuthn": { + "summary": "Passkey (FIDO2 WebAuthn)", + "value": { + "_links": { + "aaguids": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/aaguids" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4" + } + }, + "created": "2020-07-26T21:16:37.000Z", + "id": "aut1nd8PQhGcQtSxB0g4", + "key": "webauthn", + "lastUpdated": "2020-07-27T18:59:30.000Z", + "name": "Security Key or Biometric", + "status": "ACTIVE", + "type": "security_key" + } + }, + "AuthenticatorResponseWebAuthnWithNameAndDescription": { + "value": { + "_links": { + "aaguids": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/aaguids" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4" + } + }, + "created": "2020-07-26T21:16:37.000Z", + "description": "Custom description for Passkey (FIDO2 WebAuthn) authenticator", + "id": "aut1nd8PQhGcQtSxB0g4", + "key": "webauthn", + "lastUpdated": "2020-07-27T18:59:30.000Z", + "name": "Custom Passkey (FIDO2 WebAuthn) authenticator name", + "status": "ACTIVE", + "type": "security_key" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "AuthenticatorsResponse": { + "summary": "List of org's authenticators", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "aut1nbsPHh7jNjjyP0g4", + "key": "okta_email", + "lastUpdated": "2020-07-28T21:45:52.000Z", + "name": "Email", + "settings": { + "allowedFor": "any", + "tokenLifetimeInMinutes": 5 + }, + "status": "ACTIVE", + "type": "email" + }, + { + "_links": { + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbtrJKKA9m45a0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbtrJKKA9m45a0g4" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "aut1nbtrJKKA9m45a0g4", + "key": "okta_password", + "lastUpdated": "2020-07-26T21:05:23.000Z", + "name": "Password", + "status": "ACTIVE", + "type": "password" + }, + { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4/lifecycle/activate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "aut1nbuyD8m1ckAYc0g4", + "key": "phone_number", + "lastUpdated": "2020-07-29T00:21:29.000Z", + "name": "Phone", + "settings": { + "allowedFor": "none" + }, + "status": "INACTIVE", + "type": "phone" + }, + { + "_links": { + "aaguids": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/aaguids" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4" + } + }, + "created": "2020-07-26T21:16:37.000Z", + "id": "aut1nd8PQhGcQtSxB0g4", + "key": "webauthn", + "lastUpdated": "2020-07-27T18:59:30.000Z", + "name": "Security Key or Biometric", + "status": "ACTIVE", + "type": "security_key" + } + ] + }, + "AuthenticatorsResponseWithWebAuthnNameAndDescription": { + "summary": "Org authenticators with Passkey (FIDO2 WebAuthn) authenticator name and description", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbsPHh7jNjjyP0g4" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "aut1nbsPHh7jNjjyP0g4", + "key": "okta_email", + "lastUpdated": "2020-07-28T21:45:52.000Z", + "name": "Email", + "settings": { + "allowedFor": "any", + "tokenLifetimeInMinutes": 5 + }, + "status": "ACTIVE", + "type": "email" + }, + { + "_links": { + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbtrJKKA9m45a0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbtrJKKA9m45a0g4" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "aut1nbtrJKKA9m45a0g4", + "key": "okta_password", + "lastUpdated": "2020-07-26T21:05:23.000Z", + "name": "Password", + "status": "ACTIVE", + "type": "password" + }, + { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4/lifecycle/activate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nbuyD8m1ckAYc0g4" + } + }, + "created": "2020-07-26T21:05:23.000Z", + "id": "aut1nbuyD8m1ckAYc0g4", + "key": "phone_number", + "lastUpdated": "2020-07-29T00:21:29.000Z", + "name": "Phone", + "settings": { + "allowedFor": "none" + }, + "status": "INACTIVE", + "type": "phone" + }, + { + "_links": { + "aaguids": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/aaguids" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/lifecycle/deactivate" + }, + "methods": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/methods" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4" + } + }, + "created": "2020-07-26T21:16:37.000Z", + "description": "Custom description for Passkey (FIDO2 WebAuthn) authenticator", + "id": "aut1nd8PQhGcQtSxB0g4", + "key": "webauthn", + "lastUpdated": "2020-07-27T18:59:30.000Z", + "name": "Custom Passkey (FIDO2 WebAuthn) authenticator name", + "status": "ACTIVE", + "type": "security_key" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "AuthorizationServerPolicy": { + "summary": "Authorization server policy", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies/00palyaappA22DPkj0h7/lifecycle/deactivate" + }, + "rules": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies/00palyaappA22DPkj0h7/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies/00palyaappA22DPkj0h7" + } + }, + "conditions": { + "clients": { + "include": [ + "ALL_CLIENTS" + ] + } + }, + "created": "2017-05-26T19:43:53.000Z", + "description": "Vendor2 policy description", + "id": "00palyaappA22DPkj0h7", + "lastUpdated": "2017-06-07T15:28:17.000Z", + "name": "Vendor2 Policy", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "OAUTH_AUTHORIZATION_POLICY" + } + }, + "AuthorizationServerPolicyRule": { + "summary": "Authorization server policy rule", + "value": { + "_links": { + "self": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/0prbsjfyl01zfSZ9K0h7/lifecycle/deactivate" + }, + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/0prbsjfyl01zfSZ9K0h7" + } + }, + "actions": { + "token": { + "accessTokenLifetimeMinutes": 60, + "inlineHook": { + "id": "cal4egvp1mbMldrYN0g7" + }, + "refreshTokenLifetimeMinutes": 0, + "refreshTokenWindowMinutes": 10080 + } + }, + "conditions": { + "grantTypes": { + "include": [ + "implicit", + "client_credentials", + "authorization_code", + "password" + ] + }, + "people": { + "groups": { + "exclude": [], + "include": [ + "EVERYONE" + ] + }, + "users": { + "exclude": [], + "include": [] + } + }, + "scopes": { + "include": [ + "*" + ] + } + }, + "created": "2017-08-25T16:57:02.000Z", + "id": "0prbsjfyl01zfSZ9K0h7", + "lastUpdated": "2017-08-30T14:51:05.000Z", + "name": "Default Policy Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "RESOURCE_ACCESS" + } + }, + "AutoLoginAppResponseEx": { + "summary": "AUTO_LOGIN", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "revealPassword": false, + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Custom SWA App", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "customswaapp", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:customswaapp:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": {}, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "loginUrl": "http://swaprimaryloginurl.okta.com", + "redirectUrl": "http://swasecondaryredirecturl.okta.com" + } + }, + "signOnMode": "AUTO_LOGIN", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "customswaapp_link": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "AutoLoginEx": { + "summary": "AUTO_LOGIN", + "value": { + "label": "Custom SWA App", + "settings": { + "signOn": { + "loginUrl": "http://swaprimaryloginurl.okta.com", + "redirectUrl": "http://swasecondaryredirecturl.okta.com" + } + }, + "signOnMode": "AUTO_LOGIN", + "visibility": { + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "AutoLoginPutEx": { + "summary": "AUTO_LOGIN", + "value": { + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "credentials": { + "scheme": "ADMIN_SETS_CREDENTIALS", + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "label": "Custom SWA App updated", + "settings": { + "signOn": { + "loginUrl": "http://swaprimaryloginurl.okta.com", + "redirectUrl": "http://swasecondaryredirecturlupdated.okta.com" + } + }, + "signOnMode": "AUTO_LOGIN", + "status": "ACTIVE", + "visibility": { + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "AutoLoginPutResponseEx": { + "summary": "AUTO_LOGIN", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "revealPassword": false, + "scheme": "ADMIN_SETS_CREDENTIALS", + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Custom SWA App updated", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "customswaapp", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:customswaapp:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": {}, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "loginUrl": "http://swaprimaryloginurl.okta.com", + "redirectUrl": "http://swasecondaryredirecturlupdated.okta.com" + } + }, + "signOnMode": "AUTO_LOGIN", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "customswaapp_link": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "AvailableActions": { + "summary": "Available actions example", + "value": { + "actions": [ + { + "id": "okta:action1", + "provider": { + "actionName": "Provision User", + "externalId": "JKL490DQNV", + "link": "https://example.com/workflows/flow1", + "type": "WORKFLOWS" + } + } + ] + } + }, + "BaseSignOnModeEx": { + "value": { + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "features": [], + "status": "ACTIVE", + "visibility": { + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "BasicAuthEx": { + "summary": "BASIC_AUTH", + "value": { + "label": "Sample Basic Auth App", + "name": "template_basic_auth", + "settings": { + "app": { + "authURL": "https://example.com/auth.html", + "url": "https://example.com/login.html" + } + }, + "signOnMode": "BASIC_AUTH" + } + }, + "BasicAuthPutEx": { + "summary": "BASIC_AUTH", + "value": { + "label": "Sample Basic Auth App updated", + "settings": { + "app": { + "authURL": "https://example.com/auth.html", + "url": "https://example.com/loginUpdated.html" + } + }, + "signOnMode": "BASIC_AUTH" + } + }, + "BasicAuthPutResponseEx": { + "summary": "BASIC_AUTH", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "revealPassword": false, + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample Basic Auth App updated", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "template_basic_auth", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_basic_auth:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "authURL": "https://example.com/auth.html", + "loginUrlRegex": null, + "url": "https://example.com/loginUpdated.html" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "BASIC_AUTH", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "BasicAuthResponseEx": { + "summary": "BASIC_AUTH", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "revealPassword": false, + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample Basic Auth App", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "template_basic_auth", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_basic_auth:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "authURL": "https://example.com/auth.html", + "loginUrlRegex": null, + "url": "https://example.com/login.html" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "BASIC_AUTH", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "BasicAuthSettings": { + "summary": "Basic auth settings example", + "value": { + "authType": "BASIC" + } + }, + "BasicSMTPPatchRequest": { + "summary": "Update basic SMTP server", + "value": { + "alias": "CustomServer1 New Alias", + "password": "New password" + } + }, + "BasicSMTPPatchResponse": { + "summary": "Basic authentication SMTP server patch response", + "value": { + "alias": "CustomServer1 New Alias", + "authType": "BASIC_SMTP_AUTH", + "enabled": true, + "host": "smtp.example.com", + "id": "ces7n3u7sSohfoaou0g1", + "port": 587, + "username": "user@example.com" + } + }, + "BasicSMTPRequest": { + "summary": "Create basic authentication SMTP server", + "value": { + "alias": "CustomServer1", + "authType": "BASIC_SMTP_AUTH", + "enabled": true, + "host": "smtp.example.com", + "password": "securepassword", + "port": 587, + "username": "user@example.com" + } + }, + "BasicSMTPResponse": { + "summary": "Basic authentication SMTP server response", + "value": { + "alias": "CustomServer1", + "authType": "BASIC_SMTP_AUTH", + "enabled": true, + "host": "smtp.example.com", + "id": "ces7n3u7sSohfoaou0g1", + "port": 587, + "username": "user@example.com" + } + }, + "BehaviorRuleRequest": { + "value": { + "name": "My Behavior Rule", + "type": "VELOCITY" + } + }, + "BehaviorRuleResponse": { + "value": { + "_link": { + "self": { + "hints": { + "allow": [ + "GET", + "POST", + "PUT", + "DELETE" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/behaviors/abcd1234" + } + }, + "created": "2021-11-09 20:38:10.0", + "id": "abcd1234", + "lastUpdated": "2021-11-11 20:38:10.0", + "name": "My Behavior Rule", + "settings": { + "velocityKph": 805 + }, + "status": "ACTIVE", + "type": "VELOCITY" + } + }, + "BookmarkAppResponseEx": { + "summary": "BOOKMARK", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample Bookmark App", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "bookmark", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:bookmark:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "requestIntegration": false, + "url": "https://example.com/bookmark.html" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "BOOKMARK", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "BookmarkEx": { + "summary": "BOOKMARK", + "value": { + "label": "Sample Bookmark App", + "name": "bookmark", + "settings": { + "app": { + "url": "https://example.com/bookmark.html" + } + }, + "signOnMode": "BOOKMARK" + } + }, + "BookmarkPutEx": { + "summary": "BOOKMARK", + "value": { + "label": "Sample Bookmark App updated", + "name": "bookmark", + "settings": { + "app": { + "requestIntegration": true, + "url": "https://example.com/bookmark.html" + } + }, + "signOnMode": "BOOKMARK" + } + }, + "BookmarkPutResponseEx": { + "summary": "BOOKMARK", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample Bookmark App updated", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "bookmark", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:bookmark:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "requestIntegration": true, + "url": "https://example.com/bookmark.html" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "BOOKMARK", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "BotProtectionConfigurationDefault": { + "summary": "Default bot protection configuration (`LOG_ONLY` mode)", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/bot-protection/configuration" + } + }, + "level": "LOW", + "mode": "LOG_ONLY", + "supportedFlows": [ + "SIGN_IN", + "SSR", + "SSPR" + ] + } + }, + "BotProtectionConfigurationEnforced": { + "summary": "Enforced bot protection configuration", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/bot-protection/configuration" + } + }, + "enforcementType": "OKTA_CHALLENGE", + "level": "MEDIUM", + "mode": "ENFORCED", + "supportedFlows": [ + "SIGN_IN", + "SSR", + "SSPR" + ] + } + }, + "BotProtectionConfigurationRequestEnforced": { + "summary": "Update to `ENFORCED` mode", + "value": { + "enforcementType": "OKTA_CHALLENGE", + "level": "MEDIUM", + "mode": "ENFORCED", + "supportedFlows": [ + "SSR", + "SSPR" + ] + } + }, + "BotProtectionConfigurationRequestLogOnly": { + "summary": "Update to `LOG_ONLY` mode", + "value": { + "level": "LOW", + "mode": "LOG_ONLY", + "supportedFlows": [ + "SIGN_IN", + "SSR", + "SSPR" + ] + } + }, + "BrowserPluginEx": { + "summary": "BROWSER_PLUGIN", + "value": { + "label": "Sample Plugin App", + "name": "template_swa", + "settings": { + "app": { + "buttonField": "btn-login", + "passwordField": "txtbox-password", + "url": "https://example.com/login.html", + "usernameField": "txtbox-username" + } + }, + "signOnMode": "BROWSER_PLUGIN" + } + }, + "BrowserPluginPutEx": { + "summary": "BROWSER_PLUGIN", + "value": { + "label": "Sample Plugin App updated", + "name": "template_swa", + "settings": { + "app": { + "buttonField": "btn-login", + "passwordField": "txtbox-password", + "url": "https://example_updated.com/login.html", + "usernameField": "txtbox-username" + } + }, + "signOnMode": "BROWSER_PLUGIN" + } + }, + "BrowserPluginPutResponseEx": { + "summary": "BROWSER_PLUGIN", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "revealPassword": false, + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample Plugin App updated", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "template_swa", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_swa:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "buttonField": "btn-login", + "loginUrlRegex": null, + "passwordField": "txtbox-password", + "url": "https://example_updated.com/login.html", + "usernameField": "txtbox-username" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "BROWSER_PLUGIN", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "BrowserPluginResponseEx": { + "summary": "BROWSER_PLUGIN", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "revealPassword": false, + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample Plugin App", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "template_swa", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_swa:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "buttonField": "btn-login", + "loginUrlRegex": null, + "passwordField": "txtbox-password", + "url": "https://example.com/login.html", + "usernameField": "txtbox-username" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "BROWSER_PLUGIN", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "BrowserPluginSwa3FieldEx": { + "summary": "BROWSER_PLUGIN with three CSS selectors", + "value": { + "label": "Sample Plugin App", + "name": "template_swa3field", + "settings": { + "app": { + "buttonSelector": "#btn-login", + "extraFieldSelector": ".login", + "extraFieldValue": "SOMEVALUE", + "passwordSelector": "#txtbox-password", + "targetURL": "https://example.com/login.html", + "userNameSelector": "#txtbox-username" + } + }, + "signOnMode": "BROWSER_PLUGIN" + } + }, + "BrowserPluginSwa3FieldPutEx": { + "summary": "BROWSER_PLUGIN with three CSS selectors", + "value": { + "label": "Sample Plugin App updated", + "name": "template_swa3field", + "settings": { + "app": { + "buttonSelector": "#btn-login", + "extraFieldSelector": ".login", + "extraFieldValue": "SOMEVALUE", + "passwordSelector": "#txtbox-password", + "targetURL": "https://exampleupdated.com/login.html", + "userNameSelector": "#txtbox-username" + } + }, + "signOnMode": "BROWSER_PLUGIN" + } + }, + "BrowserPluginSwa3FieldPutResponseEx": { + "summary": "BROWSER_PLUGIN with three CSS selectors", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "revealPassword": false, + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample Plugin App updated", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "template_swa3field", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_swa3field:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "buttonSelector": "#btn-login", + "extraFieldSelector": ".login", + "extraFieldValue": "SOMEVALUE", + "loginUrlRegex": null, + "passwordSelector": "#txtbox-password", + "targetURL": "https://exampleupdated.com/login.html", + "userNameSelector": "#txtbox-username" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "BROWSER_PLUGIN", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "BrowserPluginSwa3FieldResponseEx": { + "summary": "BROWSER_PLUGIN with three CSS selectors", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "revealPassword": false, + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample Plugin App", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "template_swa3field", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_swa3field:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "buttonSelector": "#btn-login", + "extraFieldSelector": ".login", + "extraFieldValue": "SOMEVALUE", + "loginUrlRegex": null, + "passwordSelector": "#txtbox-password", + "targetURL": "https://example.com/login.html", + "userNameSelector": "#txtbox-username" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "BROWSER_PLUGIN", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "BundleEntitlementsResponse": { + "summary": "List of governance bundle entitlements", + "value": { + "_links": { + "bundle": { + "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA" + }, + "next": { + "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles?after=bundleId12" + }, + "self": { + "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles?limit=2&after=10" + } + }, + "entitlements": [ + { + "_links": { + "values": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA/entitlements/espfxqCAJWWGELFTYASJ/values" + }, + "description": "Perform all admin activities for groups in the org", + "id": "espfxqCAJWWGELFTYASJ", + "name": "Group Membership Admin", + "role": "GROUP_MEMBERSHIP_ADMIN" + } + ] + } + }, + "CAPTCHAInstanceRequestHCaptcha": { + "value": { + "name": "myHCaptcha", + "secretKey": "xxxxxxxxxxx", + "siteKey": "xxxxxxxxxxx", + "type": "HCAPTCHA" + } + }, + "CAPTCHAInstanceRequestReCaptcha": { + "value": { + "name": "myReCaptcha", + "secretKey": "xxxxxxxxxxx", + "siteKey": "yyyyyyyyyyyyyyy", + "type": "RECAPTCHA_V2" + } + }, + "CAPTCHAInstanceResponseHCaptcha": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "POST", + "PUT", + "DELETE" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/captchas/abcd1234" + } + }, + "id": "abcd1234", + "name": "myHCaptcha", + "siteKey": "xxxxxxxxxxx", + "type": "HCAPTCHA" + } + }, + "CAPTCHAInstanceResponseReCaptcha": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "POST", + "PUT", + "DELETE" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/captchas/abcd4567" + } + }, + "id": "abcd4567", + "name": "myReCaptcha", + "siteKey": "yyyyyyyyyyyyyyy", + "type": "RECAPTCHA_V2" + } + }, + "CLEARIDVResponse": { + "summary": "CLEAR Verified as IdP", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oab50jh0UPiB6xde0w6/lifecycle/deactivate" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oab50jh0UPiB6xde0w6/users" + } + }, + "created": "2025-01-14T19:59:41.000Z", + "id": "0oab50jh0UPiB6xde0w6", + "lastUpdated": "2025-01-14T19:59:41.000Z", + "name": "CLEAR Verified IDV", + "policy": { + "maxClockSkew": 0, + "provisioning": { + "action": "DISABLED", + "groups": null, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "source.userName" + } + } + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://verified.clearme.com/oauth/idv_authorize" + }, + "par": { + "binding": "HTTP-POST", + "url": "https://verified.clearme.com/oauth/par" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://verified.clearme.com/hydra/oauth2/token" + } + }, + "scopes": [ + "openid", + "profile", + "identity_assurance" + ], + "type": "ID_PROOFING" + }, + "status": "ACTIVE", + "type": "IDV_CLEAR" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "CannotUpdateWellKnownUriForDefaultBrandError": { + "summary": "Cannot update well-known URI for default brand", + "value": { + "errorCauses": [ + { + "errorSummary": "Cannot update the content for the default brand." + } + ], + "errorCode": "E0000257", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000257", + "errorSummary": "Api validation failed: request" + } + }, + "ChangePwdRequest": { + "value": { + "newPassword": { + "value": "uTVM,TPw55" + }, + "oldPassword": { + "value": "tlpWENT2m" + }, + "revokeSessions": true + } + }, + "ChangePwdResponse": { + "value": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + }, + "recovery_question": { + "question": "Who's a major player in the cowboy scene?" + } + } + }, + "ClientRoleTargetResponseFacebookEx": { + "summary": "Facebook target app example", + "value": [ + { + "_links": { + "logo": [ + { + "href": "https://{oktaCDNDomain}/fs/bcg/4/abcdefghijABCC4V1234", + "name": "medium" + } + ], + "self": { + "href": "https://{yourOktaDomain}/api/v1/catalog/apps/facebook" + } + }, + "category": "SOCIAL", + "description": "Giving people the power to share and make the world more open and connected.", + "displayName": "Facebook", + "lastUpdated": "2021-03-18T17:37:56.000Z", + "name": "facebook", + "signOnModes": [ + "BROWSER_PLUGIN" + ], + "status": "ACTIVE", + "verificationStatus": "OKTA_VERIFIED", + "website": "https://www.facebook.com/" + } + ] + }, + "ClientRoleTargetResponseInstanceEx": { + "summary": "Non-catalog target app example", + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oasrudLtMlzAsTxk0g3" + } + }, + "id": "0oasrudLtMlzAsTxk0g3", + "name": "My_access_app", + "status": "ACTIVE" + } + ] + }, + "CreateAnEventHook": { + "summary": "Create an event hook", + "value": { + "channel": { + "config": { + "authScheme": { + "key": "Authorization", + "type": "HEADER", + "value": "my-shared-secret" + }, + "headers": [ + { + "key": "X-Other-Header", + "value": "my-header-value" + } + ], + "uri": "https://example_external_service/userAdded" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "events": { + "items": [ + "group.user_membership.add" + ], + "type": "EVENT_TYPE" + }, + "name": "Event Hook Test" + } + }, + "CreateAnEventHookWithFilter": { + "summary": "Create an event hook with a filter", + "value": { + "channel": { + "config": { + "authScheme": { + "key": "Authorization", + "type": "HEADER", + "value": "my-shared-secret" + }, + "uri": "https://example_external_service/userAdded" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "description": "An event hook using an Okta Expression Language filter", + "events": { + "filter": { + "eventFilterMap": [ + { + "condition": { + "expression": "event.target.?[type eq 'UserGroup'].size()>0 && event.target.?[displayName eq 'Sales'].size()>0" + }, + "event": "group.user_membership.add" + } + ], + "type": "EXPRESSION_LANGUAGE" + }, + "items": [ + "group.user_membership.add" + ], + "type": "EVENT_TYPE" + }, + "name": "Event Hook with Filter" + } + }, + "CreateAppleIdPRequest": { + "summary": "Create Apple IdP", + "value": { + "name": "Apple IdP", + "policy": { + "accountLink": { + "action": "AUTO" + }, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.email" + } + } + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id" + }, + "signing": { + "kid": "test key ID", + "privateKey": "MIGTAgEAMBM........Cb9PnybCnzDv+3cWSGWqpAIsQQZ", + "teamId": "test team ID" + } + }, + "scopes": [ + "openid", + "email", + "name" + ], + "type": "OIDC" + }, + "type": "APPLE" + } + }, + "CreateAssocAuthServerBody": { + "summary": "Create a trusted relationship between authorization servers", + "value": [ + { + "trusted": "{authorizationServerId}" + } + ] + }, + "CreateAssocAuthServerResponse": { + "summary": "Create a trusted relationship between authorization servers", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}" + } + }, + "audiences": [ + "https://api.resource.com" + ], + "created": "2023-05-17T22:25:57.000Z", + "credentials": { + "signing": { + "kid": "WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4", + "lastRotated": "2023-05-17T22:25:57.000Z", + "nextRotation": "2023-08-15T22:25:57.000Z", + "rotationMode": "AUTO", + "use": "sig" + } + }, + "description": "Sample Authorization Server description", + "id": "{authorizationServerId}", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "issuerMode": "CUSTOM_URL", + "lastUpdated": "2023-05-17T22:25:57.000Z", + "name": "Sample Authorization Server", + "status": "ACTIVE" + } + ] + }, + "CreateAuthServerBody": { + "summary": "Create a custom authorization server", + "value": { + "audiences": [ + "api://default" + ], + "description": "Sample Authorization Server description", + "name": "Sample Authorization Server" + } + }, + "CreateAuthServerResponse": { + "summary": "Create a custom authorization server", + "value": { + "_links": { + "claims": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate" + }, + "metadata": [ + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server", + "name": "oauth-authorization-server" + }, + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration", + "name": "openid-configuration" + } + ], + "policies": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies" + }, + "rotateKey": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate" + }, + "scopes": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}" + } + }, + "audiences": [ + "https://api.resource.com" + ], + "created": "2023-05-17T22:25:57.000Z", + "credentials": { + "signing": { + "kid": "WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4", + "lastRotated": "2023-05-17T22:25:57.000Z", + "nextRotation": "2023-08-15T22:25:57.000Z", + "rotationMode": "AUTO" + } + }, + "description": "Sample Authorization Server description", + "id": "{authorizationServerId}", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "issuerMode": "ORG_URL", + "lastUpdated": "2023-05-17T22:25:57.000Z", + "name": "Sample Authorization Server", + "status": "ACTIVE" + } + }, + "CreateAuthServerWithAccessTokenEncryptionBody": { + "summary": "Create a custom authorization server with access token encryption enabled", + "value": { + "accessTokenEncryptedResponseAlgorithm": "RSA-OAEP-256", + "audiences": [ + "api://default" + ], + "description": "Sample authorization server description", + "jwks": { + "keys": [ + { + "e": "AQAB", + "id": "apk2g3sd6bqV5YZxu0h8", + "kid": "encKey", + "kty": "RSA", + "n": "iHYyA5KXL82veBfNP81D7Q1GMRWIixNTu5jY03Z19DN7qTg1xYPRyPEPuMJ5Xjdhrm3dJdW7p1woRa6CHfw8FS7aosXUZkplxPs0NICP32nCkwpX3U3CltgVWrpMEUrd-JljKm0AgrervZuLkgBEfwY3BXP_SCKjF0JtbQjcK9MOKFNUUUK3_xTrFcyZThlSOtiOmhjDHTfHzeG2Q0NG2Opom1kfKWLDUVy5qrzYJWgcCaPOyEE1xnk4u5syH_8APOi2tKwKBCgS_D-kXzZ_379VhVuEpo2CGBU20t9Ys_m8KLqMCOyJaoQ3R1r6cWHfnYSab31L1my3rLwuippXkQ", + "status": "ACTIVE", + "use": "enc" + } + ] + }, + "name": "Sample Authorization Server" + } + }, + "CreateAuthServerWithAccessTokenEncryptionResponse": { + "summary": "Create a custom authorization server with access token encryption enabled", + "value": { + "_links": { + "claims": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate" + }, + "metadata": [ + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server", + "name": "oauth-authorization-server" + }, + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration", + "name": "openid-configuration" + } + ], + "policies": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies" + }, + "rotateKey": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate" + }, + "scopes": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}" + } + }, + "accessTokenEncryptedResponseAlgorithm": "RSA-OAEP-256", + "audiences": [ + "https://api.resource.com" + ], + "created": "2023-05-17T22:25:57.000Z", + "credentials": { + "signing": { + "kid": "WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4", + "lastRotated": "2023-05-17T22:25:57.000Z", + "nextRotation": "2023-08-15T22:25:57.000Z", + "rotationMode": "AUTO" + } + }, + "description": "Sample authorization server description", + "id": "{authorizationServerId}", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "issuerMode": "ORG_URL", + "jwks": { + "keys": [ + { + "e": "AQAB", + "id": "apk2g3sd6bqV5YZxu0h8", + "kid": "encKey", + "kty": "RSA", + "n": "iHYyA5KXL82veBfNP81D7Q1GMRWIixNTu5jY03Z19DN7qTg1xYPRyPEPuMJ5Xjdhrm3dJdW7p1woRa6CHfw8FS7aosXUZkplxPs0NICP32nCkwpX3U3CltgVWrpMEUrd-JljKm0AgrervZuLkgBEfwY3BXP_SCKjF0JtbQjcK9MOKFNUUUK3_xTrFcyZThlSOtiOmhjDHTfHzeG2Q0NG2Opom1kfKWLDUVy5qrzYJWgcCaPOyEE1xnk4u5syH_8APOi2tKwKBCgS_D-kXzZ_379VhVuEpo2CGBU20t9Ys_m8KLqMCOyJaoQ3R1r6cWHfnYSab31L1my3rLwuippXkQ", + "status": "ACTIVE", + "use": "enc" + } + ] + }, + "lastUpdated": "2023-05-17T22:25:57.000Z", + "name": "Sample Authorization Server", + "status": "ACTIVE" + } + }, + "CreateAuthorizationServerPolicyRequest": { + "summary": "Create an authorization server policy", + "value": { + "conditions": { + "clients\"": { + "include\"": [ + "ALL_CLIENTS" + ] + } + }, + "description": "Default policy description", + "name": "Default Policy", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "OAUTH_AUTHORIZATION_POLICY" + } + }, + "CreateAuthorizationServerPolicyRuleRequest": { + "summary": "Create authorization server policy rule", + "value": { + "actions": { + "token": { + "accessTokenLifetimeMinutes": 60, + "inlineHook": { + "id": "cal4egvp1mbMldrYN0g7" + }, + "refreshTokenLifetimeMinutes": 0, + "refreshTokenWindowMinutes": 10080 + } + }, + "conditions": { + "grantTypes": { + "include": [ + "implicit", + "client_credentials", + "authorization_code", + "password" + ] + }, + "people": { + "groups": { + "include": [ + "EVERYONE" + ] + } + }, + "scopes": { + "include": [ + "*" + ] + } + }, + "name": "Default Policy Rule", + "priority": 1, + "type": "RESOURCE_ACCESS" + } + }, + "CreateBrandRequest": { + "value": { + "name": "My Awesome Brand" + } + }, + "CreateBrandResponse": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g5" + }, + "themes": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g5/themes" + } + }, + "agreeToCustomPrivacyPolicy": "false,", + "customPrivacyPolicyUrl": "null,", + "defaultApp": { + "appInstanceId": null, + "appLinkName": null, + "classicApplicationUri": null + }, + "id": "bnd114iNkrcN6aR680g5", + "isDefault": false, + "locale": "en", + "name": "My Awesome Brand", + "removePoweredByOkta": false + } + }, + "CreateCLEARIDVRequest": { + "summary": "Create CLEAR Verified as IdP", + "value": { + "name": "CLEAR Verified IDV", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "maxClockSkew": 0, + "provisioning": { + "action": "DISABLED", + "groups": null, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "source.userName" + } + } + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "scopes": [ + "profile", + "identity_assurance", + "openid" + ], + "type": "ID_PROOFING" + }, + "type": "IDV_CLEAR" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "CreateChildOrgRequestEx": { + "summary": "Create org request", + "value": { + "admin": { + "credentials": { + "password": { + "value": "XXXX" + } + }, + "profile": { + "email": "FirstLast@example.com", + "firstName": "First", + "lastName": "Last", + "login": "FirstLast@example.com", + "mobilePhone": null + } + }, + "edition": "SKU", + "name": "My Child Org 1", + "subdomain": "my-child-org-1", + "website": "http://www.examplecorp.com" + } + }, + "CreateChildOrgResponseEx": { + "summary": "Create org response", + "value": { + "_links": { + "administrator": { + "href": "https://my-child-org-1.oktapreview.com/api/v1/users/00u1n8sheI1WBQlDV406" + }, + "contacts": { + "href": "https://my-child-org-1.oktapreview.com/api/v1/orgs/my-child-org-1/contacts" + }, + "organization": { + "href": "https://my-child-org-1.oktapreview.com/api/v1/orgs/my-child-org-1" + }, + "policy": { + "href": "https://my-child-org-1.oktapreview.com/api/v1/orgs/my-child-org-1/policy" + }, + "uploadLogo": { + "href": "https://my-child-org-1.oktapreview.com/api/v1/org/logo" + } + }, + "created": "2024-08-27T15:42:52.000Z", + "edition": "SKU", + "expiresAt": null, + "id": "00o1n8sbwArJ7OQRw406", + "lastUpdated": "2024-08-27T15:42:56.000Z", + "licensing": { + "apps": [] + }, + "name": "My Child Org 1", + "settings": { + "app": { + "errorRedirectUrl": null, + "interstitialMinWaitTime": 1200, + "interstitialUrl": null + }, + "logs": { + "level": "INFO" + }, + "portal": { + "errorRedirectUrl": null, + "signOutUrl": null + }, + "userAccount": { + "attributes": { + "secondaryEmail": true, + "secondaryImage": true + } + } + }, + "status": "ACTIVE", + "subdomain": "my-child-org-1", + "token": "XXXXXXXXXXXXX", + "tokenType": "SSWS", + "website": "http://www.examplecorp.com" + } + }, + "CreateCustomIDVRequest": { + "summary": "Create Custom IDV as IdP", + "value": { + "name": "Custom IDV", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "maxClockSkew": 0, + "provisioning": { + "action": "DISABLED", + "groups": null, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "source.userName" + } + } + }, + "properties": { + "idvMetadata": { + "privacyPolicy": "https://idv.example.com/privacy", + "termsOfUse": "https://idv.example.com/terms", + "vendorDisplayName": "Custom IDV" + } + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://idv.example.com/authorize" + }, + "jwks": { + "binding": "HTTP-REDIRECT", + "url": "https://idv.example.com/jwks" + }, + "par": { + "binding": "HTTP-REDIRECT", + "url": "https://idv.example.com/par" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://idv.example.com/token" + } + }, + "issuer": { + "url": "https://idv.example.com" + }, + "scopes": [ + "profile", + "identity_assurance", + "openid" + ], + "type": "ID_PROOFING" + }, + "type": "IDV_STANDARD" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "CreateCustomRoleResponseGroup": { + "value": { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/groups/00gsr2IepS8YhHRFf0g3" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + } + }, + "assignmentType": "GROUP", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb1q92TFAHzySt3x0g4", + "label": "UserCreatorRole", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "iamoJDFKaJxGIr0oamd9g", + "role": "cr0Yq6IJxGIr0ouum0g3", + "status": "ACTIVE", + "type": "CUSTOM" + } + }, + "CreateCustomTokenClaimBody": { + "summary": "Create a custom token claim", + "value": [ + { + "alwaysIncludeInToken": true, + "claimType": "IDENTITY", + "conditions": { + "scopes": [ + "profile" + ] + }, + "group_filter_type": "CONTAINS", + "name": "Support", + "status": "ACTIVE", + "system": false, + "value": "Support", + "valueType": "GROUPS" + } + ] + }, + "CreateCustomTokenClaimResponse": { + "summary": "Create a custom token claim response", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims/{claimId}" + } + }, + "alwaysIncludeInToken": true, + "apiResourceId": null, + "claimType": "IDENTITY", + "conditions": { + "scopes": [ + "profile" + ] + }, + "group_filter_type": "CONTAINS", + "id": "{claimId}", + "name": "Support", + "status": "ACTIVE", + "system": false, + "value": "Support", + "valueType": "GROUPS" + } + ] + }, + "CreateEDNZRequest": { + "summary": "Create an enhanced dynamic network zone", + "value": { + "asns": { + "exclude": [], + "include": [] + }, + "ipServiceCategories": { + "exclude": [], + "include": [ + "ALL_ANONYMIZERS" + ] + }, + "locations": { + "exclude": [], + "include": [] + }, + "name": "testZone106", + "status": "ACTIVE", + "type": "DYNAMIC_V2", + "usage": "BLOCKLIST" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "CreateEDNZResponse": { + "summary": "Enhanced dynamic network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/zones/nzok0oz2xYHOZtIch0g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/zones/nzok0oz2xYHOZtIch0g4" + } + }, + "asns": { + "exclude": [], + "include": [] + }, + "create": "2024-05-13T16:33:44.000Z", + "id": "nzok0oz2xYHOZtIch0g4", + "ipServiceCategories": { + "exclude": [], + "include": [ + "ALL_ANONYMIZERS" + ] + }, + "lastUpdated": "2024-05-13T16:33:44.000Z", + "locations": { + "exclude": [], + "include": [] + }, + "name": "testZone106", + "status": "ACTIVE", + "system": false, + "type": "DYNAMIC_V2", + "usage": "BLOCKLIST" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "CreateEmailDomainRequest": { + "value": { + "brandId": "bnd100iSrkcN6aR680g1", + "displayName": "Admin", + "domain": "example.com", + "userName": "admin", + "validationSubdomain": "mail" + } + }, + "CreateFacebookIdPRequest": { + "summary": "Create Facebook IdP", + "value": { + "name": "Facebook", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "scopes": [ + "public_profile", + "email" + ], + "type": "OAUTH2" + }, + "type": "FACEBOOK" + } + }, + "CreateGenericOidcIdPRequest": { + "summary": "Create generic OpenID Connect IdP", + "value": { + "name": "Example OpenID Connect IdP", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 120000, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + } + }, + "subject": { + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.email" + } + }, + "trustClaims": false + }, + "protocol": { + "algorithms": { + "request": { + "signature": { + "algorithm": "HS256", + "scope": "REQUEST" + } + } + }, + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret", + "pkce_required": "true" + } + }, + "endpoints": { + "acs": { + "binding": "HTTP-POST", + "type": "INSTANCE" + }, + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/authorize" + }, + "jwks": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/keys" + }, + "slo": { + "url": "https://idp.example.com/slo" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://idp.example.com/token" + }, + "userInfo": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/userinfo" + } + }, + "issuer": { + "url": "https://idp.example.com" + }, + "scopes": [ + "openid", + "profile", + "email" + ], + "settings": { + "participateSlo": true + }, + "type": "OIDC" + }, + "type": "OIDC" + } + }, + "CreateGoogleIdPRequest": { + "summary": "Create Google IdP", + "value": { + "name": "Google", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "scopes": [ + "profile", + "email", + "openid" + ], + "type": "OAUTH2" + }, + "type": "GOOGLE" + } + }, + "CreateGroupPushMappingRequest_ExampleCreate": { + "value": { + "sourceGroupId": "00g00000000000000000", + "status": "ACTIVE", + "targetGroupName": "NewGroup" + } + }, + "CreateGroupPushMappingRequest_ExampleCreate_ActiveDirectory": { + "value": { + "appConfig": { + "distinguishedName": "dc=example,dc=com", + "groupScope": "GLOBAL", + "groupType": "SECURITY", + "samAccountName": "NewGroup", + "type": "ACTIVE_DIRECTORY" + }, + "sourceGroupId": "00g00000000000000000", + "status": "ACTIVE", + "targetGroupName": "NewGroup" + } + }, + "CreateGroupPushMappingRequest_ExampleLink": { + "value": { + "sourceGroupId": "00g00000000000000000", + "status": "ACTIVE", + "targetGroupId": "00g00000000000000001" + } + }, + "CreateGroupPushMappingResponse_ExampleCreate": { + "value": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" + }, + "sourceGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000000" + }, + "targetGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000001" + } + }, + "created": "2025-01-01T00:00:00Z", + "errorSummary": "", + "id": "gPm00000000000000000", + "lastPush": "2025-01-01T00:00:00Z", + "lastUpdated": "2025-01-01T00:00:00Z", + "sourceGroupId": "00g00000000000000000", + "status": "ACTIVE", + "targetGroupId": "00g00000000000000001" + } + }, + "CreateGroupPushMappingResponse_ExampleCreate_ActiveDirectory": { + "value": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" + }, + "sourceGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000000" + }, + "targetGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000001" + } + }, + "appConfig": { + "distinguishedName": "dc=example,dc=com", + "groupScope": "GLOBAL", + "groupType": "SECURITY", + "samAccountName": "NewGroup", + "type": "ACTIVE_DIRECTORY" + }, + "created": "2025-01-01T00:00:00Z", + "errorSummary": "", + "id": "gPm00000000000000000", + "lastPush": "2025-01-01T00:00:00Z", + "lastUpdated": "2025-01-01T00:00:00Z", + "sourceGroupId": "00g00000000000000000", + "status": "ACTIVE", + "targetGroupId": "00g00000000000000001" + } + }, + "CreateGroupPushMappingResponse_ExampleLink": { + "value": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" + }, + "sourceGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000000" + }, + "targetGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000001" + } + }, + "created": "2025-01-01T00:00:00Z", + "errorSummary": "", + "id": "gPm00000000000000000", + "lastPush": "2025-01-01T00:00:00Z", + "lastUpdated": "2025-01-01T00:00:00Z", + "sourceGroupId": "00g00000000000000000", + "status": "ACTIVE", + "targetGroupId": "00g00000000000000001" + } + }, + "CreateHookKeyResponse": { + "summary": "Create a key response example", + "value": { + "_embedded": { + "alg": "RSA", + "e": "AQAB", + "kid": "7fbc27fd-e3df-4522-86bf-1930110256ad", + "kty": "RSA", + "n": "2naqCnv6r4xNQs7207lRtKQvdtnlVND-8k5iYBIiqoKGY3CqUmRm1jleoOniiQoMkFX8Wj2DmVqr002efF3vOQ7_gjtTatBTVUNbNIQLybun4dkVoUtfP7pRc5SLpcP3eGPRVar734ZrpQXzmCEdpqBt3jrVjwYjNE5DqOjbYXFJtMsy8CWE9LRJ3kyHEoHPzo22dG_vMrXH0_sAQoCk_4TgNCbvyzVmGVYXI_BkUnp0hv2pR4bQVRYzGB9dKJdctOh8zULqc_EJ8tiYsS05YnF7whrWEyARK0rH-e4d4W-OmBTga_zhY4kJ4NsoQ4PyvcatZkxjPO92QHQOFDnf3w`", + "use": "null" + }, + "created": "2022-08-31T18:09:58.000Z", + "id": "HKY1p7jWLndGQV9M60g4", + "isUsed": "false", + "keyId": "7fbc27fd-e3df-4522-86bf-1930110256ad", + "lastUpdated": "2022-08-31T18:09:58.000Z", + "name": "My new key" + } + }, + "CreateIAMStandardRoleResponseGroup": { + "value": { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/groups/00gsr2IepS8YhHRFf0g3" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_REQUESTS_ADMIN/members/irb4jlomnnDBuBDyJ0g7" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_REQUESTS_ADMIN/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_REQUESTS_ADMIN" + } + }, + "assignmentType": "GROUP", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb1q92TFAHzySt3x0g4", + "label": "Access Requests Administrator", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", + "role": "ACCESS_REQUESTS_ADMIN", + "status": "ACTIVE", + "type": "ACCESS_REQUESTS_ADMIN" + } + }, + "CreateIPPolicyBlockListNetworkZone": { + "summary": "Create an IP blocklist network zone", + "value": { + "gateways": [ + { + "type": "CIDR", + "value": "1.2.3.4/24" + }, + { + "type": "CIDR", + "value": "2.3.4.5/24" + } + ], + "name": "newBlockListNetworkZone", + "proxies": null, + "status": "ACTIVE", + "type": "IP", + "usage": "BLOCKLIST" + } + }, + "CreateIPPolicyBlockListNetworkZoneResponse": { + "summary": "IP blocklist network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzo1qasnPb1kqEq0e0g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzo1qasnPb1kqEq0e0g4" + } + }, + "created": "2021-08-09T20:22:09.000Z", + "gateways": [ + { + "type": "CIDR", + "value": "1.2.3.4/24" + }, + { + "type": "CIDR", + "value": "2.3.4.5/24" + } + ], + "id": "nzo1qasnPb1kqEq0e0g4", + "lastUpdated": "2021-08-09T20:22:09.000Z", + "name": "newBlockListNetworkzone", + "proxies": null, + "status": "ACTIVE", + "system": false, + "type": "IP", + "usage": "BLOCKLIST" + } + }, + "CreateIPPolicyNetworkZone": { + "summary": "Create an IP policy network zone", + "value": { + "gateways": [ + { + "type": "CIDR", + "value": "1.2.3.4/24" + }, + { + "type": "CIDR", + "value": "2.3.4.5/24" + } + ], + "name": "newNetworkZone", + "proxies": [ + { + "type": "CIDR", + "value": "2.2.3.4/24" + }, + { + "type": "CIDR", + "value": "3.3.4.5/24" + } + ], + "type": "IP" + } + }, + "CreateIPPolicyNetworkZoneResponse": { + "summary": "IP policy network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowb8T5Jh5xuAJ0o0g7/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowb8T5Jh5xuAJ0o0g7" + } + }, + "created": "2021-08-09T21:32:01.000Z", + "gateways": [ + { + "type": "CIDR", + "value": "1.2.3.4/24'" + }, + { + "type": "CIDR", + "value": "2.3.4.5/24" + } + ], + "id": "nzowb8T5Jh5xuAJ0o0g7", + "lastUpdated": "2021-08-09T21:32:01.000Z", + "name": "newNetworkZone", + "proxies": [ + { + "type": "CIDR", + "value": "2.2.3.4/24" + }, + { + "type": "CIDR", + "value": "3.3.4.5/24" + } + ], + "status": "ACTIVE", + "system": false, + "type": "IP", + "usage": "POLICY" + } + }, + "CreateIncodeIDVRequest": { + "summary": "Create Incode as IdP", + "value": { + "name": "Incode IDV", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "maxClockSkew": 0, + "provisioning": { + "action": "DISABLED", + "groups": null, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "source.userName" + } + } + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "scopes": [ + "profile", + "identity_assurance", + "openid" + ], + "type": "ID_PROOFING" + }, + "type": "IDV_INCODE" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "CreateLinkedObjectRequest": { + "summary": "Create manager-subordinate link request", + "value": { + "associated": { + "description": "Subordinate link property", + "name": "subordinate", + "title": "subordinate", + "type": "USER" + }, + "primary": { + "description": "Manager link property", + "name": "manager", + "title": "manager", + "type": "USER" + } + } + }, + "CreateLinkedObjectResponse": { + "summary": "Create manager-subordinate link property response", + "value": { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/meta/schemas/user/linkedObjects/manager" + } + }, + "associated": { + "description": "Subordinate link property", + "name": "subordinate", + "title": "subordinate", + "type": "USER" + }, + "primary": { + "description": "Manager link property", + "name": "manager", + "title": "manager", + "type": "USER" + } + } + }, + "CreateMicrosoftIdPRequest": { + "summary": "Create Microsoft IdP", + "value": { + "name": "Microsoft", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "scopes": [ + "openid", + "email", + "profile", + "https://graph.microsoft.com/User.Read" + ], + "type": "OIDC" + }, + "type": "MICROSOFT" + } + }, + "CreateOAuth2ScopeRequest": { + "summary": "Example scope", + "value": { + "consent": "REQUIRED", + "description": "Drive car", + "displayName": "Saml Jackson", + "name": "car:drive" + } + }, + "CreateOktaIntegrationIdPRequest": { + "summary": "Create Okta Integration IdP", + "value": { + "name": "Example Okta Integration IdP", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "maxClockSkew": 120000, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + } + }, + "subject": { + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.email" + } + } + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "token_endpoint_auth_method": "private_key_jwt" + } + }, + "oktaIdpOrgUrl": "https://your-spoke-org.example.com", + "type": "SAML2" + }, + "type": "OKTA_INTEGRATION" + } + }, + "CreateOktaManagedUserAccountRequest": { + "summary": "Create an Okta managed user account", + "value": { + "description": "Shared admin account for managing AD integrations", + "name": "AD Integrations Admin", + "oktaUserId": "00u11s48P9zGW8yqm0g5", + "ownerGroupIds": [ + "00g57qp78yZT2XBA40g7" + ], + "ownerUserIds": [ + "00u22t59Q0aHbNEXi1h8" + ] + } + }, + "CreateOrReplaceSMSTemplateRequest": { + "value": { + "name": "Custom", + "template": "${org.name}: your verification code is ${code}", + "translations": { + "es": "${org.name}: el c\u00f3digo de verificaci\u00f3n es ${code}", + "fr": "${org.name}: votre code de v\u00e9rification est ${code}", + "it": "${org.name}: il codice di verifica \u00e8 ${code}" + }, + "type": "SMS_VERIFY_CODE" + } + }, + "CreateOrReplaceSMSTemplateResponse": { + "value": { + "created": "2024-04-25T17:35:02.000Z", + "id": "6NQUJ5yR3bpgEiYmq8IC", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Custom", + "template": "${org.name}: your verification code is ${code}", + "translations": { + "es": "${org.name}: el c\u00f3digo de verificaci\u00f3n es ${code}", + "fr": "${org.name}: votre code de v\u00e9rification est ${code}", + "it": "${org.name}: il codice di verifica \u00e8 ${code}" + }, + "type": "SMS_VERIFY_CODE" + } + }, + "CreatePersonaIDVRequest": { + "summary": "Create Persona as IdP", + "value": { + "name": "Persona IDV", + "policy": { + "maxClockSkew": 0, + "provisioning": { + "action": "DISABLED", + "groups": null, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "source.userName" + } + } + }, + "properties": { + "inquiryTemplateId": "itmpl_HSctx8fNvXoHtrQfz2hxUVH8RBjG" + }, + "protocol": { + "credentials": { + "bearer": { + "apiKey": "your-api-key" + } + }, + "type": "ID_PROOFING" + }, + "type": "IDV_PERSONA" + } + }, + "CreateRealmAssignmentRequest": { + "value": { + "actions": { + "assignUserToRealm": { + "realmId": "00g1b7rvh0xPLKXFf0g5" + } + }, + "conditions": { + "expression": { + "value": "user.profile.role ==\\\"Manager\\\"" + }, + "profileSourceId": "0oa4enoRyjwSCy5hx0g4" + }, + "name": "Realm Assignment 1", + "priority": 0 + } + }, + "CreateRealmRequest": { + "value": { + "profile": { + "domains": [ + "atko.com", + "user.com" + ], + "name": "Car Co", + "realmType": "PARTNER" + } + } + }, + "CreateSamlIdPRequest": { + "summary": "Create SAML 2.0 IdP", + "value": { + "name": "Example SAML IdP", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": "(\\S+@example\\.com)", + "format": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified" + ], + "matchType": "USERNAME", + "userNameTemplate": { + "template": "saml.subjectNameId" + } + } + }, + "protocol": { + "algorithms": { + "request": { + "signature": { + "algorithm": "SHA-256", + "scope": "REQUEST" + } + }, + "response": { + "signature": { + "algorithm": "SHA-256", + "scope": "ANY" + } + } + }, + "credentials": { + "trust": { + "additionalKids": [ + "additional-key-id" + ], + "audience": "http://www.okta.com/123", + "issuer": "https://idp.example.com", + "kid": "your-key-id" + } + }, + "endpoints": { + "acs": { + "binding": "HTTP-POST", + "type": "INSTANCE" + }, + "slo": { + "binding": "HTTP-POST", + "url": "https://idp.example.com/slo" + }, + "sso": { + "binding": "HTTP-POST", + "destination": "https://idp.example.com", + "url": "https://idp.example.com" + } + }, + "settings": { + "participateSlo": true + }, + "type": "SAML2" + }, + "type": "SAML2" + } + }, + "CreateSessionBody": { + "summary": "Create a new session with a valid session token", + "value": { + "sessionToken": "00HiohZYpJgMSHwmL9TQy7RRzuY-q9soKp1SPmYYow" + } + }, + "CreateSessionResponse": { + "summary": "Create a new session with a valid session token", + "value": { + "_links": { + "href": "https://{yourOktaDomain}/api/v1/sessions/l7FbDVqS8zHSy65uJD85", + "self": { + "hints": { + "allow": [ + "DELETE" + ] + } + } + }, + "amr": [ + "pwd" + ], + "createdAt": "2019-08-24T14:15:22Z", + "expiresAt": "2019-08-24T14:15:22Z", + "id": "l7FbDVqS8zHSy65uJD85", + "idp": { + "id": "01a2bcdef3GHIJKLMNOP", + "type": "ACTIVE_DIRECTORY" + }, + "lastFactorVerification": "2019-08-24T14:15:22Z", + "lastPasswordVerification": "2019-08-24T14:15:22Z", + "login": "user@example.com", + "status": "ACTIVE", + "userId": "00u0abcdefGHIJKLMNOP" + } + }, + "CreateSmartCardIdPRequest": { + "summary": "Create SmartCard IdP", + "value": { + "name": "Smart Card IDP Name", + "policy": { + "mapAMRClaims": false, + "maxClockSkew": 120000, + "provisioning": { + "action": "DISABLED" + }, + "subject": { + "matchAttribute": "", + "matchType": "EMAIL", + "userNameTemplate": { + "template": "idpuser.subjectAltNameEmail" + } + }, + "trustClaims": false + }, + "properties": { + "additionalAmr": [ + "sc", + "hwk", + "pin", + "mfa" + ] + }, + "protocol": { + "credentials": { + "trust": { + "issuer": "your-issuer", + "kid": "your-kid", + "revocation": "CRL", + "revocationCacheLifetime": 2880 + } + }, + "type": "MTLS" + }, + "status": "ACTIVE", + "type": "X509" + } + }, + "CreateStandardRoleAssignmentResponseGroup": { + "value": { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/groups/00gsr2IepS8YhHRFf0g3" + } + }, + "assignmentType": "GROUP", + "created": "2019-02-27T14:56:55.000Z", + "id": "grasraHPx7i79ajaJ0g3", + "label": "Organization Administrator", + "lastUpdated": "2019-02-27T14:56:55.000Z", + "status": "ACTIVE", + "type": "ORG_ADMIN" + } + }, + "CreateUISchemaBody": { + "summary": "UI schema body request", + "value": { + "uiSchema": { + "buttonLabel": "Submit", + "elements": [ + { + "label": "First Name", + "options": { + "format": "text" + }, + "scope": "#/properties/firstName", + "type": "Control" + }, + { + "label": "Last Name", + "options": { + "format": "text" + }, + "scope": "#/properties/lastName", + "type": "Control" + }, + { + "label": "Primary email", + "options": { + "format": "text" + }, + "scope": "#/properties/email", + "type": "Control" + } + ], + "label": "Sign in", + "type": "Group" + } + } + }, + "CreateUISchemaResponse": { + "summary": "Returns full UI schema body", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://exmaple.com/api/v1/meta/uischemas/uis4a7liocgcRgcxZ0g7" + } + }, + "created": "2022-07-25T12:56:31.000Z", + "id": "uis4a7liocgcRgcxZ0g7", + "lastUpdated": "2022-07-26T11:53:59.000Z", + "uiSchema": { + "buttonLabel": "Submit", + "elements": [ + { + "label": "First name", + "options": { + "format": "text" + }, + "scope": "#/properties/firstName", + "type": "Control" + }, + { + "label": "Last name", + "options": { + "format": "text" + }, + "scope": "#/properties/lastName", + "type": "Control" + }, + { + "label": "Primary email", + "options": { + "format": "text" + }, + "scope": "#/properties/email", + "type": "Control" + } + ], + "label": "Sign in", + "type": "Group" + } + } + }, + "CreateUpdateEmailCustomizationRequest": { + "value": { + "body": "

Bonjour ${user.profile.firstName}. Activer le compte

", + "isDefault": false, + "language": "fr", + "subject": "Bienvenue dans ${org.name}!" + } + }, + "CreateUpdateEmailCustomizationResponse": { + "value": { + "_links": { + "preview": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4/preview" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4" + }, + "template": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + }, + "test": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" + } + }, + "body": "

Bonjour ${user.profile.firstName}. Activer le compte

", + "created": "2021-11-09T20:38:10.000Z", + "id": "oel11u6DqUiMbQkpl0g4", + "isDefault": false, + "language": "fr", + "lastUpdated": "2021-11-11T20:38:10.000Z", + "subject": "Bienvenue dans ${org.name}!" + } + }, + "CreateUpdateIamRolePermissionRequestExampleWithExclude": { + "value": { + "conditions": { + "exclude": { + "okta:ResourceAttribute/User/Profile": [ + "zipCode" + ] + } + } + } + }, + "CreateUpdateIamRolePermissionRequestExampleWithInclude": { + "value": { + "conditions": { + "include": { + "okta:ResourceAttribute/User/Profile": [ + "city", + "state" + ] + } + } + } + }, + "CreateUserRequest": { + "summary": "Create a user type request", + "value": { + "description": "A new custom user type", + "displayName": "New user type", + "name": "newUserType" + } + }, + "CreateUserResponse": { + "summary": "Create a user type response", + "value": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + } + }, + "created": "2021-07-05T20:40:38.000Z", + "createdBy": "sprz9fj1ycBcsgopy1d6", + "default": false, + "description": "A new custom user type", + "displayName": "New user type", + "id": "otyfnly5cQjJT9PnR0g4", + "lastUpdated": "2021-07-05T20:40:38.000Z", + "lastUpdatedBy": "sprz9fj1ycBcsgopy1d6", + "name": "newUserType" + } + }, + "CsrJsonResponse": { + "summary": "CSR object in JSON format", + "value": { + "_links": { + "publish": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50/lifecycle/publish" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50" + } + }, + "created": "2017-03-28T01:11:10.000Z", + "csr": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9/tKvvbFN59T4raoCs/78KRm4fSefHQOv1TKLXo4wTLbsqYWRWc5u0sd5orUMQgPQOyj3i6qh13mALY4BzrT057EG1BUNjGg29QgYlnOk2iX890e5BIDMQQEIKFrvOi2V8cLUkLvE2ydRn0VO1Q1frbUkYeStJYC5Api2JQsYRwa+1ZeDH1ITnIzUaugWhW2WB2lSnwZkenne5KtffxMPYVu+IhNRHoKaRA6Z51YNhMJIx17JM2hs/H4Ka3drk6kzDf7ofk/yBpb9yBWyU7CTSQhdoHidxqFprMDaT66W928t3AeOENHBuwn8c2K9WeGG+bELNyQRJVmawIDAQABoCowKAYJKoZIhvcNAQkOMRswGTAXBgNVHREEEDAOggxkZXYub2t0YS5jb20wDQYJKoZIhvcNAQELBQADggEBAA2hsVJRVM+A83X9MekjTnIbt19UNT8wX7wlE9jUKirWsxceLiZBpVGn9qfKhhVIpvdaIRSeoFYS2Kg/m1G6bCvjmZLcrQ5FcEBjZH2NKfNppGVnfC2ugtUkBtCB+UUzOhKhRKJtGugenKbP33zRWWIqnd2waF6Cy8TIuqQVPbwEDN9bCbAs7ND6CFYNguY7KYjWzQOeAR716eqpEEXuPYAS4nx/ty4ylonR8cv+gpq51rvq80A4k/36aoeM0Y6I4w64vhTfuvWW2UYFUD+/+y2FA2CSP4JfctySrf1s525v6fzTFZ3qZbB5OZQtP2b8xYWktMzywsxGKDoVDB4wkH4=", + "id": "h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50", + "kty": "RSA" + } + }, + "CsrPkcs10Response": { + "summary": "CSR in DER format", + "value": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9" + }, + "CustomAAGUIDRequest": { + "summary": "Create a custom AAGUID", + "value": { + "aaguid": "cb69481e-8ff7-4039-93ec-0a272911111", + "attestationRootCertificates": [ + { + "x5c": "X5C..." + } + ], + "authenticatorCharacteristics": { + "fipsCompliant": false, + "hardwareProtected": false, + "platformAttached": false + }, + "name": "My Security Key" + } + }, + "CustomAAGUIDResponse": { + "summary": "Custom AAGUID", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "PATCH", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/aaguids/cb69481e-8ff7-4039-93ec-0a272911111" + } + }, + "aaguid": "cb69481e-8ff7-4039-93ec-0a272911111", + "attestationRootCertificates": [ + { + "exp": "2035-05-26T16:04:58.000Z", + "iss": "Yubico U2F Root CA Serial 457200631", + "x5c": "X5C...", + "x5t#S256": "SHA-256 x5t of the X.509 root certificate" + } + ], + "authenticatorCharacteristics": { + "fipsCompliant": false, + "hardwareProtected": false, + "platformAttached": false + }, + "name": "My Security Key" + } + }, + "CustomAAGUIDUpdateRequest": { + "summary": "Update a custom AAGUID", + "value": { + "attestationRootCertificates": [ + { + "x5c": "X5C..." + } + ], + "authenticatorCharacteristics": { + "fipsCompliant": false, + "hardwareProtected": false, + "platformAttached": false + }, + "name": "My Security Key" + } + }, + "CustomAuthSettings": { + "summary": "Custom auth settings example", + "value": { + "appInstanceProperties": [ + { + "label": "API Key", + "name": "apiKey" + }, + { + "label": "API Secret", + "name": "apiSecret" + } + ], + "authType": "CUSTOM", + "customSettings": null + } + }, + "CustomIDVResponse": { + "summary": "Custom IDV as IdP", + "value": { + "_links": { + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa2pstvoFV4GYCw30g5/users" + } + }, + "created": "2025-01-15T20:54:04.000Z", + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa2pstvoFV4GYCw30g5/lifecycle/deactivate" + }, + "id": "0oa2pstvoFV4GYCw30g5", + "lastUpdated": "2025-01-15T20:54:05.000Z", + "name": "Custom IDV IdP", + "policy": { + "maxClockSkew": 0, + "provisioning": { + "action": "DISABLED", + "groups": null, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "source.userName" + } + } + }, + "properties": { + "idvMetadata": { + "privacyPolicy": "https://idv.example.com/privacy", + "termsOfUse": "https://idv.example.com/terms", + "vendorDisplayName": "Custom IDV" + } + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://idv.example.com/authorize" + }, + "jwks": { + "binding": "HTTP-REDIRECT", + "url": "https://idv.example.com/jwks" + }, + "par": { + "binding": "HTTP-REDIRECT", + "url": "https://idv.example.com/par" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://idv.example.com/token" + } + }, + "issuer": { + "url": "https://idv.example.com" + }, + "scopes": [ + "openid", + "profile", + "identity_assurance" + ], + "type": "ID_PROOFING" + }, + "status": "ACTIVE", + "type": "IDV_STANDARD" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "CustomRoleAssignmentRequest": { + "value": { + "resource-set": "iam4cxy6z7hhaZCSk0g7", + "role": "cr04cxy6yzSCtNciD0g7", + "type": "CUSTOM" + } + }, + "CustomRoleResponseClient": { + "value": { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oa4ee9vgbIuqTUvd0g7" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iam4cxy6z7hhaZCSk0g7/bindings/cr04cxy6yzSCtNciD0g7/members/irb4ey26fpFI3vQ8y0g7" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr04cxy6yzSCtNciD0g7/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iam4cxy6z7hhaZCSk0g7" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr04cxy6yzSCtNciD0g7" + } + }, + "assignmentType": "CLIENT", + "created": "2023-05-01T15:16:47.000Z", + "id": "irb4ey26fpFI3vQ8y0g7", + "label": "view_minimal", + "lastUpdated": "2023-05-01T15:16:47.000Z", + "resource-set": "iam4cxy6z7hhaZCSk0g7", + "role": "cr04cxy6yzSCtNciD0g7", + "status": "ACTIVE", + "type": "CUSTOM" + } + }, + "CustomRoleResponseUser": { + "value": { + "_links": { + "assignee": { + "href\"": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb1q92TFAHzySt3x0g4", + "label": "UserCreatorRole", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "iamoJDFKaJxGIr0oamd9g", + "role": "cr0Yq6IJxGIr0ouum0g3", + "status": "ACTIVE", + "type": "CUSTOM" + } + }, + "CustomRolesListResponseClient": { + "value": [ + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oa4ee9vgbIuqTUvd0g7" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iam4cxy6z7hhaZCSk0g7/bindings/cr04cxy6yzSCtNciD0g7/members/irb4ey26fpFI3vQ8y0g7" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr04cxy6yzSCtNciD0g7/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iam4cxy6z7hhaZCSk0g7" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr04cxy6yzSCtNciD0g7" + } + }, + "assignmentType": "CLIENT", + "created": "2023-05-01T15:16:47.000Z", + "id": "irb4ey26fpFI3vQ8y0g7", + "label": "view_minimal", + "lastUpdated": "2023-05-01T15:16:47.000Z", + "resource-set": "iam4cxy6z7hhaZCSk0g7", + "role": "cr04cxy6yzSCtNciD0g7", + "status": "ACTIVE", + "type": "CUSTOM" + } + ] + }, + "CustomRolesListResponseGroup": { + "value": [ + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3/members/irb1qe6PGuMc7Oh8N0g4" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/cr0Yq6IJxGIr0ouum0g3/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + } + }, + "assignmentType": "GROUP", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb1q92TFAHzySt3x0g4", + "label": "UserCreatorRole", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "iamoJDFKaJxGIr0oamd9g", + "role": "cr0Yq6IJxGIr0ouum0g3", + "status": "ACTIVE", + "type": "CUSTOM" + } + ] + }, + "CustomTelephonyProviderCredentialCreateRequestTelesignEx": { + "summary": "Create a Telesign custom telephony provider", + "value": { + "providerAuthToken": "67bf6c435967abe806f4f0d6eg2p645", + "providerCapability": "ALL", + "providerName": "TELESIGN", + "providerSettings": { + "call": { + "telesignService": "telesignVerifyService" + }, + "sms": { + "telesignService": "telesignMessagingService" + } + }, + "providerSid": "CF98EDb19a09b2f5d2f121fe1c207722F7" + } + }, + "CustomTelephonyProviderCredentialCreateRequestTwilioEx": { + "summary": "Create a Twilio custom telephony provider", + "value": { + "providerAuthToken": "11a9b6c435967abe806f4f0d6ec0f382", + "providerCapability": "ALL", + "providerName": "TWILIO", + "providerSettings": { + "call": { + "twilioVerifySid": "example-verify-sid" + }, + "sms": { + "twilioPhoneNumber": "+1234567890" + } + }, + "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" + } + }, + "CustomTelephonyProviderCredentialCreateResponseTelesignEx": { + "summary": "Response for Telesign custom telephony provider", + "value": { + "enabled": true, + "id": "oct1ko8bzvN4smpBU0g5", + "isPrimaryProvider": true, + "providerCapability": "ALL", + "providerName": "TELESIGN", + "providerSettings": { + "call": { + "telesignService": "telesignVoiceService" + }, + "sms": { + "telesignService": "telesignMessagingService" + } + }, + "providerSid": "ACl82fb19a09b2b422f121fe1c2076ch29" + } + }, + "CustomTelephonyProviderCredentialCreateResponseTwilioEx": { + "summary": "Response for Twilio custom telephony provider", + "value": { + "enabled": true, + "id": "oct3v00k4iOFlEJmQ806", + "isPrimaryProvider": true, + "providerCapability": "ALL", + "providerName": "TWILIO", + "providerSettings": { + "call": { + "twilioVerifySid": "example-verify-sid" + }, + "sms": { + "twilioPhoneNumber": "+1234567890" + } + }, + "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" + } + }, + "CustomTelephonyProviderCredentialDeactivatedResponseEx": { + "summary": "Response for deactivated custom telephony provider", + "value": { + "enabled": false, + "id": "oct3v00k4iOFlEJmQ806", + "isPrimaryProvider": false, + "providerCapability": "ALL", + "providerName": "TWILIO", + "providerSettings": { + "call": { + "twilioVerifySid": "example-verify-sid" + }, + "sms": { + "twilioPhoneNumber": "+1234567890" + } + }, + "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" + } + }, + "CustomTelephonyProviderCredentialListOneResponseEx": { + "summary": "Response for credentials of one custom telephony provider", + "value": { + "enabled": true, + "id": "oct3v00k4iOFlEJmQ806", + "isPrimaryProvider": true, + "providerCapability": "ALL", + "providerName": "TWILIO", + "providerSettings": { + "call": { + "twilioVerifySid": "example-verify-sid" + }, + "sms": { + "twilioPhoneNumber": "+1234567890" + } + }, + "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" + } + }, + "CustomTelephonyProviderCredentialPrimaryResponseEx": { + "summary": "Response for setting primary custom telephony provider", + "value": { + "enabled": true, + "id": "oct3v00k4iOFlEJmQ806", + "isPrimaryProvider": true, + "providerCapability": "ALL", + "providerName": "TWILIO", + "providerSettings": { + "call": { + "twilioVerifySid": "example-verify-sid" + }, + "sms": { + "twilioPhoneNumber": "+1234567890" + } + }, + "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" + } + }, + "CustomTelephonyProviderCredentialSendTestRequestEx": { + "summary": "Send test SMS message", + "value": { + "countryCodeIso2": "US", + "factor": "SMS", + "phoneNumber": "+1234567890" + } + }, + "CustomTelephonyProviderCredentialUpdateRequestEx": { + "summary": "Update custom telephony provider credentials", + "value": { + "id": "oct3v00k4iOFlEJmQ806", + "providerAuthToken": "11a9b6c435967abe806f4f0d6ec0f382", + "providerSettings": { + "call": { + "twilioVerifySid": "updated-verify-sid" + }, + "sms": { + "twilioPhoneNumber": "+1234567890" + } + }, + "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" + } + }, + "CustomTelephonyProviderCredentialsListAllResponseEx": { + "summary": "List of custom telephony provider credentials", + "value": [ + { + "enabled": true, + "id": "oct3v00k4iOFlEJmQ806", + "isPrimaryProvider": true, + "providerCapability": "ALL", + "providerName": "TWILIO", + "providerSettings": { + "call": { + "twilioVerifySid": "example-verify-sid" + }, + "sms": { + "twilioPhoneNumber": "+1234567890" + } + }, + "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" + }, + { + "enabled": true, + "id": "oct3v00k4iOFlEG3dR45", + "isPrimaryProvider": false, + "providerCapability": "ALL", + "providerName": "TELESIGN", + "providerSettings": { + "call": { + "telesignService": "telesignVerifyService" + }, + "sms": { + "telesignService": "telesignMessagingService" + } + }, + "providerSid": "AC42tfy19a09b2f5d2f121fe1c207fg456r" + } + ] + }, + "CustomTelephonyProviderCredentialsUpdateResponseEx": { + "summary": "Response for updated custom telephony provider", + "value": { + "enabled": true, + "id": "oct3v00k4iOFlEJmQ806", + "isPrimaryProvider": true, + "providerCapability": "ALL", + "providerName": "TWILIO", + "providerSettings": { + "call": { + "twilioVerifySid": "updated-verify-sid" + }, + "sms": { + "twilioPhoneNumber": "+1234567890" + } + }, + "providerSid": "11a9b6c435967abe806f4f0d6ec0f382" + } + }, + "DbscRefreshResponseExample": { + "summary": "Successful DBSC refresh", + "value": { + "credentials": [ + { + "attributes": "Domain=example.okta.com; Path=/; Secure; HttpOnly; SameSite=None", + "name": "dbsc", + "type": "cookie" + } + ], + "refresh_url": "/idp/dbsc/refresh", + "scope": { + "include_site": false, + "origin": "https://example.okta.com" + }, + "session_identifier": "NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs" + } + }, + "DbscStartResponseExample": { + "summary": "Successful DBSC registration", + "value": { + "credentials": [ + { + "attributes": "Domain=example.okta.com; Path=/; Secure; HttpOnly; SameSite=None", + "name": "dbsc", + "type": "cookie" + } + ], + "refresh_url": "/idp/dbsc/refresh", + "scope": { + "include_site": false, + "origin": "https://example.okta.com" + }, + "session_identifier": "NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs" + } + }, + "DeactivateIdPResponse": { + "summary": "Deactivate an IdP", + "value": { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62bfdiumsUndnZ0h7&\n client_id={clientId}&response_type={responseType}&response_mode={responseMode}&\n scope={scopes}&redirect_uri={redirectUri}&state={state}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2016-03-24T23:21:49.000Z", + "id": "0oa62bfdiumsUndnZ0h7", + "lastUpdated": "2016-03-25T19:16:53.000Z", + "name": "Google", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://accounts.google.com/o/oauth2/auth" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://www.googleapis.com/oauth2/v3/token" + } + }, + "scopes": [ + "profile", + "email", + "openid" + ], + "type": "OIDC" + }, + "status": "INACTIVE", + "type": "GOOGLE" + } + }, + "DeactivateNetworkZone": { + "summary": "Deactivated network zone", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3" + } + }, + "created": "2021-06-24T20:37:32.000Z", + "gateways": [ + { + "type": "CIDR", + "value": "1.2.3.4/24" + } + ], + "id": "nzowc1U5Jh5xuAK0o0g3", + "lastUpdated": "2021-06-24T20:37:32.000Z", + "name": "MyIpZone", + "proxies": [ + { + "type": "RANGE", + "value": "3.3.4.5-3.3.4.15" + } + ], + "status": "INACTIVE", + "system": false, + "type": "IP", + "usage": "POLICY" + } + }, + "DeactivatedSecurityEventsProviderResponse": { + "summary": "Inactive security events provider", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.okta.com/api/v1/security-events-providers/sse1qg25RpusjUP6m0g5/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://example.okta.com/api/v1/security-events-providers/sse1qg25RpusjUP6m0g5" + } + }, + "id": "sse1qg25RpusjUP6m0g5", + "name": "Security events provider with well-known URL", + "settings": { + "issuer": "Issuer", + "jwks_url": "https://example.okta.com/jwks/path", + "well_known_url": "https://example.okta.com/.well-known/ssf-configuration" + }, + "status": "INACTIVE", + "type": "okta" + } + }, + "DefaultAppUserSchemaResponse": { + "value": { + "$schema": "http://json-schema.org/draft-04/schema#", + "created": "2015-02-02T10:27:36.000Z", + "definitions": { + "base": { + "id": "#base", + "properties": { + "email": { + "description": "End-User's preferred email address.", + "master": { + "type": "PROFILE_MASTER" + }, + "scope": "SELF", + "title": "Email", + "type": "string" + }, + "name": { + "description": "End-User's full name in displayable form.", + "master": { + "type": "PROFILE_MASTER" + }, + "scope": "SELF", + "title": "Name", + "type": "string" + }, + "userName": { + "master": { + "type": "PROFILE_MASTER" + }, + "required": true, + "scope": "SELF", + "title": "Username", + "type": "string" + } + }, + "required": [ + "userName" + ], + "type": "object" + }, + "custom": { + "id": "#custom", + "properties": {}, + "type": "object" + }, + "properties": { + "profile": { + "allOf": [ + { + "$ref": "#/definitions/base" + }, + { + "$ref": "#/definitions/custom" + } + ] + } + }, + "type": "object" + }, + "id": "https://{yourOktaDomain}/meta/schemas/apps/{appId}/default", + "lastUpdated": "2015-09-05T10:40:45.000Z", + "name": "Example app", + "title": "Example app User" + } + }, + "DefaultEnhancedDynamicNetworkZone": { + "summary": "Default enhanced dynamic network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6" + } + }, + "asns": { + "exclude": [], + "include": [] + }, + "created": "2024-05-06T19:12:29.000Z", + "id": "nzohcnxFrSgsiwyHp0g4", + "ipServiceCategories": { + "exclue": [], + "include": [ + "ALL_ANONYMIZERS" + ] + }, + "lastUpdated": "2024-05-09T21:02:31.000Z", + "locations": { + "exclude": [], + "include": [] + }, + "name": "DefaultEnhancedDynamicZone", + "status": "ACTIVE", + "system": true, + "type": "DYNAMIC_V2", + "usage": "BLOCKLIST" + } + }, + "DefaultIpBlocklistNetworkZone": { + "summary": "Default IP blocklist network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6" + } + }, + "created": "2021-06-09T21:32:46.000Z", + "gateways": null, + "id": "nzou3u0stMCmgOzXK1d6", + "lastUpdated": "2021-06-09T21:32:46.000Z", + "name": "BlockedIpZone", + "proxies": null, + "status": "ACTIVE", + "system": true, + "type": "IP", + "usage": "BLOCKLIST" + } + }, + "DefaultIpNetworkZone": { + "summary": "Default IP network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0ssJfZjYsWL1d6/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0ssJfZjYsWL1d6" + } + }, + "created": "2021-06-09T21:32:46.000Z", + "gateways": null, + "id": "nzou3u0ssJfZjYsWL1d6", + "lastUpdated": "2021-06-09T21:32:46.000Z", + "name": "LegacyIpZone", + "proxies": null, + "status": "ACTIVE", + "system": true, + "type": "IP", + "usage": "POLICY" + } + }, + "DefaultRealmAssignment": { + "value": { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/realm-assignments/rul2jy7jLUlnO5ng00g4", + "method": "GET", + "rel": "self" + } + }, + "actions": { + "assignUserToRealm": { + "realmId": "00g1b7rvh0xPLKXFf2g5" + } + }, + "conditions": { + "expression": { + "value": "string" + }, + "profileSourceId": "0oa4enoRyjwSCy6hx0g4," + }, + "created": "2022-04-04T15:56:05.000Z", + "id": "rul2jy7jLUlnO5ng00g4", + "isDefault": true, + "lastUpdated": "2022-05-05T18:15:44.000Z", + "name": "Catch-all", + "priority": 499, + "status": "ACTIVE" + } + }, + "DefaultRealmResponse": { + "value": { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/realms/guox9jQ16k9V8IQWL0g3", + "method": "GET", + "rel": "self" + } + }, + "created": "2022-04-04T15:56:05.000Z", + "id": "guox9jQ16k9V8IQWL0g3", + "isDefault": true, + "lastUpdated": "2022-05-05T18:15:44.000Z", + "profile": { + "name": "Default realm" + } + } + }, + "DeviceAssuranceAndroidRequest": { + "summary": "Android request", + "value": { + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "jailbreak": false, + "name": "Device assurance Android", + "osVersion": { + "minimum": "12" + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + } + }, + "DeviceAssuranceAndroidResponse": { + "summary": "Android response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "jailbreak": false, + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Android", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + } + }, + "DeviceAssuranceAndroidWithAndroidDeviceTrustThirdPartySignalProvidersRequest": { + "summary": "Android with Android Device Trust as third-party signal provider request", + "value": { + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "jailbreak": false, + "name": "Device assurance Android with Android Device Trust third-party signals", + "osVersion": { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 0, + "latestSecurityPatch": true, + "type": "EXACT" + } + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "androidDeviceTrust": { + "deviceIntegrityLevel": "MEETS_STRONG_INTEGRITY", + "networkProxyDisabled": true, + "playProtectVerdict": "LOW", + "requireMajorVersionUpdate": true, + "screenLockComplexity": "HIGH", + "usbDebuggingDisabled": true, + "wifiSecured": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceAndroidWithAndroidDeviceTrustThirdPartySignalProvidersResponse": { + "summary": "Android with Android Device Trust as third-party signal provider response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "jailbreak": false, + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Android with Android Device Trust third-party signals", + "osVersion": { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 0, + "latestSecurityPatch": true, + "type": "EXACT" + } + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "androidDeviceTrust": { + "deviceIntegrityLevel": "MEETS_STRONG_INTEGRITY", + "networkProxyDisabled": true, + "playProtectVerdict": "LOW", + "requireMajorVersionUpdate": true, + "screenLockComplexity": "HIGH", + "usbDebuggingDisabled": true, + "wifiSecured": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceAndroidWithCallerContextRequest": { + "summary": "Android with caller context request", + "value": { + "callerContext": { + "managedApp": true + }, + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "jailbreak": false, + "name": "Device assurance Android", + "osVersion": { + "minimum": "12" + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "DeviceAssuranceAndroidWithCallerContextResponse": { + "summary": "Android with caller context response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "callerContext": { + "managedApp": true + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "jailbreak": false, + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Android", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "DeviceAssuranceAndroidWithDevicePostureIdPThirdPartySignalProvidersRequest": { + "summary": "Android with Device Posture IdP as third-party signal provider request", + "value": { + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "jailbreak": false, + "name": "Device assurance Android", + "osVersion": { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 0, + "latestSecurityPatch": true, + "type": "EXACT" + } + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "devicePostureIdP": { + "compliant": true, + "managed": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceAssuranceAndroidWithDevicePostureIdPThirdPartySignalProvidersResponse": { + "summary": "Android with Device Posture IdP as third-party signal provider response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "jailbreak": false, + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Android", + "osVersion": { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 0, + "latestSecurityPatch": true, + "type": "EXACT" + } + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "devicePostureIdP": { + "compliant": true, + "managed": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceAssuranceAndroidWithDynamicVersionRequirementRequest": { + "summary": "Android with dynamic version requirement request", + "value": { + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "jailbreak": false, + "name": "Device assurance Android", + "osVersion": { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 0, + "type": "MINIMUM" + } + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceAndroidWithDynamicVersionRequirementResponse": { + "summary": "Android with dynamic version requirement response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "jailbreak": false, + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Android", + "osVersion": { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 0, + "type": "MINIMUM" + } + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceAndroidWithGracePeriodRequest": { + "summary": "Android with due by date grace period request", + "value": { + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "displayRemediationMode": "SHOW", + "gracePeriod": { + "expiry": "2024-12-01T00:00:00.00Z", + "type": "BY_DATE_TIME" + }, + "jailbreak": false, + "name": "Device assurance Android Grace Period", + "osVersion": { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 0, + "type": "MINIMUM" + } + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceAndroidWithGracePeriodResponse": { + "summary": "Android with due by date grace period response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "USER", + "FULL" + ] + }, + "displayRemediationMode": "SHOW", + "gracePeriod": { + "expiry": "2024-12-01T00:00:00.00Z", + "type": "BY_DATE_TIME" + }, + "id": "dae3m8o4rWhwReDeM1c5", + "jailbreak": false, + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Android", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "ANDROID", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceChromeOSWithDevicePostureIdPThirdPartySignalProvidersRequest": { + "summary": "ChromeOS with Device Posture IdP as third-party signal provider request", + "value": { + "name": "Device assurance ChromeOS", + "platform": "CHROMEOS", + "thirdPartySignalProviders": { + "devicePostureIdP": { + "compliant": true, + "managed": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceAssuranceChromeOSWithDevicePostureIdPThirdPartySignalProvidersResponse": { + "summary": "ChromeOS with Device Posture IdP as third-party signal provider response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance ChromeOS", + "platform": "CHROMEOS", + "thirdPartySignalProviders": { + "devicePostureIdP": { + "compliant": true, + "managed": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceAssuranceChromeOSWithDeviceTrustConnectorThirdPartySignalProvidersRequest": { + "summary": "ChromeOS with Device Trust Connector as third-party signal provider request", + "value": { + "name": "Device assurance ChromeOS", + "platform": "CHROMEOS", + "thirdPartySignalProviders": { + "dtc": { + "allowScreenLock": true, + "browserVersion": { + "minimum": "15393.27.0" + }, + "builtInDnsClientEnabled": true, + "chromeRemoteDesktopAppBlocked": true, + "deviceEnrollmentDomain": "testDomain", + "diskEncrypted": true, + "keyTrustLevel": "CHROME_OS_VERIFIED_MODE", + "osFirewall": true, + "osVersion": { + "minimum": "10.0.19041.1110" + }, + "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", + "realtimeUrlCheckMode": true, + "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", + "screenLockSecured": true, + "siteIsolationEnabled": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceChromeOSWithDeviceTrustConnectorThirdPartySignalProvidersResponse": { + "summary": "ChromeOS with Device Trust Connector as third-party signal provider response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance ChromeOS", + "platform": "CHROMEOS", + "thirdPartySignalProviders": { + "dtc": { + "allowScreenLock": true, + "browserVersion": { + "minimum": "15393.27.0" + }, + "builtInDnsClientEnabled": true, + "chromeRemoteDesktopAppBlocked": true, + "deviceEnrollmentDomain": "testDomain", + "diskEncrypted": true, + "keyTrustLevel": "CHROME_OS_VERIFIED_MODE", + "osFirewall": true, + "osVersion": { + "minimum": "10.0.19041.1110" + }, + "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", + "realtimeUrlCheckMode": true, + "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", + "screenLockSecured": true, + "siteIsolationEnabled": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceChromeOSWithGracePeriodRequest": { + "summary": "ChromeOS with 7 day grace period request", + "value": { + "displayRemediationMode": "SHOW", + "gracePeriod": { + "expiry": "P7D", + "type": "BY_DURATION" + }, + "name": "Device assurance ChromeOS", + "platform": "CHROMEOS", + "thirdPartySignalProviders": { + "dtc": { + "allowScreenLock": true, + "browserVersion": { + "minimum": "15393.27.0" + }, + "builtInDnsClientEnabled": true, + "chromeRemoteDesktopAppBlocked": true, + "deviceEnrollmentDomain": "testDomain", + "diskEncrypted": true, + "keyTrustLevel": "CHROME_OS_VERIFIED_MODE", + "osFirewall": true, + "osVersion": { + "minimum": "10.0.19041.1110" + }, + "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", + "realtimeUrlCheckMode": true, + "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", + "screenLockSecured": true, + "siteIsolationEnabled": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceChromeOSWithGracePeriodResponse": { + "summary": "ChromeOS with due by days grace period response", + "value": { + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "displayRemediationMode": "SHOW", + "gracePeriod": { + "expiry": "P7D", + "type": "BY_DURATION" + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance ChromeOS", + "platform": "CHROMEOS", + "thirdPartySignalProviders": { + "dtc": { + "allowScreenLock": true, + "browserVersion": { + "minimum": "15393.27.0" + }, + "builtInDnsClientEnabled": true, + "chromeRemoteDesktopAppBlocked": true, + "deviceEnrollmentDomain": "testDomain", + "diskEncrypted": true, + "keyTrustLevel": "CHROME_OS_VERIFIED_MODE", + "osFirewall": true, + "osVersion": { + "minimum": "10.0.19041.1110" + }, + "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", + "realtimeUrlCheckMode": true, + "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", + "screenLockSecured": true, + "siteIsolationEnabled": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceIosRequest": { + "summary": "iOS request", + "value": { + "jailbreak": false, + "name": "Device assurance iOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "IOS", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + } + } + }, + "DeviceAssuranceIosResponse": { + "summary": "iOS response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "id": "dae3m8o4rWhwReDeM1c5", + "jailbroken": false, + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance iOS", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "IOS", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + } + } + }, + "DeviceAssuranceIosWithDevicePostureIdPSignalProvidersRequest": { + "summary": "iOS with Device Posture IdP as third-party signal provider request", + "value": { + "jailbreak": false, + "name": "Device assurance iOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "IOS", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "thirdPartySignalProviders": { + "devicePostureIdP": { + "compliant": true, + "managed": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceAssuranceIosWithDevicePostureIdPSignalProvidersResponse": { + "summary": "iOS with Device Posture IdP as third-party signal provider response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "id": "dae3m8o4rWhwReDeM1c5", + "jailbroken": false, + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance iOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "IOS", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + }, + "thirdPartySignalProviders": { + "devicePostureIdP": { + "compliant": true, + "managed": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceAssuranceIosWithDynamicVersionRequirementRequest": { + "summary": "iOS with dynamic version requirement request", + "value": { + "jailbreak": false, + "name": "Device assurance iOS", + "osVersion": { + "dynamicVersionRequirement": { + "latestSecurityPatch": true, + "type": "EXACT_ANY_SUPPORTED" + } + }, + "platform": "IOS", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceIosWithDynamicVersionRequirementResponse": { + "summary": "iOS with dynamic version requirement response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "id": "dae3m8o4rWhwReDeM1c5", + "jailbroken": false, + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance iOS", + "osVersion": { + "dynamicVersionRequirement": { + "latestSecurityPatch": true, + "type": "EXACT_ANY_SUPPORTED" + } + }, + "platform": "IOS", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceIosWithGracePeriodRequest": { + "summary": "iOS with 30 day grace period request", + "value": { + "displayRemediationMode": "SHOW", + "gracePeriod": { + "expiry": "P30D", + "type": "BY_DURATION" + }, + "jailbreak": false, + "name": "Device assurance iOS Grace Period", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "IOS", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceIosWithGracePeriodResponse": { + "summary": "iOS with due by days grace period response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "displayRemediationMode": "SHOW", + "gracePeriod": { + "expiry": "P30D", + "type": "BY_DURATION" + }, + "id": "dae3m8o4rWhwReDeM1c5", + "jailbroken": false, + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance iOS", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "IOS", + "screenLockType": { + "include": [ + "BIOMETRIC" + ] + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceMacOSRequest": { + "summary": "macOS request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance macOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + } + }, + "DeviceAssuranceMacOSResponse": { + "summary": "macOS response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance macOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + } + }, + "DeviceAssuranceMacOSWithDevicePostureChecksRequest": { + "summary": "macOS request with OSQuery device posture check", + "value": { + "devicePostureChecks": { + "include": [ + { + "value": "1", + "variableName": "macOSFirewall" + } + ] + }, + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance macOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "DeviceAssuranceMacOSWithDevicePostureChecksResponse": { + "summary": "macOS request with OSQuery device posture check", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "devicePostureChecks": { + "include": [ + { + "value": "1", + "variableName": "macOSFirewall" + } + ] + }, + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance macOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "DeviceAssuranceMacOSWithDevicePostureIdPThirdPartySignalProvidersRequest": { + "summary": "macOS with Device Posture IdP as third-party signal provider request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance macOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "devicePostureIdP": { + "compliant": true, + "managed": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceAssuranceMacOSWithDevicePostureIdPThirdPartySignalProvidersResponse": { + "summary": "macOS with Device Posture IdP as third-party signal provider response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance macOS", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "devicePostureIdP": { + "compliant": true, + "managed": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceAssuranceMacOSWithDeviceTrustConnectorThirdPartySignalProvidersRequest": { + "summary": "macOS with Device Trust Connector as third-party signal provider request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance macOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "dtc": { + "browserVersion": { + "minimum": "15393.27.0" + }, + "builtInDnsClientEnabled\"": true, + "chromeRemoteDesktopAppBlocked\"": true, + "deviceEnrollmentDomain\"": "testDomain", + "diskEncrypted": true, + "osFirewall": true, + "osVersion": { + "minimum": "10.0.19041.1110" + }, + "passwordProtectionWarningTrigger\"": "PASSWORD_PROTECTION_OFF", + "realtimeUrlCheckMode\"": true, + "safeBrowsingProtectionLevel\"": true, + "screenLockSecured": true, + "siteIsolationEnabled\"": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceMacOSWithDeviceTrustConnectorThirdPartySignalProvidersResponse": { + "summary": "macOS with Device Trust Connector as third-party signal provider response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance macOS", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "dtc": { + "browserVersion": { + "minimum": "15393.27.0" + }, + "builtInDnsClientEnabled": true, + "chromeRemoteDesktopAppBlocked": true, + "deviceEnrollmentDomain": "testDomain", + "diskEncrypted": true, + "keyTrustLevel": "CHROME_BROWSER_HW_KEY", + "osFirewall": true, + "osVersion": { + "minimum": "10.0.19041.1110" + }, + "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", + "realtimeUrlCheckMode": true, + "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", + "screenLockSecured": true, + "siteIsolationEnabled": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceMacOSWithDynamicVersionRequirementRequest": { + "summary": "macOS with dynamic version requirement request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance macOS", + "osVersion": { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 0, + "latestSecurityPatch": true, + "type": "EXACT" + } + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceMacOSWithDynamicVersionRequirementResponse": { + "summary": "macOS with dynamic version requirement response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance macOS", + "osVersion": { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 0, + "latestSecurityPatch": true, + "type": "EXACT" + } + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceMacOSWithGracePeriodRequest": { + "summary": "macOS request with due by date grace period request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "displayRemediationMode": "SHOW", + "gracePeriod": { + "expiry": "2024-12-01T00:00:00.00Z", + "type": "BY_DATE_TIME" + }, + "name": "Device assurance macOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceMacOSWithGracePeriodResponse": { + "summary": "macOS with due by date grace period response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "displayRemediationMode": "SHOW", + "gracePeriod": { + "expiry": "2024-12-01T00:00:00.00Z", + "type": "BY_DATE_TIME" + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance macOS", + "osVersion": { + "minimum": "12.4.5" + }, + "platform": "MACOS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceWindowsRequest": { + "summary": "Windows request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance Windows", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + } + }, + "DeviceAssuranceWindowsResponse": { + "summary": "Windows response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Windows", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + } + }, + "DeviceAssuranceWindowsWithDevicePostureChecksRequest": { + "summary": "Windows request with OSQuery device posture check", + "value": { + "devicePostureChecks": { + "include": [ + { + "value": "1", + "variableName": "windowsFirewall" + } + ] + }, + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance Windows", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "DeviceAssuranceWindowsWithDevicePostureChecksResponse": { + "summary": "Windows request with OSQuery device posture check", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "devicePostureChecks": { + "include": [ + { + "value": "1", + "variableName": "windowsFirewall" + } + ] + }, + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Windows", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "DeviceAssuranceWindowsWithDevicePostureIdPThirdPartySignalProvidersRequest": { + "summary": "Windows with Device Posture IdP as third-party signal provider request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance Windows", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "devicePostureIdP": { + "compliant": true, + "managed": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceAssuranceWindowsWithDevicePostureIdPThirdPartySignalProvidersResponse": { + "summary": "Windows with Device Posture IdP as third-party signal provider response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Windows", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "devicePostureIdP": { + "compliant": true, + "managed": true + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceAssuranceWindowsWithDeviceTrustConnectorThirdPartySignalProvidersRequest": { + "summary": "Windows with Device Trust Connector as third-party signal provider request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance Windows", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "dtc": { + "antivirusEnabled": true, + "browserVersion": { + "minimum": "15393.27.0" + }, + "builtInDnsClientEnabled": true, + "chromeRemoteDesktopAppBlocked": true, + "crowdStrikeAgentId": "testAgentId", + "crowdStrikeCustomerId": "testCustomerId", + "deviceEnrollmentDomain": "testDomain", + "diskEncrypted": true, + "keyTrustLevel": "CHROME_BROWSER_HW_KEY", + "osFirewall": true, + "osVersion": { + "minimum": "10.0.19041.1110" + }, + "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", + "realtimeUrlCheckMode": true, + "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", + "screenLockSecured": true, + "secureBootEnabled": true, + "siteIsolationEnabled": true, + "windowsMachineDomain": "testMachineDomain", + "windowsUserDomain": "testUserDomain" + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceWindowsWithDeviceTrustConnectorThirdPartySignalProvidersResponse": { + "summary": "Windows with Device Trust Connector as third-party signal provider response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Windows", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true, + "thirdPartySignalProviders": { + "dtc": { + "antivirusEnabled": true, + "browserVersion": { + "minimum": "15393.27.0" + }, + "builtInDnsClientEnabled": true, + "chromeRemoteDesktopAppBlocked": true, + "crowdStrikeAgentId": "testAgentId", + "crowdStrikeCustomerId": "testCustomerId", + "deviceEnrollmentDomain": "testDomain", + "diskEncrypted": true, + "keyTrustLevel": "CHROME_BROWSER_HW_KEY", + "osFirewall": true, + "osVersion": { + "minimum": "10.0.19041.1110" + }, + "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", + "realtimeUrlCheckMode": true, + "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", + "screenLockSecured": true, + "secureBootEnabled": true, + "siteIsolationEnabled": true, + "windowsMachineDomain": "testMachineDomain", + "windowsUserDomain": "testUserDomain" + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceWindowsWithDynamicVersionRequirementsRequest": { + "summary": "Windows with Windows 11 and Windows 10 dynamic version requirements request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance Windows", + "osVersionConstraints": [ + { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 1, + "latestSecurityPatch": true, + "type": "MINIMUM" + }, + "majorVersionConstraint": "WINDOWS_11" + }, + { + "dynamicVersionRequirement": { + "type": "EXACT_ANY_SUPPORTED" + }, + "majorVersionConstraint": "WINDOWS_10" + } + ], + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceWindowsWithDynamicVersionRequirementsResponse": { + "summary": "Windows with Windows 11 and Windows 10 dynamic version requirements response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Windows", + "osVersionConstraints": [ + { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 1, + "latestSecurityPatch": true, + "type": "MINIMUM" + }, + "majorVersionConstraint": "WINDOWS_11" + }, + { + "dynamicVersionRequirement": { + "type": "EXACT_ANY_SUPPORTED" + }, + "majorVersionConstraint": "WINDOWS_10" + } + ], + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceWindowsWithGracePeriodRequest": { + "summary": "Windows with 7 day grace period request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "displayRemediationMode": "SHOW", + "gracePeriod": { + "expiry": "P7D", + "type": "BY_DURATION" + }, + "name": "Device assurance Windows", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceWindowsWithGracePeriodResponse": { + "summary": "Windows with due by days grace period response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "displayRemediationMode": "SHOW", + "gracePeriod": { + "expiry": "P7D", + "type": "BY_DURATION" + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Windows", + "osVersion": { + "minimum": "12.4.5.9" + }, + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceWindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionStringRequest": { + "summary": "Windows with Windows 11 dynamic version requirement and Windows 10 minimum version request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance Windows", + "osVersionConstraints": [ + { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 1, + "type": "EXACT" + }, + "majorVersionConstraint": "WINDOWS_11" + }, + { + "majorVersionConstraint": "WINDOWS_10", + "minimum": "10.0.19045.0" + } + ], + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceWindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionStringResponse": { + "summary": "Windows with Windows 11 dynamic version requirement and Windows 10 minimum version response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Windows", + "osVersionConstraints": [ + { + "dynamicVersionRequirement": { + "distanceFromLatestMajor": 1, + "type": "EXACT" + }, + "majorVersionConstraint": "WINDOWS_11" + }, + { + "majorVersionConstraint": "WINDOWS_10", + "minimum": "10.0.19045.0" + } + ], + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceWindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirementRequest": { + "summary": "Windows with Windows 11 minimum version and a Windows 10 dynamic version requirement request", + "value": { + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "name": "Device assurance Windows", + "osVersionConstraints": [ + { + "majorVersionConstraint": "WINDOWS_11", + "minimum": "10.0.22000.0" + }, + { + "dynamicVersionRequirement": { + "type": "NOT_ALLOWED" + }, + "majorVersionConstraint": "WINDOWS_10" + } + ], + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceAssuranceWindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirementResponse": { + "summary": "Windows with Windows 11 minimum version and Windows 10 dynamic version requirement response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdDate": "2022-01-01T00:00:00.000Z", + "diskEncryptionType": { + "include": [ + "ALL_INTERNAL_VOLUMES" + ] + }, + "id": "dae3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "name": "Device assurance Windows", + "osVersionConstraints": [ + { + "majorVersionConstraint": "WINDOWS_11", + "minimum": "10.0.22000.0" + }, + { + "dynamicVersionRequirement": { + "type": "NOT_ALLOWED" + }, + "majorVersionConstraint": "WINDOWS_10" + } + ], + "platform": "WINDOWS", + "screenLockType": { + "include": [ + "PASSCODE", + "BIOMETRIC" + ] + }, + "secureHardwarePresent": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DeviceIntegrationAndroidZeroTrustResponse": { + "summary": "Response of device integration for Android Device Trust", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din9lzd33mvS9kjr60g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din9lzd33mvS9kjr60g4" + } + }, + "displayName": "Android Device Trust", + "id": "din9lzd33mvS9kjr60g4", + "name": "com.android.zero.trust", + "platform": "ANDROID", + "status": "ACTIVE" + } + }, + "DeviceIntegrationChromeDeviceTrustConnectorResponse": { + "summary": "Response of a device integration for Chrome Device Trust", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din15gaNrC7BvlBgx0g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din15gaNrC7BvlBgx0g4" + } + }, + "displayName": "Chrome Device Trust", + "id": "din15gaNrC7BvlBgx0g4", + "metadata": { + "serviceAccountEmail": "okta-gci-00o158oxTmBNgrgyM0g4@vocal-invention-346218.iam.gserviceaccount.com", + "serviceAccountName": "okta-gci-00o158oxTmBNgrgyM0g4", + "type": "CHROME" + }, + "name": "com.google.dtc", + "platform": "CHROMEOS", + "status": "ACTIVE" + } + }, + "DeviceIntegrationCrowdStrikeResponse": { + "summary": "Response of a device integration for CrowdStrike", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dindyfy1f7Pv1eoVF0g4/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dindyfy1f7Pv1eoVF0g4" + } + }, + "displayName": "Device Posture Provider", + "id": "dindyfy1f7Pv1eoVF0g4", + "metadata": { + "idpId": "0oa2owlGX5l74kjr60g4", + "type": "DEVICE_IDP" + }, + "name": "com.okta.deviceidp", + "platform": "IOS", + "status": "DEACTIVATED" + } + }, + "DeviceIntegrationDevicePostureCheckResponse": { + "summary": "Response of device integration for Device Posture Check", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din9lzd33mvS9vBwN1c5/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din9lzd33mvS9vBwN1c5" + } + }, + "displayName": "OSQuery", + "id": "din9lzd33mvS9vBwN1c5", + "name": "com.okta.device.osquery", + "platform": "MACOS", + "status": "ACTIVE" + } + }, + "DeviceIntegrationDevicePostureIdPResponse": { + "summary": "Response of a device integration for Device Posture Provider", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dindyfzlaerjWVdqt0g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dindyfzlaerjWVdqt0g4" + } + }, + "displayName": "Device Posture Provider", + "id": "dindyfzlaerjWVdqt0g4", + "metadata": { + "idpId": "0oa2owlGX5l74kjr60g4", + "type": "DEVICE_IDP" + }, + "name": "com.okta.deviceidp", + "platform": "WINDOWS", + "status": "ACTIVE" + } + }, + "DeviceIntegrationWindowsSecurityCenterResponse": { + "summary": "Response of a device integration for Windows Security Center", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dinjihtR8qWZZF6qe0g4/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dinjihtR8qWZZF6qe0g4" + } + }, + "displayName": "Windows Security Center", + "id": "dinjihtR8qWZZF6qe0g4", + "name": "com.okta.windowssecuritycenter", + "platform": "WINDOWS", + "status": "DEACTIVATED" + } + }, + "DevicePostureChecksMacOSRequest": { + "summary": "macOS request", + "value": { + "description": "Query macOS devices to check if firewall is enabled", + "mappingType": "CHECKBOX", + "name": "Device posture check macOS", + "platform": "MACOS", + "query": "SELECT CASE WHEN global_state = 0 THEN 0 ELSE 1 END AS firewall_enabled FROM alf;", + "remediationSettings": { + "link": { + "customUrl": "example.myremediationurl.com/docs", + "defaultUrl": null + }, + "message": { + "customText": "It is our company policy that all devices must have a firewall enabled.", + "defaultI18nKey": null + } + }, + "type": "CUSTOM", + "variableName": "macOSFirewall" + } + }, + "DevicePostureChecksMacOSResponse": { + "summary": "macOS response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-posture-checks/dch3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdUpdate": "2022-01-01T00:00:00.000Z", + "description": "Query macOS devices to check if firewall is enabled", + "id": "dch3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "mappingType": "CHECKBOX", + "name": "Device posture check macOS", + "platform": "MACOS", + "query": "SELECT CASE WHEN global_state = 0 THEN 0 ELSE 1 END AS firewall_enabled FROM alf;", + "remediationSettings": { + "link": { + "customUrl": "example.myremediationurl.com/docs", + "defaultUrl": null + }, + "message": { + "customText": "It is our company policy that all devices must have a firewall enabled.", + "defaultI18nKey": null + } + }, + "type": "CUSTOM", + "variableName": "macOSFirewall" + } + }, + "DevicePostureChecksWindowsRequest": { + "summary": "Windows request", + "value": { + "description": "Query Windows devices to check if firewall is enabled", + "mappingType": "CHECKBOX", + "name": "Device posture check Windows", + "platform": "WINDOWS", + "query": "SELECT CASE WHEN enabled = 1 THEN 1 ELSE 0 END AS firewall_enabled FROM windows_firewall_profiles;", + "remediationSettings": { + "link": { + "customUrl": "example.myremediationurl.com/docs", + "defaultUrl": null + }, + "message": { + "customText": "It is our company policy that all devices must have a firewall enabled.", + "defaultI18nKey": null + } + }, + "type": "CUSTOM", + "variableName": "windowsFirewall" + } + }, + "DevicePostureChecksWindowsResponse": { + "summary": "Windows response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/device-posture-checks/dch3m8o4rWhwReDeM1c5" + } + }, + "createdBy": "00u217pyf72CdUrBt1c5", + "createdUpdate": "2022-01-01T00:00:00.000Z", + "description": "Query Windows devices to check if firewall is enabled", + "id": "dch3m8o4rWhwReDeM1c5", + "lastUpdate": "2022-01-01T00:00:00.000Z", + "lastUpdatedBy": "00u217pyf72CdUrBt1c5", + "mappingType": "CHECKBOX", + "name": "Device posture check Windows", + "platform": "WINDOWS", + "query": "SELECT CASE WHEN enabled = 1 THEN 1 ELSE 0 END AS firewall_enabled FROM windows_firewall_profiles;", + "remediationSettings": { + "link": { + "customUrl": "example.myremediationurl.com/docs", + "defaultUrl": null + }, + "message": { + "customText": "It is our company policy that all devices must have a firewall enabled.", + "defaultI18nKey": null + } + }, + "type": "CUSTOM", + "variableName": "windowsFirewall" + } + }, + "DeviceResponse": { + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PATCH", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4" + }, + "suspend": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/suspend" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/users" + } + }, + "created": "2020-11-03T21:47:01.000Z", + "id": "guo8jx5vVoxfvJeLb0w4", + "lastUpdated": "2020-11-03T23:46:27.000Z", + "profile": { + "diskEncryptionType": "NONE", + "displayName": "DESKTOP-EHAD3IE", + "manufacturer": "International Corp", + "model": "VMware7,1", + "osVersion": "10.0.18362", + "platform": "WINDOWS", + "registered": true, + "secureHardwarePresent": false, + "serialNumber": "56 4d 4f 95 74 c5 d3 e7-fc 3a 57 9c c2 f8 5d ce", + "sid": "S-1-5-21-3992267483-1860856704-2413701314-500", + "udid": "954F4D56-C574-E7D3-FC3A-579CC2F85DCE" + }, + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "DESKTOP-EHAD3IE" + }, + "resourceId": "guo8jx5vVoxfvJeLb0w4", + "resourceType": "UDDevice", + "status": "ACTIVE" + } + }, + "DeviceWithProvidersResponse": { + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PATCH", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4" + }, + "suspend": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/suspend" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/users" + } + }, + "created": "2020-11-03T21:47:01.000Z", + "id": "guo8jx5vVoxfvJeLb0w4", + "lastUpdated": "2020-11-03T23:46:27.000Z", + "profile": { + "diskEncryptionType": "NONE", + "displayName": "DESKTOP-EHAD3IE", + "manufacturer": "International Corp", + "model": "VMware7,1", + "osVersion": "10.0.18362", + "platform": "WINDOWS", + "registered": true, + "secureHardwarePresent": false, + "serialNumber": "56 4d 4f 95 74 c5 d3 e7-fc 3a 57 9c c2 f8 5d ce", + "sid": "S-1-5-21-3992267483-1860856704-2413701314-500", + "udid": "954F4D56-C574-E7D3-FC3A-579CC2F85DCE" + }, + "providers": [ + { + "payload": { + "clientVersion": "7.0" + }, + "payloadVersion": "1.0", + "provider": "oktaVerify" + } + ], + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "DESKTOP-EHAD3IE" + }, + "resourceId": "guo8jx5vVoxfvJeLb0w4", + "resourceType": "UDDevice", + "status": "ACTIVE" + } + }, + "EmailCustomizationResponse": { + "value": { + "_links": { + "preview": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4/preview" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4" + }, + "template": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + }, + "test": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" + } + }, + "body": "

Hello, ${user.profile.firstName}. Click here to activate your account.", + "created": "2021-11-09T20:38:10.000Z", + "id": "oel11u6DqUiMbQkpl0g4", + "isDefault": true, + "language": "en", + "lastUpdated": "2021-11-11T20:38:10.000Z", + "subject": "Welcome to ${org.name}!" + } + }, + "EmailDomainResponse": { + "value": { + "displayName": "Admin", + "dnsValidationRecords": [ + { + "fqdn": "_oktaverification.example.com", + "recordType": "TXT", + "verificationValue": "759080212bda43e3bc825a7d73b4bb64" + }, + { + "fqdn": "mail.example.com", + "recordType": "CNAME", + "verificationValue": "u22224444.wl024.sendgrid.net" + }, + { + "fqdn": "t02._domainkey.example.com", + "recordType": "CNAME", + "verificationValue": "t02.domainkey.u22224444.wl024.sendgrid.net" + }, + { + "fqdn": "t022._domainkey.example.com", + "recordType": "CNAME", + "verificationValue": "t02.domainkey.u22224444.wl024.sendgrid.net" + } + ], + "domain": "example.com", + "id": "OeD114iNkrcN6aR680g4", + "userName": "admin", + "validationStatus": "NOT_STARTED", + "validationSubdomain": "mail" + } + }, + "EmailSettingsRequest": { + "value": { + "recipients": "ALL_USERS" + } + }, + "EmailSettingsResponse": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings" + }, + "template": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + } + }, + "recipients": "ALL_USERS" + } + }, + "EmailTemplateDefaultContentResponse": { + "value": { + "_links": { + "preview": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content/preview" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content" + }, + "template": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + } + }, + "body": "

Hello, ${user.profile.firstName}. Click here to activate your account.", + "subject": "Welcome to ${org.name}!" + } + }, + "EmbeddedGroupAssignmentSampleResponse": { + "summary": "Application group with an embedded group", + "value": { + "_embedded": { + "group": { + "_links": { + "apps": { + "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4/apps" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/groups/odyssey/okta-medium.30ce6d4085dff29412984e4c191bc874.png", + "name": "medium", + "type": "image/png" + }, + { + "href": "http://{yourOktaDomain}/assets/img/logos/groups/odyssey/okta-large.c3cb8cda8ae0add1b4fe928f5844dbe3.png", + "name": "large", + "type": "image/png" + } + ], + "users": { + "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4/users" + } + }, + "created": "2024-06-02T13:02:12.000Z", + "id": "00g15acRUy0SYb9GT0g4", + "lastMembershipUpdated": "2024-06-02T13:03:13.000Z", + "lastUpdated": "2024-06-02T13:02:12.000Z", + "objectClass": [ + "okta:user_group" + ], + "profile": { + "description": "Group with professional footballers", + "name": "Football Group" + }, + "type": "OKTA_GROUP" + } + }, + "_links": { + "app": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" + }, + "group": { + "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" + } + }, + "id": "00g15acRUy0SYb9GT0g4", + "lastUpdated": "2024-06-02T13:17:57.000Z", + "priority": 0, + "profile": { + "department": "marketing", + "division": "top", + "initialStatus": "active_with_pass", + "locale": "en_US", + "manager": "Donald Glover", + "managerId": "ike.ogb@gmail.com", + "organization": "wazobia", + "preferredLanguage": "English", + "securityAnswer": "Ronaldinho", + "securityQuestion": "Who is the footballer to have played the game", + "timezone": "Canada/Eastern", + "userType": null + } + } + }, + "EmbeddedMetadataGroupAssignmentSampleResponse": { + "summary": "Application group with embedded metadata", + "value": { + "_embedded": { + "metadata": { + "credentials": {}, + "profile": { + "department": { + "lastUpdated": null, + "source": { + "type": "MAPPING", + "value": [ + { + "id": null + } + ] + } + }, + "division": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "initialStatus": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "locale": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "manager": { + "lastUpdated": null, + "source": { + "type": "MAPPING", + "value": [ + { + "id": null + } + ] + } + }, + "managerId": { + "lastUpdated": null, + "source": { + "type": "MAPPING", + "value": [ + { + "id": null + } + ] + } + }, + "organization": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "preferredLanguage": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "securityAnswer": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "securityQuestion": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "timezone": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "userType": { + "lastUpdated": null, + "source": { + "type": "MAPPING", + "value": [ + { + "id": null + } + ] + } + } + } + } + }, + "_links": { + "app": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" + }, + "group": { + "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" + } + }, + "id": "00g15acRUy0SYb9GT0g4", + "lastUpdated": "2024-06-02T13:17:57.000Z", + "priority": 0, + "profile": { + "department": "marketing", + "division": "top", + "initialStatus": "active_with_pass", + "locale": "en_US", + "manager": "Donald Glover", + "managerId": "ike.ogb@gmail.com", + "organization": "wazobia", + "preferredLanguage": "English", + "securityAnswer": "Ronaldinho", + "securityQuestion": "Who is the footballer to have played the game", + "timezone": "Canada/Eastern", + "userType": null + } + } + }, + "EnrollFactorCallRequest": { + "summary": "call", + "value": { + "factorType": "call", + "profile": { + "phoneExtension": "1234", + "phoneNumber": "+1-555-415-1337" + }, + "provider": "OKTA" + } + }, + "EnrollFactorCallResponse": { + "summary": "call", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/clf1nz9JHJGHWRKMTLHP/lifecycle/activate" + }, + "resend": [ + { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/clf1nz9JHJGHWRKMTLHP/resend", + "name": "call" + } + ], + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/clf1nz9JHJGHWRKMTLHP" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2014-08-05T20:59:49.000Z", + "factorType": "call", + "id": "clf1nz9JHJGHWRKMTLHP", + "lastUpdated": "2014-08-06T03:59:49.000Z", + "profile": { + "phoneExtension": "1234", + "phoneNumber": "+1-555-415-1337" + }, + "provider": "OKTA", + "status": "PENDING_ACTIVATION", + "vendorName": "OKTA" + } + }, + "EnrollFactorCustomTotpRequest": { + "summary": "custom totp", + "value": { + "factorProfileId": "fpr20l2mDyaUGWGCa0g4", + "factorType": "token:hotp", + "profile": { + "sharedSecret": "484f97be3213b117e3a20438e291540a" + }, + "provider": "CUSTOM" + } + }, + "EnrollFactorCustomTotpResponse": { + "summary": "custom totp", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00utf43LCCmTJVcsK0g3/factors/chf20l33Ks8U2Zjba0g4" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00utf43LCCmTJVcsK0g3" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00utf43LCCmTJVcsK0g3/factors/chf20l33Ks8U2Zjba0g4/verify" + } + }, + "created": "2019-07-22T23:22:36.000Z", + "factorType": "token:hotp", + "id": "chf20l33Ks8U2Zjba0g4", + "lastUpdated": "2019-07-22T23:22:36.000Z", + "provider": "CUSTOM", + "status": "ACTIVE", + "vendorName": "Entrust Datacard" + } + }, + "EnrollFactorEmailRequest": { + "summary": "email", + "value": { + "factorType": "email", + "profile": { + "email": "test@gmail.com" + }, + "provider": "OKTA" + } + }, + "EnrollFactorEmailResponse": { + "summary": "email", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3/lifecycle/activate" + }, + "resend": [ + { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3/resend", + "name": "email" + } + ], + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3" + } + }, + "factorType": "email", + "id": "emfnf3gSScB8xXoXK0g3", + "provider": "OKTA", + "status": "PENDING_ACTIVATION", + "vendorName": "OKTA" + } + }, + "EnrollFactorGoogleRequest": { + "summary": "google token:software:totp", + "value": { + "factorType": "token:software:totp", + "provider": "GOOGLE" + } + }, + "EnrollFactorGoogleResponse": { + "value": { + "_embedded": { + "activation": { + "_links": { + "qrcode": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG/qr/00fukNElRS_Tz6k-CFhg3pH4KO2dj2guhmaapXWbc4", + "type": "image/png" + } + }, + "encoding": "base32", + "keyLength": 16, + "sharedSecret": "JBTWGV22G4ZGKV3N", + "timeStep": 30 + } + }, + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2014-07-16T16:13:56.000Z", + "factorType": "token:software:totp", + "id": "ostf1fmaMGJLMNGNLIVG", + "lastUpdated": "2014-07-16T16:13:56.000Z", + "profile": { + "credentialId": "dade.murphy@example.com" + }, + "provider": "GOOGLE", + "status": "PENDING_ACTIVATION", + "vendorName": "GOOGLE" + } + }, + "EnrollFactorOVPushRequest": { + "summary": "token:software:totp push", + "value": { + "factorType": "push", + "provider": "OKTA" + } + }, + "EnrollFactorOVPushResponse": { + "summary": "token:software:totp", + "value": { + "_embedded": { + "activation": { + "_links": { + "qrcode": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfbtzzrjgwauUsxO0g4/qr/00Ji8qVBNJD4LmjYy1WZO2VbNqvvPdaCVua-1qjypa", + "type": "image/png" + }, + "send": [ + { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfbtzzrjgwauUsxO0g4/lifecycle/activate/email", + "name": "email" + }, + { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfbtzzrjgwauUsxO0g4/lifecycle/activate/sms", + "name": "sms" + } + ] + }, + "expiresAt": "2015-11-13T07:44:22.000Z", + "factorResult": "WAITING" + } + }, + "_links": { + "poll": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfbtzzrjgwauUsxO0g4/lifecycle/activate/poll" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfbtzzrjgwauUsxO0g4" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2015-11-13T07:34:22.000Z", + "factorType": "push", + "id": "opfbtzzrjgwauUsxO0g4", + "lastUpdated": "2015-11-13T07:34:22.000Z", + "provider": "OKTA", + "status": "PENDING_ACTIVATION", + "vendorName": "OKTA" + } + }, + "EnrollFactorOVTotpRequest": { + "summary": "token:software:totp", + "value": { + "factorType": "token:software:totp", + "provider": "OKTA" + } + }, + "EnrollFactorOVTotpResponse": { + "summary": "token:software:totp", + "value": { + "_embedded": { + "_links": { + "qrcode": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG/qr/00fukNElRS_Tz6k-CFhg3pH4KO2dj2guhmaapXWbc4", + "type": "image/png" + } + }, + "activation": { + "encoding": "base32", + "keyLength": 6, + "sharedSecret": "JBTWGV22G4ZGKV3N", + "timeStep": 30 + } + }, + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2014-07-16T16:13:56.000Z", + "factorType": "token:software:totp", + "id": "ostf1fmaMGJLMNGNLIVG", + "lastUpdated": "2014-07-16T16:13:56.000Z", + "profile": { + "credentialId": "dade.murphy@example.com" + }, + "provider": "OKTA", + "status": "PENDING_ACTIVATION", + "vendorName": "OKTA" + } + }, + "EnrollFactorQuestionRequest": { + "summary": "question", + "value": { + "question": { + "summary": "question factor", + "value": { + "factorType": "question", + "profile": { + "answer": "mayonnaise", + "question": "disliked_food" + }, + "provider": "OKTA" + } + } + } + }, + "EnrollFactorQuestionResponse": { + "summary": "question", + "value": { + "_links": { + "questions": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/questions" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ufs1o01OTMGHLAJPVHDZ" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2014-08-05T22:58:49.000Z", + "factorType": "question", + "id": "ufs1o01OTMGHLAJPVHDZ", + "lastUpdated": "2014-08-05T22:58:49.000Z", + "profile": { + "question": "disliked_food", + "questionText": "What is the food you least liked as a child?" + }, + "provider": "OKTA", + "status": "ACTIVE", + "vendorName": "OKTA" + } + }, + "EnrollFactorRsaSecurIdRequest": { + "summary": "RSA SecurID", + "value": { + "factorType": "token", + "profile": { + "credentialId": "dade.murphy@example.com" + }, + "provider": "RSA", + "verify": { + "passCode": "5275875498" + } + } + }, + "EnrollFactorRsaSecurIdResponse": { + "summary": "RSA SecurID", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/rsabtznMn6cp94ez20g4" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/rsabtznMn6cp94ez20g4/verify" + } + }, + "created": "2015-11-13T07:05:53.000Z", + "factorType": "token", + "id": "rsabtznMn6cp94ez20g4", + "lastUpdated": "2015-11-13T07:05:53.000Z", + "profile": { + "credentialId": "dade.murphy@example.com" + }, + "provider": "RSA", + "status": "ACTIVE", + "vendorName": "RSA" + } + }, + "EnrollFactorSmsRequest": { + "summary": "sms", + "value": { + "factorType": "sms", + "profile": { + "phoneNumber": "+1-555-415-1337" + }, + "provider": "OKTA" + } + }, + "EnrollFactorSmsResponse": { + "summary": "sms", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/mbl1nz9JHJGHWRKMTLHP/lifecycle/activate" + }, + "resend": [ + { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/mbl1nz9JHJGHWRKMTLHP/resend", + "name": "sms" + } + ], + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/mbl1nz9JHJGHWRKMTLHP" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2014-08-05T20:59:49.000Z", + "factorType": "sms", + "id": "mbl1nz9JHJGHWRKMTLHP", + "lastUpdated": "2014-08-06T03:59:49.000Z", + "profile": { + "phoneNumber": "+1-555-415-1337" + }, + "provider": "OKTA", + "status": "PENDING_ACTIVATION", + "vendorName": "OKTA" + } + }, + "EnrollFactorSymantecVipRequest": { + "summary": "Symantec VIP", + "value": { + "factorType": "token", + "profile": { + "credentialId": "VSMT14393584" + }, + "provider": "SYMANTEC", + "verify": { + "nextPassCode": "678195", + "passCode": "875498" + } + } + }, + "EnrollFactorSymantecVipResponse": { + "summary": "Symantec VIP", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ufvbtzgkYaA7zTKdQ0g4" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ufvbtzgkYaA7zTKdQ0g4/verify" + } + }, + "created": "2015-11-13T06:52:08.000Z", + "factorType": "token", + "id": "ufvbtzgkYaA7zTKdQ0g4", + "lastUpdated": "2015-11-13T06:52:08.000Z", + "profile": { + "credentialId": "VSMT14393584" + }, + "provider": "SYMANTEC", + "status": "ACTIVE", + "vendorName": "SYMANTEC" + } + }, + "EnrollFactorU2fRequest": { + "summary": "u2f", + "value": { + "factorType": "u2f", + "provider": "FIDO" + } + }, + "EnrollFactorU2fResponse": { + "summary": "u2f", + "value": { + "_embedded": { + "activation": { + "nonce": "9DmGJDLvaU6KWxJbfrZ0", + "timeoutSeconds": 20, + "version": "U2F_V2" + } + }, + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fuf2rovRxogXJ0nDy0g4/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fuf2rovRxogXJ0nDy0g4" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2018-05-24T20:43:19.000Z", + "factorType": "u2f", + "id": "fuf2rovRxogXJ0nDy0g4", + "lastUpdated": "2018-05-24T20:43:19.000Z", + "provider": "FIDO", + "status": "PENDING_ACTIVATION", + "vendorName": "FIDO" + } + }, + "EnrollFactorWebauthnRequest": { + "summary": "webAuthn", + "value": { + "factorType": "webauthn", + "provider": "FIDO" + } + }, + "EnrollFactorWebauthnResponse": { + "summary": "webAuthn", + "value": { + "_embedded": { + "activation": { + "attestation": "direct", + "authenticatorSelection": { + "requireResidentKey": false, + "userVerification": "preferred" + }, + "challenge": "cdsZ1V10E0BGE4GcG3IK", + "excludeCredentials": [], + "pubKeyCredParams": [ + { + "alg": -7, + "type": "public-key" + }, + { + "alg": -257, + "type": "public-key" + } + ], + "rp": { + "name": "Rain-Cloud59" + }, + "user": { + "displayName": "First Last", + "id": "00u15s1KDETTQMQYABRL", + "name": "first.last@gmail.com" + } + } + }, + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fwf2rovRxogXJ0nDy0g4/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fwf2rovRxogXJ0nDy0g4" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2018-05-24T20:43:19.000Z", + "factorType": "webauthn", + "id": "fwf2rovRxogXJ0nDy0g4", + "lastUpdated": "2018-05-24T20:43:19.000Z", + "provider": "FIDO", + "status": "PENDING_ACTIVATION", + "vendorName": "FIDO" + } + }, + "EnrollFactorYubikeyRequest": { + "summary": "yubikey", + "value": { + "factorType": "token:hardware", + "provider": "YUBICO", + "verify": { + "passCode": "cccccceukngdfgkukfctkcvfidnetljjiknckkcjulji" + } + } + }, + "EnrollFactorYubikeyResponse": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "hhttps://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ykfbty3BJeBgUi3750g4" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ykfbty3BJeBgUi3750g4/verify" + } + }, + "created": "2015-11-13T05:27:49.000Z", + "factorType": "token:hardware", + "id": "ykfbty3BJeBgUi3750g4", + "lastUpdated": "2015-11-13T05:27:49.000Z", + "profile": { + "credentialId": "000004102994" + }, + "provider": "YUBICO", + "status": "ACTIVE", + "vendorName": "YUBICO" + } + }, + "EnrollmentActivationRequestExample": { + "summary": "Enrollment activation request", + "value": { + "credResponses": [ + { + "authenticatorEnrollmentId": "fwf5ajzJEWqknX6lk0g4", + "credResponseJwe": "eyJlcGsiOnsia3R5IjoiRUM..." + } + ], + "fulfillmentProvider": "yubico", + "pinResponseJwe": "eyJl5IjoiRUMiLCJjcnYcGsiOnsia3...", + "serial": "3632071", + "userId": "00us2hPODQncCkxef0g3", + "version": "5.4.3", + "yubicoSigningJwks": [ + { + "crv": "P-384", + "kid": "APCS-Tsgnkey-C19881-H0027616953", + "kty": "EC", + "use": "sig", + "x": "tJc-j5osUCP-75ihCOKsswTOj3XsekayG3x79K2ndyOIXu08gDMkvL8rks06tEAa", + "y": "hfVGbQeG4l2orqenn-GATWwTm8tLqHFHuwfJp33CCNOMtYYsgkAEnW60ORzt4YV-" + } + ] + } + }, + "EnrollmentActivationResponseExample": { + "summary": "Enrollment activation response", + "value": { + "authenticatorEnrollmentIds": [ + "fwf5ajzJEWqknX6lk0g4" + ], + "fulfillmentProvider": "yubico", + "userId": "00us2hPODQncCkxef0g3" + } + }, + "EnrollmentInitializationRequestExample": { + "summary": "Initialize preregistration enrollment request", + "value": { + "enrollmentRpIds": [ + "myorg.okta.com" + ], + "fulfillmentProvider": "yubico", + "userId": "00us2hPODQncCkxef0g3", + "yubicoTransportKeyJWK": { + "crv": "P-384", + "kid": "APCS-Ttrans-C19881-I009", + "kty": "EC", + "use": "enc", + "x": "r6AzcX3OSiJk1yQaBVYiBOtzFS9gNSpMDPvnVvl0CAX7el1ZyzmPG_BZ7u8sqTmF", + "y": "RxPyGH1Xg74E2f5AQGkkddzsvTNY1R3R7mXTEM5wQtr1Y7C4XHlvITNZfU6G" + } + } + }, + "EnrollmentInitializationResponseExample": { + "summary": "Initialize preregistration enrollment request", + "value": { + "credRequests": [ + { + "authenticatorEnrollmentId": "fwf5ajzJEWqknX6lk0g4", + "credRequestJwe": "eyJlcGsiOnsia3R5IjoiRUMiLCJ...", + "keyId": "h2r91gconqiai1vs0psg" + } + ], + "fulfillmentProvider": "yubico", + "pinRequestJwe": "eyJlcGsa3R5IjoiRUMiLA...", + "userId": "00us2hPODQncCkxef0g3" + } + }, + "EntitlementValuesResponse": { + "summary": "List of bundle entitlement values", + "value": { + "_links": { + "bundle": { + "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA" + }, + "entitlements": { + "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA/entitlements" + }, + "self": { + "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles?limit=2&after=10" + } + }, + "entitlementValues": [ + { + "_links": { + "group": "http://your-subdomain.okta.com/api/v1/groups/00guaxWZ0AOa5NFAj0g3" + }, + "id": "entfxqCAJWWGELFTYAAA", + "name": "Restricted users group", + "value": "orn:okta:00o5rb5mt2H3d1TJd0h7:groups:00guaxWZ0AOa5NFAj0g3" + } + ] + } + }, + "ErrorAccessDenied": { + "summary": "Access Denied", + "value": { + "errorCauses": [], + "errorCode": "E0000006", + "errorId": "sampleNUSD_8fdkFd8fs8SDBK", + "errorLink": "E0000006", + "errorSummary": "You do not have permission to perform the requested action" + } + }, + "ErrorAgentTimeOut": { + "value": { + "errorCauses": [], + "errorCode": "E0000237", + "errorId": "sampleMlLvGUj_YD5v16vkYWY", + "errorLink": "E0000237", + "errorSummary": "Timed out waiting for agent" + } + }, + "ErrorAlreadyRegistered": { + "summary": "DBSC already registered", + "value": { + "errorCauses": [], + "errorCode": "E0000195", + "errorId": "oae123abc", + "errorLink": "E0000195", + "errorSummary": "DBSC binding already exists for this session" + } + }, + "ErrorApiValidationConflict": { + "summary": "Conflict", + "value": { + "errorCauses": [], + "errorCode": "E0000195", + "errorId": "sampleMlLvGUj_YD5v15vkYWX", + "errorLink": "E0000195", + "errorSummary": "Api validation failed due to conflict: {0}" + } + }, + "ErrorApiValidationFailed": { + "summary": "API Validation Failed", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: {0}" + } + }, + "ErrorAppFeatureAPIValidationFailed": { + "summary": "API validation failed", + "value": { + "errorCauses": [ + { + "errorSummary": "Provisioning is not enabled for the app instance." + } + ], + "errorCode": "E0000001", + "errorId": "oaeZLxeiHUUQomPkM8xOqvu1A", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: feature" + } + }, + "ErrorAppUserForbiddenAction": { + "description": "If the `PUSH_NEW_USERS` or `PUSH_PROFILE_UPDATES` feature is enabled and the request specifies a value for a profile-mapped (Universal Directory) attribute that doesn't match the mapped value, then a 403 error is returned.", + "summary": "Forbidden action", + "value": { + "errorCauses": [], + "errorCode": "E0000075", + "errorId": "sampleWXiR_K-WwaTKhlgBQ", + "errorLink": "E0000075", + "errorSummary": "Cannot modify the firstName attribute because it has a field mapping and profile push is enabled." + } + }, + "ErrorAppUserUpdateBadRequest": { + "description": "If you attempt to assign a username or password to an app with an incompatible authentication scheme, then a 400 error is returned.", + "summary": "Bad request", + "value": { + "errorCauses": { + "errorSummary": "User level credentials should not be provided for this scheme." + }, + "errorCode": "E0000041", + "errorId": "oaeUM77NBynQQu4C_qT5ngjGQ", + "errorLink": "E0000041", + "errorSummary": "Credentials should not be set on this resource based on the scheme." + } + }, + "ErrorBotProtectionEnforcementTypeRequired": { + "summary": "Enforcement type is required when mode is ENFORCED", + "value": { + "errorCauses": [ + { + "errorSummary": "enforcementType: Api validation failed: enforcementType must be provided when mode is ENFORCED" + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: enforcementType" + } + }, + "ErrorBotProtectionLevelRequired": { + "summary": "Level is required", + "value": { + "errorCauses": [ + { + "errorSummary": "level: The field cannot be left blank" + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: level" + } + }, + "ErrorBotProtectionModeRequired": { + "summary": "Mode is required", + "value": { + "errorCauses": [ + { + "errorSummary": "mode: The field cannot be left blank" + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: mode" + } + }, + "ErrorBotProtectionSupportedFlowsRequired": { + "summary": "Supported flows must have at least one flow", + "value": { + "errorCauses": [ + { + "errorSummary": "supportedFlows: Api validation failed: supportedFlows must have at least one supported flow" + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: supportedFlows" + } + }, + "ErrorCAPTCHALimitOfOne": { + "value": { + "errorCauses": [], + "errorCode": "E0000165", + "errorId": "oaejrB1fWL1S7mc-2KcG-SOtw", + "errorLink": "E0000165", + "errorSummary": "CAPTCHA count limit reached. At most one CAPTCHA instance is allowed per Org." + } + }, + "ErrorCAPTCHAOrgWideSetting": { + "value": { + "errorCauses": [], + "errorCode": "E0000149", + "errorId": "samplezsusshPdiTWiITwqBt8", + "errorLink": "E0000149", + "errorSummary": "Current CAPTCHA is associated with org-wide settings, cannot be removed." + } + }, + "ErrorCAPTCHAOrgWideSettingNull": { + "summary": "captchaId is null, but enabledPages is defined", + "value": { + "errorCauses": { + "errorSummary": "captchaId: Invalid CAPTCHA ID. The value of captchaId cannot be blank when enabledPages is not empty. Please resubmit with an existing CAPTCHA ID or disable CAPTCHA support on all supported pages." + }, + "errorCode": "E0000001", + "errorId": "oae-hk3rssXQmOWDRsaFfxe8A", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: captchaId" + } + }, + "ErrorChallengeExpired": { + "summary": "Refresh challenge not found or expired", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "DBSC challenge expired or not found" + } + }, + "ErrorChallengeMismatch": { + "summary": "Challenge validation failed", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "DBSC challenge validation failed" + } + }, + "ErrorChallengeNotFound": { + "summary": "Registration challenge not found or expired", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "Registration challenge not found or expired" + } + }, + "ErrorChallengeRequired": { + "summary": "Challenge required for refresh", + "value": { + "errorCauses": [], + "errorCode": "E0000031", + "errorId": "oae123abc", + "errorLink": "E0000031", + "errorSummary": "DBSC cookie required" + } + }, + "ErrorClientJsonWebKeyDuplicateKid": { + "value": { + "errorCauses": [ + { + "errorSummary": "All keys in the 'jwks' must have a unique `kid`." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorClientJsonWebKeyKidLengthTooShort": { + "value": { + "errorCauses": [ + { + "errorSummary": "RSA key length in the 'jwks' is less than '2,048' bits for the given key." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorClientJsonWebKeyNonUniqueKid": { + "value": { + "errorCauses": [ + { + "errorSummary": "Each key should have a unique kid when adding multiple keys. Use the Apps API to update the JWKS to add a kid for the existing key, or delete the existing key and re-add the key with a kid using the JWKS APIs." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorClientJsonWebKeyTooManyKids": { + "value": { + "errorCauses": [ + { + "errorSummary": "You can't create a new key. You have reached the maximum number of keys allowed (50). To add another key, you must first delete an existing one." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorClientSecretNonAscii": { + "summary": "Client secret allows only ASCII error", + "value": { + "errorCauses": [ + { + "errorSummary": "client_secret: ''client_secret'' must only contain printable ASCII: [x20-x7E]+" + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: client_secret" + } + }, + "ErrorClientSecretTooLong": { + "summary": "Client secret too long error", + "value": { + "errorCauses": [ + { + "errorSummary": "client_secret: 'client_secret' can't be more than '100' characters long." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: client_secret" + } + }, + "ErrorClientSecretTooShort": { + "summary": "Client secret too short error", + "value": { + "errorCauses": [ + { + "errorSummary": "client_secret: 'client_secret' must be at least '14' characters long." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: client_secret" + } + }, + "ErrorClientSecretTooShortWithClientSecretJWT": { + "summary": "Client secret is too short for JWT error", + "value": { + "errorCauses": [ + { + "errorSummary": "client_secret: 'client_secret' must be at least '32' characters long when 'token_endpoint_auth_method' is 'client_secret_jwt'." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: client_secret" + } + }, + "ErrorClientSecretWithPrivateKeyJWT": { + "summary": "Client secret can't be used for private key JWT error", + "value": { + "errorCauses": [ + { + "errorSummary": "'client_secret' can't be used when 'token_endpoint_auth_method' is 'private_key_jwt'." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: client_secret" + } + }, + "ErrorCreateBrandExists": { + "value": { + "errorCauses": [], + "errorCode": "E0000202", + "errorId": "oaeKABuesTdRvCXeCTpSpXAcQ", + "errorLink": "E0000202", + "errorSummary": "Brand name already exists." + } + }, + "ErrorCreateUserWithExpiredPasswordWithNullPassword": { + "value": { + "errorCauses": [ + { + "errorSummary": "Could not create user. To create a user and expire their password immediately, a password must be specified." + } + ], + "errorCode": "E0000124", + "errorId": "oaeXxuZgXBySvqi1FvtkwoYCA", + "errorLink": "E0000124", + "errorSummary": "Could not create user. To create a user and expire their password immediately, a password must be specified." + } + }, + "ErrorCreateUserWithExpiredPasswordWithoutActivation": { + "value": { + "errorCauses": [ + { + "errorSummary": "Could not create user. To create a user and expire their password immediately, `activate` must be true." + } + ], + "errorCode": "E0000125", + "errorId": "oaeDd77L9R-TJaD7j_rXsQ31w", + "errorLink": "E0000125", + "errorSummary": "Could not create user. To create a user and expire their password immediately, `activate` must be true." + } + }, + "ErrorCreateUserWithTooManyManyGroupsResponse": { + "value": { + "errorCauses": [ + { + "errorSummary": "The number of group targets is too large" + } + ], + "errorCode": "E0000093", + "errorId": "oaePVSLIYnIQsC0B-ptBIllVA", + "errorLink": "E0000093", + "errorSummary": "Target count limit exceeded" + } + }, + "ErrorDbscFeatureNotEnabled": { + "summary": "Feature not enabled for org", + "value": { + "errorCauses": [], + "errorCode": "E0000006", + "errorId": "oae123abc", + "errorLink": "E0000006", + "errorSummary": "Device Bound Session Credentials isn't enabled" + } + }, + "ErrorDbscNotEnabled": { + "summary": "DBSC not enabled for session", + "value": { + "errorCauses": [], + "errorCode": "E0000007", + "errorId": "oae123abc", + "errorLink": "E0000007", + "errorSummary": "DBSC not enabled for this session" + } + }, + "ErrorDeactivateActiveKey": { + "value": { + "errorCauses": [ + { + "errorSummary": "You cannot deactivate the active key when access token encryption is enabled." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorDeactivateEncryptionKey": { + "value": { + "errorCauses": [ + { + "errorSummary": "You can't deactivate the active encryption key." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorDeactivateTheOnlyClientSecret": { + "value": { + "errorCauses": [ + { + "errorSummary": "You can't deactivate the only active client secret." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: OAuth2ClientSecretMediated" + } + }, + "ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod": { + "value": { + "errorCauses": [ + { + "errorSummary": "Can't deactivate the only active JSON Web Key when the value for `token_endpoint_auth_method` is `private_key_jwt`." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm": { + "value": { + "errorCauses": [ + { + "errorSummary": "The `jwks` must contain at least one key with an algorithm matching the `request_object_signature_algorithm`." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorDeleteActiveJsonWebKey": { + "value": { + "errorCauses": [ + { + "errorSummary": "You can't delete an active JSON Web Key. Deactivate the key before deleting it." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorDeleteActiveSecret": { + "value": { + "errorCauses": [ + { + "errorSummary": "You can't delete an active client secret. Deactivate the secret before deleting it." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: OAuth2ClientSecretMediated" + } + }, + "ErrorDeleteBrandAssociatedWithDomain": { + "value": { + "errorCauses": [], + "errorCode": "E0000201", + "errorId": "oaeAdRqprFuTyKokyYPbURJkA", + "errorLink": "E0000201", + "errorSummary": "A brand associated with a domain cannot be deleted" + } + }, + "ErrorDeleteCustomAsActiveJsonWebKey": { + "value": { + "errorCauses": [ + { + "errorSummary": "''ACTIVE'' keys cannot be deleted. Activate another key before deleting this one." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorDeleteDefaultBrand": { + "value": { + "errorCauses": [], + "errorCode": "E0000200", + "errorId": "oaeAdRqprFuTyKokyYPbURJkA", + "errorLink": "E0000200", + "errorSummary": "A default brand cannot be deleted" + } + }, + "ErrorDeviceAssuranceInUse": { + "summary": "Can't delete device assurance policy in use by app sign-in policies", + "value": { + "errorCauses": [], + "errorId": "oaenwA1ra80S9W-pvbh4m6haA", + "errorSummary": "Device assurance is in use and cannot be deleted." + } + }, + "ErrorDevicePostureCheckInUse": { + "summary": "Can't delete device posture check in use by device assurance policies", + "value": { + "errorCauses": [], + "errorId": "oaenwA1ra80S9W-pvbh4m6haA", + "errorSummary": "Device posture check is in use and can't be deleted." + } + }, + "ErrorEmailCustomizationCannotClearDefault": { + "value": { + "errorCauses": [], + "errorCode": "E0000185", + "errorId": "oaejrB1fWL1S7mc-2KcG-SOtw", + "errorLink": "E0000185", + "errorSummary": "The isDefault parameter of the default email template customization can't be set to false." + } + }, + "ErrorEmailCustomizationCannotDeleteDefault": { + "value": { + "errorCauses": [], + "errorCode": "E0000184", + "errorId": "oaeAdRqprFuTyKokyYPbURJkA", + "errorLink": "E0000184", + "errorSummary": "A default email template customization can't be deleted." + } + }, + "ErrorEmailCustomizationDefaultAlreadyExists": { + "value": { + "errorCauses": [], + "errorCode": "E0000182", + "errorId": "oaeXYwTiMvASsC3O4HCzjFaCA", + "errorLink": "E0000182", + "errorSummary": "A default email template customization already exists." + } + }, + "ErrorEmailCustomizationLanguageAlreadyExists": { + "value": { + "errorCauses": [], + "errorCode": "E0000183", + "errorId": "oaeUcGELffqRay0u1OPdnPypw", + "errorLink": "E0000183", + "errorSummary": "An email template customization for that language already exists." + } + }, + "ErrorEmailDomainAlreadyExists": { + "value": { + "errorCauses": [], + "errorCode": "E0000197", + "errorId": "oaeEdRqprFuTyKokyYPbURJkA", + "errorLink": "E0000197", + "errorSummary": "Email domain already exists." + } + }, + "ErrorEmailDomainInUse": { + "value": { + "errorCauses": [], + "errorCode": "E0000216", + "errorId": "oaeEdRqprFuTyKokyYPbURJkB", + "errorLink": "E0000216", + "errorSummary": "Email domain can't be deleted due to mail provider restrictions." + } + }, + "ErrorEmailDomainInvalidStatus": { + "value": { + "errorCauses": [], + "errorCode": "E0000217", + "errorId": "oaeEdRqprFuTyKokyYPbURJkD", + "errorLink": "E0000217", + "errorSummary": "Invalid status. Can't validate email domain with current status." + } + }, + "ErrorEmailDomainNotVerified": { + "value": { + "errorCauses": [], + "errorCode": "E0000218", + "errorId": "oaeEdRqprFuTyKokyYPbURJkC", + "errorLink": "E0000218", + "errorSummary": "Email domain couldn't be verified by mail provider." + } + }, + "ErrorEmailSettingsRaceCondition": { + "value": { + "errorCauses": [], + "errorCode": "E0000254", + "errorId": "oaeUcGELffqRay0u1OPdnPypw", + "errorLink": "E0000254", + "errorSummary": "Another request has already been received for the settings for this email template. Please try again later." + } + }, + "ErrorExpiredJwt": { + "summary": "JWT has expired", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "DBSC registration JWT has expired" + } + }, + "ErrorInternalServer": { + "summary": "Internal Server Error", + "value": { + "errorCauses": [], + "errorCode": "E0000009", + "errorId": "sampleAlJ82XS2SDB_vaNIWgcA", + "errorLink": "E0000000", + "errorSummary": "Internal Server Error" + } + }, + "ErrorInvalidAudience": { + "summary": "Invalid JWT audience", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "Invalid JWT audience" + } + }, + "ErrorInvalidEmailTemplateRecipients": { + "value": { + "errorCauses": [], + "errorCode": "E0000189", + "errorId": "oae8L1-UkcNTeGi5xVQ28_lww", + "errorLink": "E0000189", + "errorSummary": "This template does not support the recipients value." + } + }, + "ErrorInvalidJwt": { + "summary": "Invalid or malformed JWT", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "Invalid DBSC JWT" + } + }, + "ErrorInvalidLinkedObjectDef": { + "summary": "Invalid linked objection definition", + "value": { + "errorCauses": [ + { + "domain": "linkedObjects", + "errorSummary": "Linked object identifier for primary is already in use.", + "locationType": "body", + "reason": "UNIQUE_CONSTRAINT" + }, + { + "domain": "linkedObjects", + "errorSummary": "Linked object identifier for associated is already in use.", + "locationType": "body", + "reason": "UNIQUE_CONSTRAINT" + } + ], + "errorCode": "E0000127", + "errorId": "oaeh5FICFF2RnqakoNofPadhw", + "errorLink": "E0000127", + "errorSummary": "Invalid linked objection definition. Linked object identifier is already in use." + } + }, + "ErrorInvalidPublicKey": { + "summary": "Invalid public key format", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "Invalid public key in DBSC JWT" + } + }, + "ErrorInvalidRefreshJwt": { + "summary": "Invalid refresh JWT signature", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "Invalid DBSC refresh JWT signature" + } + }, + "ErrorInvalidSession": { + "summary": "Invalid or expired session", + "value": { + "errorCauses": [], + "errorCode": "E0000011", + "errorId": "oae123abc", + "errorLink": "E0000011", + "errorSummary": "Invalid session" + } + }, + "ErrorInvalidTokenProvided": { + "summary": "Invalid Token Provided", + "value": { + "errorCauses": [], + "errorCode": "E0000011", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000011", + "errorSummary": "Invalid token provided" + } + }, + "ErrorInvalidWellKnownPath": { + "summary": "Invalid path", + "value": { + "errorCauses": [ + { + "errorSummary": "The specified path is not supported. Valid values: [apple-app-site-association, assetlinks.json, webauthn]." + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: request" + } + }, + "ErrorJsonWebKeyCannotAddActiveKey": { + "value": { + "errorCauses": [ + { + "errorSummary": "Keys cannot be created with an ''ACTIVE'' status. Create an ''INACTIVE'' key and then activate it." + } + ], + "errorCode": "E0000001,", + "errorId": "sampleQPivGUj_ND5v78vbYWW,", + "errorLink": "E0000001,", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorJsonWebKeyKidLengthTooShort": { + "value": { + "errorCauses": [ + { + "errorSummary": "RSA key length in the 'jwks' is less than '2,048' bits for the given key." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorJsonWebKeyNonUniqueKid": { + "value": { + "errorCauses": [ + { + "errorSummary": "Each key must have a unique ''kid''." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorJsonWebKeyTooManyKids": { + "value": { + "errorCauses": [ + { + "errorSummary": "You can't create a new key. You have reached the maximum number of keys allowed (5). To add another key, you must first delete an existing one." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorKeyCredentialCloneDuplicateKey": { + "summary": "Duplicate key credential error", + "value": { + "errorCauses": [ + { + "errorSummary": "Key already exists in the list of key credentials for the target app." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: cloneKey" + } + }, + "ErrorKeyCredentialInvalidValidity": { + "summary": "Key credential invalid year error", + "value": { + "errorCauses": [ + { + "errorSummary": "Validity years out of range. It should be 2 - 10 years." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: generateKey" + } + }, + "ErrorMaxNumberOfSecrets": { + "summary": "Maximum client secrets reached error", + "value": { + "errorCauses": [ + { + "errorSummary": "You've reached the maximum number of client secrets per client." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: OAuth2ClientSecretMediated" + } + }, + "ErrorMissingHeader": { + "summary": "Missing Secure-Session-Response header", + "value": { + "errorCauses": [], + "errorCode": "E0000028", + "errorId": "oae123abc", + "errorLink": "E0000028", + "errorSummary": "Missing required header: Secure-Session-Response" + } + }, + "ErrorMissingRequiredParameter": { + "summary": "Missing Required Parameter", + "value": { + "errorCauses": [], + "errorCode": "E0000028", + "errorId": "sampleiCF-l7mr9XqM1NQ", + "errorLink": "E0000028", + "errorSummary": "The request is missing a required parameter." + } + }, + "ErrorMissingSessionIdHeader": { + "summary": "Missing Sec-Secure-Session-Id header", + "value": { + "errorCauses": [], + "errorCode": "E0000028", + "errorId": "oae123abc", + "errorLink": "E0000028", + "errorSummary": "Missing required header: Sec-Secure-Session-Id" + } + }, + "ErrorNoConnectedAgents": { + "value": { + "errorCauses": [], + "errorCode": "E0000236", + "errorId": "sampleMlLvGUj_YD5v16vkYWY", + "errorLink": "E0000236", + "errorSummary": "There are no connected agents" + } + }, + "ErrorOnlyOneActiveEncryptionKeyAllowed": { + "value": { + "errorCauses": [ + { + "errorSummary": "The client can have only one active encryption key in the 'jwks'." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: JsonWebKey" + } + }, + "ErrorPinOrCredRequestsGenerationFailure": { + "summary": "PIN or cred requests generation failed", + "value": { + "errorCauses": { + "errorSummary": "There was an unexpected internal error. Please try again." + }, + "errorCode": "E0000001", + "errorId": "oaehk3rssXQmOWDRsaFfxe8A", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: webAuthnPreregistrationPinRequest|webAuthnPreregistrationCredentialRequest" + } + }, + "ErrorPinOrCredResponsesProcessingFailure": { + "summary": "PIN or cred response processing failed", + "value": { + "errorCauses": { + "errorSummary": "There was an unexpected internal error. Please try again." + }, + "errorCode": "E0000001", + "errorId": "oaehk3rssXQmOWDRsaFfxe8B", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: pinResponseJwe|webAuthnCredResponse" + } + }, + "ErrorPublicKeyMismatch": { + "summary": "Public key doesn't match existing binding.", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "DBSC public key mismatch" + } + }, + "ErrorPublishCSRCertDoesNotMatchCSR": { + "summary": "Mismatch certificate and CSR error", + "value": { + "errorCauses": [ + { + "errorSummary": "The certificate doesn't match the CSR." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: certificate" + } + }, + "ErrorPublishCSRCertValidityLessThan90Days": { + "summary": "Certificate valid for 90 days error", + "value": { + "errorCauses": [ + { + "errorSummary": "The certificate must be valid for more than 90 days." + } + ], + "errorCode": "E0000001", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: certificate" + } + }, + "ErrorPushProviderUsedByCustomAppAuthenticator": { + "value": { + "errorCauses": [], + "errorCode": "E0000187", + "errorId": "oaenwA1ra80S9W-pvbh4m6haA", + "errorLink": "E0000187", + "errorSummary": "Cannot delete push provider because it is being used by a custom app authenticator." + } + }, + "ErrorResourceNotFound": { + "summary": "Resource Not Found", + "value": { + "errorCauses": [], + "errorCode": "E0000007", + "errorId": "sampleMlLvGUj_YD5v16vkYWY", + "errorLink": "E0000007", + "errorSummary": "Not found: {0}" + } + }, + "ErrorTargetAppType": { + "value": { + "errorCauses": [ + { + "errorSummary": "The target application must be an OIDC or SAML app." + } + ], + "errorCode": "E0000001", + "errorId": "oae7oXKyr41R7yW8Q-gMZsTrA", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: Interclient Trust Mappings" + } + }, + "ErrorThumbprintFailed": { + "summary": "JWK thumbprint computation failed", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "Failed to compute JWK thumbprint" + } + }, + "ErrorTooManyAllowedApps": { + "value": { + "errorCauses": [ + { + "errorSummary": "The target application cannot have more than 5 trusted apps." + } + ], + "errorCode": "E0000001", + "errorId": "oae7oXKyr41R7yW8Q-gMZsTrA", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: Interclient Trust Mappings" + } + }, + "ErrorTooManyRequests": { + "summary": "Too Many Requests", + "value": { + "errorCauses": [], + "errorCode": "E0000047", + "errorId": "sampleQPivGUj_ND5v78vbYWW", + "errorLink": "E0000047", + "errorSummary": "API call exceeded rate limit due to too many requests." + } + }, + "ErrorUnsupportedAlgorithm": { + "summary": "Unsupported signing algorithm", + "value": { + "errorCauses": [], + "errorCode": "E0000001", + "errorId": "oae123abc", + "errorLink": "E0000001", + "errorSummary": "Unsupported DBSC algorithm. Supported: ES256, RS256" + } + }, + "ExampleOAuth2Scope": { + "summary": "Example scope", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/scp5yu8kLOnDzo7lh0g4" + } + }, + "consent": "REQUIRED", + "default": false, + "description": "Drive car", + "displayName": "Saml Jackson", + "id": "scp5yu8kLOnDzo7lh0g4", + "metadataPublish": "NO_CLIENTS", + "name": "car:drive", + "optional": false, + "system": false + } + }, + "ExampleOAuth2Scopes": { + "summary": "All scopes", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/scp5yu8kLOnDzo7lh0g4" + } + }, + "consent": "REQUIRED", + "default": false, + "description": "Drive car", + "displayName": "Saml Jackson", + "id": "scp5yu8kLOnDzo7lh0g4", + "metadataPublish": "NO_CLIENTS", + "name": "car:drive", + "optional": false, + "system": false + } + ] + }, + "ExpirePwdResponse": { + "value": { + "_links": { + "changePassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/credentials/change_password" + }, + "changeRecoveryQuestion": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/credentials/change_recovery_question" + }, + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/deactivate" + }, + "expirePassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/expire_password" + }, + "forgotPassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/credentials/forgot_password" + }, + "resetFactors": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/reset_factors" + }, + "resetPassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/reset_password" + } + }, + "activated": "2013-06-24T16:39:19.000Z", + "created": "2013-06-24T16:39:18.000Z", + "credentials": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + }, + "recovery_question": { + "question": "Who's a major player in the cowboy scene?" + } + }, + "id": "00ub0oNGTSWTBKOLGLNR", + "lastLogin": "2013-06-24T17:39:19.000Z", + "lastUpdated": "2013-06-27T16:35:28.000Z", + "passwordChanged": "2013-06-24T16:39:19.000Z", + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + }, + "status": "PASSWORD_EXPIRED", + "statusChanged": "2013-06-24T16:39:19.000Z" + } + }, + "ExpirePwdWithTempPwdResponse": { + "value": { + "tempPassword": "F46gy7X4" + } + }, + "ExpiredAuthorizationServerKey": { + "summary": "Expired authorization server key", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/h5Sr3LXcpQiQlAUVPdhrdLFoIvkhRTAVs_h39bQnxlU" + } + }, + "alg": "RS256", + "e": "AQAB", + "kid": "h5Sr3LXcpQiQlAUVPdhrdLFoIvkhRTAVs_h39bQnxlU", + "kty": "RSA", + "n": "lC4ehVB6W0OCtNPnz8udYH9Ao83B6EKnHA5eTcMOap_lQZ-nKtS1lZwBj4wXRVc1XmS0d2OQFA1VMQ-dHLDE3CiGfsGqWbaiZFdW7U GLO1nAwfDdH6xp3xwpKOMewDXbAHJlXdYYAe2ap - CE9c5WLTUBU6JROuWcorHCNJisj1aExyiY5t3JQQVGpBz2oUIHo7NRzQoKimvp dMvMzcYnTlk1dhlG11b1GTkBclprm1BmOP7Ltjd7aEumOJWS67nKcAZzl48Zyg5KtV11V9F9dkGt25qHauqFKL7w3wu - DYhT0hmyFc wn - tXS6e6HQbfHhR_MQxysLtDGOk2ViWv8AQ", + "status": "EXPIRED", + "use": "sig" + } + }, + "ExpressConfiguration": { + "summary": "Express configuration example", + "value": { + "applicationClientId": "0oa9z8y7x6w5v4u3t2s1", + "capabilities": [ + "SSO" + ], + "initiateLoginUriTemplate": "https://example.auth0.com/login/initiate", + "loginDomain": "login.example.com", + "oinClientId": "0oa1a2b3c4d5e6f7g8h9", + "tenantDomain": "example.auth0.com" + } + }, + "ExtendOktaSupportAccessStatus": { + "summary": "Extend Okta Support access", + "value": { + "caseNumber": "1011001", + "impersonation": { + "expiration": "2024-01-25T11:13:14.000Z", + "status": "ENABLED" + } + } + }, + "ExtendOktaSupportAccessStatusRequest": { + "summary": "Extend Okta Support access", + "value": { + "impersonation": { + "expiration": "2024-01-25T11:13:14.000Z" + } + } + }, + "FacebookIdPResponse": { + "summary": "Facebook IdP", + "value": { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62b57p7c8PaGpU0h7&\n client_id={clientId}&response_type={responseType}&response_mode={responseMode}&\n scope={scopes}&redirect_uri={redirectUri}&state={state}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2016-03-24T23:18:27.000Z", + "id": "0oa62b57p7c8PaGpU0h7", + "lastUpdated": "2016-03-24T23:18:27.000Z", + "name": "Facebook", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://www.facebook.com/dialog/oauth" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://graph.facebook.com/v2.5/oauth/access_token" + } + }, + "scopes": [ + "public_profile", + "email" + ], + "type": "OAUTH2" + }, + "status": "ACTIVE", + "type": "FACEBOOK" + } + }, + "FactorEmail": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3/verify" + } + }, + "factorType": "email", + "id": "emfnf3gSScB8xXoXK0g3", + "profile": { + "email": "changed@clouditude.net" + }, + "provider": "OKTA", + "status": "ACTIVE", + "vendorName": "OKTA" + } + }, + "FactorPasscodeRequest": { + "value": { + "passCode": "123456" + } + }, + "FactorResponseSms": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/sms2gt8gzgEBPUWBIFHN" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/sms2gt8gzgEBPUWBIFHN/verify" + } + }, + "created": "2014-06-27T20:27:26.000Z", + "factorType": "sms", + "id": "sms2gt8gzgEBPUWBIFHN", + "lastUpdated": "2014-06-27T20:27:26.000Z", + "profile": { + "phoneNumber": "+1-555-415-1337" + }, + "provider": "OKTA", + "status": "ACTIVE", + "vendorName": "OKTA" + } + }, + "ForgotPwdRecoveryQuestionRequest": { + "value": { + "password": { + "value": "uTVM,TPw55" + }, + "recovery_question": { + "answer": "Annie Oakley" + } + } + }, + "ForgotPwdRecoveryQuestionResponse": { + "value": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + }, + "recovery_question": { + "question": "Who's a major player in the cowboy scene?" + } + } + }, + "ForgotPwdResponse": { + "value": { + "resetPasswordUrl": "https://{yourOktaDomain}/signin/reset-password/XE6wE17zmphl3KqAPFxO" + } + }, + "GenerateFulfillmentRequestExample": { + "summary": "Generate fulfillment request", + "value": { + "fulfillmentData": [ + { + "customizationId": "RXJN83", + "inventoryProductId": "106", + "productId": "55" + } + ], + "fulfillmentProvider": "yubico", + "userId": "00us2hPODQncCkxef0g3" + } + }, + "GenericOidcIdpResponse": { + "summary": "Generic OpenID Connect IdP", + "value": { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oaulob4BFVa4zQvt0g3&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}&nonce={nonce}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2019-02-07T20:07:47.000Z", + "id": "0oaulob4BFVa4zQvt0g3", + "lastUpdated": "2019-02-07T20:07:47.000Z", + "name": "Example OpenID Connect IdP", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.email" + } + }, + "trustClaims": false + }, + "protocol": { + "algorithms": { + "request": { + "signature": { + "algorithm": "HS256", + "scope": "REQUEST" + } + } + }, + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret", + "pkce_required": "true" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/authorize" + }, + "jwks": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/keys" + }, + "slo": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/slo" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://idp.example.com/token" + }, + "userInfo": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/userinfo" + } + }, + "issuer": { + "url": "https://idp.example.com" + }, + "scopes": [ + "openid" + ], + "settings": { + "participateSlo": true + }, + "type": "OIDC" + }, + "status": "ACTIVE", + "type": "OIDC" + } + }, + "Get-User-Classification-Example": { + "value": { + "lastUpdated": "2022-05-04T19:50:52.000Z", + "type": "LITE" + } + }, + "GetApplicationsByGroupResponseEx": { + "summary": "Retrieve apps assigned to a group", + "value": [ + { + "_links": { + "appLinks": [ + { + "href": "https://testorgone.okta.com/home/workday/0oa7vicdkRNrz59R80w6/30", + "name": "login", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/lifecycle/deactivate" + }, + "groups": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/groups" + }, + "help": { + "href": "https://testorgone-admin.okta.com/app/workday/0oa7vicdkRNrz59R80w6/setup/help/SAML_2_0/external-doc", + "type": "text/html" + }, + "logo": [ + { + "href": "https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6", + "name": "medium", + "type": "image/png" + } + ], + "metadata": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/sso/saml/metadata", + "type": "application/xml" + }, + "users": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2021-05-17T23:10:49.000Z", + "credentials": { + "signing": { + "kid": "wRejFXWxFlK9nnLozx5qKWQa3fg-JRXw7dvdlTjs5Pg" + }, + "userNameTemplate": { + "template": "${source.login}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oa7vicdkRNrz59R80w6", + "label": "hrportal2", + "lastUpdated": "2021-05-17T23:10:50.000Z", + "name": "workday", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:workday:0oa7vicdkRNrz59R80w6", + "settings": { + "app": { + "siteURL": "https://acme.workday.com" + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "attributeStatements": [], + "audienceOverride": null, + "defaultRelayState": null, + "destinationOverride": null, + "recipientOverride": null, + "ssoAcsUrlOverride": null + } + }, + "signOnMode": "SAML_2_0", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + }, + { + "_links": { + "appLinks": [ + { + "href": "https://testorgone.okta.com/home/workday/0oa7vicvor8YSr9Hc0w6/30", + "name": "login", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/lifecycle/deactivate" + }, + "groups": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/groups" + }, + "help": { + "href": "https://testorgone-admin.okta.com/app/workday/0oa7vicvor8YSr9Hc0w6/setup/help/SAML_2_0/external-doc", + "type": "text/html" + }, + "logo": [ + { + "href": "https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6", + "name": "medium", + "type": "image/png" + } + ], + "metadata": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/sso/saml/metadata", + "type": "application/xml" + }, + "users": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2021-05-17T23:10:22.000Z", + "credentials": { + "signing": { + "kid": "wRejFXWxFlK9nnLozx5qKWQa3fg-JRXw7dvdlTjs5Pg" + }, + "userNameTemplate": { + "template": "${source.login}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oa7vicvor8YSr9Hc0w6", + "label": "hrportal1", + "lastUpdated": "2021-05-17T23:10:22.000Z", + "name": "workday", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:workday:0oa7vicvor8YSr9Hc0w6", + "settings": { + "app": { + "siteURL": "https://acme.workday.com" + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "attributeStatements": [], + "audienceOverride": null, + "defaultRelayState": null, + "destinationOverride": null, + "recipientOverride": null, + "ssoAcsUrlOverride": null + } + }, + "signOnMode": "SAML_2_0", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + }, + { + "_links": { + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/groups" + }, + "logo": [ + { + "href": "https:/example.okta.com/img/logos/logo_1.png", + "name": "medium", + "type": "image/png" + } + ], + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "selfService": false + }, + "created": "2013-09-11T17:46:08.000Z", + "credentials": { + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "userNameTemplate": { + "template": "${source.login}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oabkvBLDEKCNXBGYUAS", + "label": "Sample Plugin App", + "lastUpdated": "2013-09-11T17:58:54.000Z", + "name": "template_swa", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_swa:0oabkvBLDEKCNXBGYUAS", + "settings": { + "app": { + "buttonField": "btn-login", + "passwordField": "txtbox-password", + "url": "https://example.com/login.html", + "usernameField": "txtbox-username" + } + }, + "signOnMode": "BROWSER_PLUGIN", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + ] + }, + "GetApplicationsByKeyResponseEx": { + "summary": "Retrieve apps using a key", + "value": [ + { + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2016-08-09T20:12:19.000Z", + "credentials": { + "signing": {}, + "userNameTemplate": { + "template": "${fn:substringBefore(source.login, \"@\")}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oa1gjh63g214q0Hq0g4", + "label": "Custom Saml 2.0 App", + "lastUpdated": "2016-08-09T20:12:19.000Z", + "name": "testorgone_customsaml20app_1", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4", + "settings": { + "app": {}, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "assertionEncryption": { + "_embedded": { + "_embedded": { + "user": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00ucw2RPGIUNTDQOYPOF" + } + }, + "created": "2014-06-10T15:16:01.000Z", + "credentials": { + "password": {}, + "userName": "user@example.com" + }, + "externalId": null, + "id": "00ucw2RPGIUNTDQOYPOF", + "lastSync": null, + "lastUpdated": "2014-06-10T15:17:38.000Z", + "passwordChanged": "2014-06-10T15:17:38.000Z", + "scope": "USER", + "status": "ACTIVE", + "statusChanged": "2014-06-10T15:16:01.000Z", + "syncState": "DISABLED" + } + }, + "_links": { + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/groups" + }, + "logo": [ + { + "href": "https://example.okta.com/img/logos/logo_1.png", + "name": "medium", + "type": "image/png" + } + ], + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "selfService": false + }, + "created": "2013-09-11T17:46:08.000Z", + "credentials": { + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "userNameTemplate": { + "template": "${source.login}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oabkvBLDEKCNXBGYUAS", + "label": "Sample Plugin App", + "lastUpdated": "2013-09-11T17:58:54.000Z", + "name": "template_swa", + "settings": { + "app": { + "buttonField": "btn-login", + "passwordField": "txtbox-password", + "url": "https://example.com/login.html", + "usernameField": "txtbox-username" + } + }, + "signOnMode": "BROWSER_PLUGIN", + "status": "ACTIVE", + "user": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabizCHPNYALCHDUIOD" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00ucw2RPGIUNTDQOYPOF" + } + }, + "created": "2014-03-21T23:31:35.000Z", + "credentials": { + "userName": "user@example.com" + }, + "externalId": null, + "id": "00ucw2RPGIUNTDQOYPOF", + "lastSync": null, + "lastUpdated": "2014-03-21T23:31:35.000Z", + "passwordChanged": null, + "scope": "USER", + "status": "ACTIVE", + "statusChanged": "2014-03-21T23:31:35.000Z", + "syncState": "DISABLED" + }, + "visibility": { + "appLinks": { + "login": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + }, + "_links": { + "appLinks": [ + { + "href": "https://testorgone.okta.com/home/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/aln1gofChJaerOVfY0g4", + "name": "testorgone_customsaml20app_1_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/lifecycle/deactivate" + }, + "groups": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/groups" + }, + "help": { + "href": "https://testorgone-admin.okta.com/app/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/setup/help/SAML_2_0/instructions", + "type": "text/html" + }, + "logo": [ + { + "href": "https://testorgone.okta.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "metadata": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/sso/saml/metadata", + "type": "application/xml" + }, + "users": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/users" + } + }, + "acsEndpoints": [], + "allowMultipleAcsEndpoints": false, + "attributeStatements": [], + "enabled": true, + "encryptionAlgorithm": "AES256_GCM", + "keyTransportAlgorithm": "RSA_15", + "requestCompressed": false, + "x5c": [ + "MIIC6jCCAdKgAwIBAgIGAZKbFN7JMA0GCSqGSIb3DQEBCwUAMDYxNDAyBgNVBAMM\r\n" + ] + }, + "assertionSigned": true, + "audience": "https://example.com/tenant/123", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "defaultRelayState": "", + "destination": "https://destination.okta.com", + "digestAlgorithm": "SHA256", + "honorForceAuthn": true, + "idpIssuer": "https://www.okta.com/${org.externalKey}", + "participateSlo": { + "bindingType": "REDIRECT", + "enabled": true, + "logoutRequestUrl": "https://testorgone.okta.com/logout/participate", + "sessionIndexRequired": true + }, + "recipient": "https://recipient.okta.com", + "responseSigned": true, + "signatureAlgorithm": "RSA_SHA256", + "slo": { + "enabled": true, + "logoutUrl": "https://testorgone.okta.com/logout", + "spIssuer": "https://testorgone.okta.com" + }, + "spCertificate": { + "x5c": [ + "MIIFnDCCA4QCCQDBSLbiON2T1zANBgkqhkiG9w0BAQsFADCBjzELMAkGA1UEBhMCVVMxDjAMBgNV\r\n" + ] + }, + "ssoAcsUrl": "https://{yourOktaDomain}", + "subjectNameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "subjectNameIdTemplate": "${user.userName}" + } + }, + "signOnMode": "SAML_2_0", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "testorgone_customsaml20app_1_link": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + ] + }, + "GetApplicationsByNameResponseEx": { + "summary": "Retrieve apps by name", + "value": [ + { + "_links": { + "appLinks": [ + { + "href": "https://testorgone.okta.com/home/workday/0oa7vicdkRNrz59R80w6/30", + "name": "login", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/lifecycle/deactivate" + }, + "groups": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/groups" + }, + "help": { + "href": "https://testorgone-admin.okta.com/app/workday/0oa7vicdkRNrz59R80w6/setup/help/SAML_2_0/external-doc", + "type": "text/html" + }, + "logo": [ + { + "href": "https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6", + "name": "medium", + "type": "image/png" + } + ], + "metadata": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/sso/saml/metadata", + "type": "application/xml" + }, + "users": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2021-05-17T23:10:49.000Z", + "credentials": { + "signing": { + "kid": "wRejFXWxFlK9nnLozx5qKWQa3fg-JRXw7dvdlTjs5Pg" + }, + "userNameTemplate": { + "template": "${source.login}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oa7vicdkRNrz59R80w6", + "label": "hrportal2", + "lastUpdated": "2021-05-17T23:10:50.000Z", + "name": "workday", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:workday:0oa7vicdkRNrz59R80w6", + "settings": { + "app": { + "siteURL": "https://acme.workday.com" + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "attributeStatements": [], + "audienceOverride": null, + "defaultRelayState": null, + "destinationOverride": null, + "recipientOverride": null, + "ssoAcsUrlOverride": null + } + }, + "signOnMode": "SAML_2_0", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + }, + { + "_links": { + "appLinks": [ + { + "href": "https://testorgone.okta.com/home/workday/0oa7vicvor8YSr9Hc0w6/30", + "name": "login", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/lifecycle/deactivate" + }, + "groups": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/groups" + }, + "help": { + "href": "https://testorgone-admin.okta.com/app/workday/0oa7vicvor8YSr9Hc0w6/setup/help/SAML_2_0/external-doc", + "type": "text/html" + }, + "logo": [ + { + "href": "https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6", + "name": "medium", + "type": "image/png" + } + ], + "metadata": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/sso/saml/metadata", + "type": "application/xml" + }, + "users": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2021-05-17T23:10:22.000Z", + "credentials": { + "signing": { + "kid": "wRejFXWxFlK9nnLozx5qKWQa3fg-JRXw7dvdlTjs5Pg" + }, + "userNameTemplate": { + "template": "${source.login}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oa7vicvor8YSr9Hc0w6", + "label": "hrportal1", + "lastUpdated": "2021-05-17T23:10:22.000Z", + "name": "workday", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:workday:0oa7vicdkRNrz59R80w6", + "settings": { + "app": { + "siteURL": "https://acme.workday.com" + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "attributeStatements": [], + "audienceOverride": null, + "defaultRelayState": null, + "destinationOverride": null, + "recipientOverride": null, + "ssoAcsUrlOverride": null + } + }, + "signOnMode": "SAML_2_0", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + ] + }, + "GetApplicationsByUserResponseEx": { + "summary": "Retrieve apps assigned to a user", + "value": [ + { + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2016-08-09T20:12:19.000Z", + "credentials": { + "signing": {}, + "userNameTemplate": { + "template": "${fn:substringBefore(source.login, \"@\")}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oa1gjh63g214q0Hq0g4", + "label": "Custom Saml 2.0 App", + "lastUpdated": "2016-08-09T20:12:19.000Z", + "name": "testorgone_customsaml20app_1", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4", + "settings": { + "app": {}, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "assertionEncryption": { + "_embedded": { + "_embedded": { + "user": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00ucw2RPGIUNTDQOYPOF" + } + }, + "created": "2014-06-10T15:16:01.000Z", + "credentials": { + "password": {}, + "userName": "user@example.com" + }, + "externalId": null, + "id": "00ucw2RPGIUNTDQOYPOF", + "lastSync": null, + "lastUpdated": "2014-06-10T15:17:38.000Z", + "passwordChanged": "2014-06-10T15:17:38.000Z", + "scope": "USER", + "status": "ACTIVE", + "statusChanged": "2014-06-10T15:16:01.000Z", + "syncState": "DISABLED" + } + }, + "_links": { + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/groups" + }, + "logo": [ + { + "href": "https://example.okta.com/img/logos/logo_1.png", + "name": "medium", + "type": "image/png" + } + ], + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "selfService": false + }, + "created": "2013-09-11T17:46:08.000Z", + "credentials": { + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "userNameTemplate": { + "template": "${source.login}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oabkvBLDEKCNXBGYUAS", + "label": "Sample Plugin App", + "lastUpdated": "2013-09-11T17:58:54.000Z", + "name": "template_swa", + "settings": { + "app": { + "buttonField": "btn-login", + "passwordField": "txtbox-password", + "url": "https://example.com/login.html", + "usernameField": "txtbox-username" + } + }, + "signOnMode": "BROWSER_PLUGIN", + "status": "ACTIVE", + "user": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabizCHPNYALCHDUIOD" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00ucw2RPGIUNTDQOYPOF" + } + }, + "created": "2014-03-21T23:31:35.000Z", + "credentials": { + "userName": "user@example.com" + }, + "externalId": null, + "id": "00ucw2RPGIUNTDQOYPOF", + "lastSync": null, + "lastUpdated": "2014-03-21T23:31:35.000Z", + "passwordChanged": null, + "scope": "USER", + "status": "ACTIVE", + "statusChanged": "2014-03-21T23:31:35.000Z", + "syncState": "DISABLED" + }, + "visibility": { + "appLinks": { + "login": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + }, + "_links": { + "appLinks": [ + { + "href": "https://testorgone.okta.com/home/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/aln1gofChJaerOVfY0g4", + "name": "testorgone_customsaml20app_1_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/lifecycle/deactivate" + }, + "groups": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/groups" + }, + "help": { + "href": "https://testorgone-admin.okta.com/app/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/setup/help/SAML_2_0/instructions", + "type": "text/html" + }, + "logo": [ + { + "href": "https://testorgone.okta.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "metadata": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/sso/saml/metadata", + "type": "application/xml" + }, + "users": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/users" + } + }, + "acsEndpoints": [], + "allowMultipleAcsEndpoints": false, + "attributeStatements": [], + "enabled": false, + "requestCompressed": false + }, + "assertionSigned": true, + "audience": "https://example.com/tenant/123", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "defaultRelayState": "", + "destination": "https://destination.okta.com", + "digestAlgorithm": "SHA256", + "honorForceAuthn": true, + "idpIssuer": "https://www.okta.com/${org.externalKey}", + "participateSlo": { + "bindingType": "REDIRECT", + "enabled": true, + "logoutRequestUrl": "https://testorgone.okta.com/logout/participate", + "sessionIndexRequired": true + }, + "recipient": "https://recipient.okta.com", + "responseSigned": true, + "signatureAlgorithm": "RSA_SHA256", + "slo": { + "enabled": true, + "logoutUrl": "https://testorgone.okta.com/logout", + "spIssuer": "https://testorgone.okta.com" + }, + "spCertificate": { + "x5c": [ + "MIIFnDCCA4QCCQDBSLbiON2T1zANBgkqhkiG9w0BAQsFADCBjzELMAkGA1UEBhMCVVMxDjAMBgNV\r\n" + ] + }, + "ssoAcsUrl": "https://{yourOktaDomain}", + "subjectNameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "subjectNameIdTemplate": "${user.userName}" + } + }, + "signOnMode": "SAML_2_0", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "testorgone_customsaml20app_1_link": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + ] + }, + "GetApplicationsResponseEx": { + "summary": "Retrieve an app", + "value": { + "_links": { + "appLinks": [ + { + "href": "https://testorgone.okta.com/home/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/aln1gofChJaerOVfY0g4", + "name": "testorgone_customsaml20app_1_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/lifecycle/deactivate" + }, + "groups": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/groups" + }, + "help": { + "href": "https://testorgone-admin.okta.com/app/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/setup/help/SAML_2_0/instructions", + "type": "text/html" + }, + "logo": [ + { + "href": "https://testorgone.okta.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "metadata": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/sso/saml/metadata", + "type": "application/xml" + }, + "users": { + "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2016-08-09T20:12:19.000Z", + "credentials": { + "signing": {}, + "userNameTemplate": { + "template": "${fn:substringBefore(source.login, \"@\")}", + "type": "BUILT_IN" + } + }, + "expressConfiguration": { + "enabledCapabilities": [ + "SSO" + ], + "supportedCapabilities": [ + "SSO", + "PROVISIONING", + "UNIVERSAL_LOGOUT" + ] + }, + "features": [], + "id": "0oa1gjh63g214q0Hq0g4", + "label": "Custom Saml 2.0 App", + "lastUpdated": "2016-08-09T20:12:19.000Z", + "name": "testorgone_customsaml20app_1", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4", + "settings": { + "app": {}, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "acsEndpoints": [], + "allowMultipleAcsEndpoints": false, + "assertionEncryption": { + "enabled": true, + "encryptionAlgorithm": "AES256_GCM", + "keyTransportAlgorithm": "RSA_15", + "x5c": [ + "MIIC6jCCAdKgAwIBAgIGAZKbFN7JMA0GCSqGSIb3DQEBCwUAMDYxNDAyBgNVBAMM\r\n" + ] + }, + "assertionSigned": true, + "attributeStatements": [], + "audience": "https://example.com/tenant/123", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "defaultRelayState": "", + "destination": "https://destination.okta.com", + "digestAlgorithm": "SHA256", + "honorForceAuthn": true, + "idpIssuer": "https://www.okta.com/${org.externalKey}", + "inlineHooks": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/inlineHooks/cal3ughy17pylLxQB357" + } + }, + "id": "cal3ughy17pylLxQB357" + } + ], + "participateSlo": { + "bindingType": "REDIRECT", + "enabled": true, + "logoutRequestUrl": "https://testorgone.okta.com/logout/participate", + "sessionIndexRequired": true + }, + "recipient": "https://recipient.okta.com", + "requestCompressed": false, + "responseSigned": true, + "signatureAlgorithm": "RSA_SHA256", + "slo": { + "enabled": true, + "logoutUrl": "https://testorgone.okta.com/logout", + "spIssuer": "https://testorgone.okta.com" + }, + "spCertificate": { + "x5c": [ + "MIIFnDCCA4QCCQDBSLbiON2T1zANBgkqhkiG9w0BAQsFADCBjzELMAkGA1UEBhMCVVMxDjAMBgNV\r\n" + ] + }, + "ssoAcsUrl": "https://{yourOktaDomain}", + "subjectNameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "subjectNameIdTemplate": "${user.userName}" + } + }, + "signOnMode": "SAML_2_0", + "status": "ACTIVE", + "universalLogout": { + "identityStack": "NOT_SHARED", + "protocol": "GLOBAL_TOKEN_REVOCATION", + "status": "ENABLED", + "supportType": "FULL" + }, + "visibility": { + "appLinks": { + "testorgone_customsaml20app_1_link": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "GetAssociatedLinkedObjectsResponse": { + "summary": "Retrieve all associated linked object values response", + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u5zex6ztMbOZhF50h7" + } + } + }, + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1tsf0nQKavLDUh0g5" + } + } + } + ] + }, + "GetBrandResponse": { + "value": { + "_links": { + "emailDomain": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/email-domains/OeD114iNkrcN6aR680g4" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4" + }, + "themes": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/themes" + } + }, + "agreeToCustomPrivacyPolicy": false, + "customPrivacyPolicyUrl": null, + "defaultApp": { + "appInstanceId": "0oa114iNkrcN6aR680g4", + "appLinkName": null, + "classicApplicationUri": null + }, + "emailDomainId": "OeD114iNkrcN6aR680g4", + "id": "bnd114iNkrcN6aR680g4", + "isDefault": true, + "locale": "en", + "name": "Okta Default", + "removePoweredByOkta": false + } + }, + "GetEmailTemplateResponse": { + "value": { + "_embedded": { + "customizationCount": 0, + "settings": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings" + }, + "template": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + } + }, + "recipients": "ALL_USERS" + } + }, + "_links": { + "customizations": { + "hints": { + "allow": [ + "GET", + "POST", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations" + }, + "defaultContent": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + }, + "settings": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings" + }, + "test": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" + } + }, + "name": "UserActivation" + } + }, + "GetPrimaryLinkedObjectResponse": { + "summary": "Retrieve primary linked object value response", + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7" + } + } + } + ] + }, + "GetRealmAssignmentResponse": { + "value": { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/realm-assignments/rul2jy7jLUlnO3ng00g4", + "method": "GET", + "rel": "self" + } + }, + "actions": { + "assignUserToRealm": { + "realmId": "00g1b7rvh0xPLKXFf0g5" + } + }, + "conditions": { + "expression": { + "value": "string" + }, + "profileSourceId": "0oa4enoRyjwSCy5hx0g4" + }, + "created": "2022-04-04T15:56:05.000Z", + "domains": [ + "atko.com", + "user.com" + ], + "id": "rul2jy7jLUlnO3ng00g4", + "isDefault": false, + "lastUpdated": "2022-05-05T18:15:44.000Z", + "name": "Realm Assignment 1", + "priority": 0, + "status": "ACTIVE" + } + }, + "GetRoleAssignmentGovernanceGrantResources": { + "value": { + "_links": { + "next": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai2556vZgWesWf10g4/resources?after=orn:okta:directory:00ozmkUsqWxsUxhGO0g3:groups:00g118990hl1oCC5A0g5" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai2556vZgWesWf10g4/resources" + } + }, + "resources": [ + { + "label": "test-group-1", + "resource": "orn:okta:directory:00ozmkUsqWxsUxhGO0g3:groups:00g114290ar1oCC5A0g5" + }, + { + "label": "test-group-2", + "resource": "orn:okta:directory:00ozmkUsqWxsUxhGO0g3:groups:00g118990hl1oCC5B0g5" + } + ] + } + }, + "GetRoleAssignmentGovernanceGrantResponse": { + "value": { + "_links": { + "resources": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai2556vZgWesWf10g4/resources" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai2556vZgWesWf10g4" + } + }, + "bundleId": "enbhz2pAwtts9UBes0g4", + "expirationDate": "2024-12-09 14:17:22.0", + "grantId": "grai2556vZgWesWf10g4", + "type": "ENTITLEMENT-BUNDLE" + } + }, + "GetSessionResponse": { + "value": { + "created": "2022-04-04T15:56:05.000Z", + "id": "aps1qqonvr2SZv6o70h8", + "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", + "importType": "INCREMENTAL", + "lastUpdated": "2022-05-05T16:15:44.000Z", + "status": "CREATED" + } + }, + "GetThemeResponse": { + "value": { + "backgroundImage": null, + "emailTemplateTouchPointVariant": "OKTA_DEFAULT", + "endUserDashboardTouchPointVariant": "OKTA_DEFAULT", + "errorPageTouchPointVariant": "OKTA_DEFAULT", + "favicon": "https://{yourOktaDomain}/favicon.ico", + "id": "thdul904tTZ6kWVhP0g3", + "loadingPageTouchPointVariant": "OKTA_DEFAULT", + "logo": "https://{yourOktaDomain}/assets/img/logos/okta-logo.47066819ac7db5c13f4c431b2687cef6.png", + "primaryColorContrastHex": "#000000", + "primaryColorHex": "#1662dd", + "secondaryColorContrastHex": "#000000", + "secondaryColorHex": "#ebebed", + "signInPageTouchPointVariant": "OKTA_DEFAULT" + } + }, + "GetUseRoleGovernanceResponse": { + "value": { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5\"" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance" + } + }, + "grants": [ + { + "_links": { + "resources": { + "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai24zWTjnDazeOI0g4/resources" + } + }, + "grantId": "grai24zWTjnDazeOI0g4", + "type": "CUSTOM" + }, + { + "_links": { + "resources": { + "href": "https://{yourOktaDomain}//api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai2556vZgWesWf10g4/resources" + } + }, + "bundleId": "enbhz2pAwtts9UBes0g4", + "expirationDate": "2024-12-09 14:17:22.0", + "grantId": "grai2556vZgWesWf10g4", + "type": "ENTITLEMENT-BUNDLE" + } + ] + } + }, + "GetUserLinkedObjectResponse": { + "summary": "Retrieve user linked object value", + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7" + } + } + } + ] + }, + "GetUserResponse": { + "summary": "Retrieve a user type response", + "value": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + } + }, + "created": "2021-07-05T20:40:38.000Z", + "createdBy": "sprz9fj1ycBcsgopy1d6", + "default": false, + "description": "A new custom user type", + "displayName": "New user type", + "id": "otyfnly5cQjJT9PnR0g4", + "lastUpdated": "2021-07-05T20:40:38.000Z", + "lastUpdatedBy": "sprz9fj1ycBcsgopy1d6", + "name": "newUserType" + } + }, + "GetYubikeyOptTokenResponse": { + "summary": "Get YubiKey OTP token response", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00uu0x8sxTr9HcHOo0g3/factors/ykfxduQAhl89YyPrV0g3" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/factors/yubikey_token/tokens/ykkxdtCA1fKVxyu6R0g3" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00uu0x8sxTr9HcHOo0g3" + } + }, + "activated": "2020-06-09T23:47:29.000Z", + "created": "2020-06-09T23:42:05.000Z", + "id": "ykkxdtCA1fKVxyu6R0g3", + "lastUpdated": "2020-06-09T23:47:29.000Z", + "lastVerified": "2020-06-09T23:47:29.000Z", + "profile": { + "serial": "000009508427" + }, + "status": "ACTIVE" + } + }, + "GoogleIdPResponse": { + "summary": "Google IdP", + "value": { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62bfdiumsUndnZ0h7&\n client_id={clientId}&response_type={responseType}&response_mode={responseMode}&\n scope={scopes}&redirect_uri={redirectUri}&state={state}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2016-03-24T23:21:49.000Z", + "id": "0oa62bfdiumsUndnZ0h7", + "lastUpdated": "2016-03-24T23:21:49.000Z", + "name": "Google", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://accounts.google.com/o/oauth2/auth" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://www.googleapis.com/oauth2/v3/token" + } + }, + "scopes": [ + "profile", + "email", + "openid" + ], + "type": "OIDC" + }, + "status": "ACTIVE", + "type": "GOOGLE" + } + }, + "GovernanceBundle": { + "summary": "Governance bundle", + "value": { + "_links": { + "entitlements": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA/entitlements", + "self": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA" + }, + "description": "Group bundle for administrative access", + "id": "0bbfxqCAJWWGELFTYAAA", + "name": "Group admin bundle", + "orn": "orn:okta:governance:00o5rb5mt2H3d1TJd0h7:bundles:0bbfxqCAJWWGELFTYAAA", + "status": "ACTIVE" + } + }, + "GovernanceBundleCreateRequestCustomRole": { + "summary": "Create governance bundle with custom role", + "value": { + "description": "Custom bundle for administrative access", + "entitlements": { + "resourceSets": [ + "iamoJDFKaJxGIr0oamd9g" + ], + "role": "cr0WxyzJxGIr0ouum0g4" + }, + "name": "Custom admin bundle" + } + }, + "GovernanceBundleCreateRequestScopedStandardRole": { + "summary": "Create governance bundle with scoped standard role", + "value": { + "description": "Group bundle for administrative access", + "entitlements": { + "role": "GROUP_MEMBERSHIP_ADMIN", + "targets": [ + "00guaxWZ0AOa5NFAj0g3" + ] + }, + "name": "Group admin bundle" + } + }, + "GovernanceBundleCreateRequestStandardRole": { + "summary": "Create governance bundle with non-scoped standard role", + "value": { + "description": "Group bundle for administrative access", + "entitlements": { + "role": "GROUP_MEMBERSHIP_ADMIN" + }, + "name": "Group admin bundle" + } + }, + "GovernanceBundleUpdateRequestCustomRole": { + "summary": "Update governance bundle with custom role", + "value": { + "description": "Custom bundle for administrative access", + "entitlements": { + "resourceSets": [ + "iamoJDFKaJxGIr0oamd9g" + ], + "role": "cr0WxyzJxGIr0ouum0g4" + }, + "name": "Custom admin bundle" + } + }, + "GovernanceBundleUpdateRequestScopedStandardRole": { + "summary": "Update governance bundle with scoped standard role", + "value": { + "description": "Group bundle for administrative access", + "entitlements": { + "role": "GROUP_MEMBERSHIP_ADMIN", + "targets": [ + "00guaxWZ0AOa5NFAj0g3" + ] + }, + "name": "Group admin bundle" + } + }, + "GovernanceBundleUpdateRequestStandardRole": { + "summary": "Update governance bundle with non-scoped standard role", + "value": { + "description": "Group bundle for administrative access", + "entitlements": { + "role": "GROUP_MEMBERSHIP_ADMIN" + }, + "name": "Group admin bundle" + } + }, + "GovernanceBundlesResponse": { + "summary": "List of governance bundles", + "value": { + "_links": { + "next": { + "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles?after=bundleId12" + }, + "self": { + "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles?limit=2&after=10" + } + }, + "bundles": [ + { + "_links": { + "entitlements": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA/entitlements" + }, + "description": "Group bundle for administrative access", + "id": "0bbfxqCAJWWGELFTYAAA", + "name": "Group admin bundle", + "orn": "orn:okta:governance:00o5rb5mt2H3d1TJd0h7:bundles:0bbfxqCAJWWGELFTYAAA", + "status": "ACTIVE" + } + ] + } + }, + "GroupAssignmentExListResponse": { + "summary": "Application groups list with embedded metadata", + "value": [ + { + "_embedded": { + "metadata": { + "credentials": {}, + "profile": { + "department": { + "lastUpdated": null, + "source": { + "type": "MAPPING", + "value": [ + { + "id": null + } + ] + } + }, + "division": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "initialStatus": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "locale": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "manager": { + "lastUpdated": null, + "source": { + "type": "MAPPING", + "value": [ + { + "id": null + } + ] + } + }, + "managerId": { + "lastUpdated": null, + "source": { + "type": "MAPPING", + "value": [ + { + "id": null + } + ] + } + }, + "organization": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "preferredLanguage": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "securityAnswer": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "securityQuestion": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "timezone": { + "lastUpdated": null, + "source": { + "type": "USER", + "value": [ + { + "id": "00uzojLwDGgUynjJS0g3", + "self": { + "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" + } + } + ] + } + }, + "userType": { + "lastUpdated": null, + "source": { + "type": "MAPPING", + "value": [ + { + "id": null + } + ] + } + } + } + } + }, + "_links": { + "app": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" + }, + "group": { + "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" + } + }, + "id": "00g15acRUy0SYb9GT0g4", + "lastUpdated": "2024-06-02T13:17:57.000Z", + "priority": 0, + "profile": { + "department": "marketing", + "division": "top", + "initialStatus": "active_with_pass", + "locale": "en_US", + "manager": "Donald Glover", + "managerId": "ike.ogb@gmail.com", + "organization": "wazobia", + "preferredLanguage": "English", + "securityAnswer": "Ronaldinho", + "securityQuestion": "Who is the footballer to have played the game", + "timezone": "Canada/Eastern", + "userType": null + } + } + ] + }, + "GroupAssignmentExResponse": { + "summary": "Application group response", + "value": { + "_links": { + "app": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" + }, + "group": { + "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" + } + }, + "id": "00g15acRUy0SYb9GT0g4", + "lastUpdated": "2024-06-02T13:17:57.000Z", + "priority": 0, + "profile": { + "department": "marketing", + "division": "top", + "initialStatus": "active_with_pass", + "locale": "en_US", + "manager": "Donald Glover", + "managerId": "ike.ogb@gmail.com", + "organization": "wazobia", + "preferredLanguage": "English", + "securityAnswer": "Ronaldinho", + "securityQuestion": "Who is the footballer to have played the game", + "timezone": "Canada/Eastern", + "userType": null + } + } + }, + "GroupAssignmentPatchRequestExample": { + "summary": "Update app group request", + "value": [ + { + "op": "replace", + "path": "/profile/manager", + "value": "Carlo Ancelotti" + } + ] + }, + "GroupAssignmentPatchResponseExample": { + "summary": "Update application group response", + "value": { + "_links": { + "app": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" + }, + "group": { + "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" + } + }, + "id": "00g15acRUy0SYb9GT0g4", + "lastUpdated": "2024-06-03T13:42:20.000Z", + "priority": 0, + "profile": { + "department": "Accounting", + "division": "top", + "initialStatus": "active_with_pass", + "locale": "en_US", + "manager": "Carlo Ancelotti", + "managerId": "ike.ogb@gmail.com", + "organization": null, + "preferredLanguage": "English", + "securityAnswer": "Jay Jay Okocha", + "securityQuestion": "Who is the footballer to have played the game", + "timezone": "Canada/Eastern", + "userType": null + } + } + }, + "GroupAssignmentPutRequestExample": { + "summary": "Assign application group request", + "value": { + "id": "00g15acRUy0SYb9GT0g4", + "profile": { + "department": "Accounting", + "division": "top", + "initialStatus": "active_with_pass", + "locale": "en_US", + "manager": "Arsene Wenger", + "managerId": "ike.ogb@gmail.com", + "organization": null, + "preferredLanguage": "English", + "securityAnswer": "Jay Jay Okocha", + "securityQuestion": "Who is the footballer to have played the game", + "timezone": "Canada/Eastern", + "userType": null + } + } + }, + "GroupAssignmentPutResponseExample": { + "summary": "Assign application group response", + "value": { + "_links": { + "app": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" + }, + "group": { + "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" + } + }, + "id": "00g15acRUy0SYb9GT0g4", + "lastUpdated": "2024-06-03T13:52:07.000Z", + "priority": 0, + "profile": { + "department": "Accounting", + "division": "top", + "initialStatus": "active_with_pass", + "locale": "en_US", + "manager": "Arsene Wenger", + "managerId": "ike.ogb@gmail.com", + "organization": null, + "preferredLanguage": "English", + "securityAnswer": "Jay Jay Okocha", + "securityQuestion": "Who is the footballer to have played the game", + "timezone": "Canada/Eastern", + "userType": null + } + } + }, + "GroupMemberships": { + "value": { + "memberExternalIds": [ + "USEREXT123456784C2IFA", + "USEREXT123456784C3IFB", + "USEREXT123456784C4IFC" + ] + } + }, + "GroupSchemaAddRequest": { + "value": { + "definitions": { + "custom": { + "id": "#custom", + "properties": { + "groupContact": { + "description": "Group administrative contact", + "maxLength": 20, + "minLength": 1, + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": false, + "title": "Group administrative contact", + "type": "string" + } + }, + "required": [], + "type": "object" + } + } + } + }, + "GroupSchemaResponse": { + "value": { + "$schema": "http://json-schema.org/draft-04/schema#", + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/group/default", + "method": "GET", + "rel": "self" + } + }, + "created": "2021-01-30T00:18:24.000Z", + "definitions": { + "base": { + "id": "#base", + "properties": {}, + "required": [ + "name" + ], + "type": "object" + }, + "custom": { + "id": "#custom", + "properties": { + "groupContact": { + "description": "Group administrative contact", + "master": { + "type": "PROFILE_MASTER" + }, + "mutability": "READ_WRITE", + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "scope": "NONE", + "title": "Group administrative contact", + "type": "string" + } + }, + "required": [], + "type": "object" + } + }, + "description": "Okta group profile template", + "id": "https://{yourOktaDomain}/meta/schemas/group/default", + "lastUpdated": "2021-02-25T23:05:31.000Z", + "name": "group", + "properties": { + "profile": { + "allOf": [ + { + "$ref": "#/definitions/custom" + }, + { + "$ref": "#/definitions/base" + } + ] + } + }, + "title": "Okta group", + "type": "object" + } + }, + "GroupsPayload": { + "value": { + "externalId": "GROUPEXT123456784C2IF", + "profile": { + "description": "All users West of The Rockies", + "displayName": "West Coast users" + } + } + }, + "GroupsResponse": { + "value": { + "externalId": "GROUPEXT123456784C2IF", + "id": "00gsl4xM9ys8TdnbZ0g4", + "profile": { + "description": "All users West of The Rockies", + "displayName": "West Coast users" + } + } + }, + "IAMStandardRoleResponseClient": { + "value": { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/client/0oa5vymVNCe2cPEeZ0g4" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_REQUESTS_ADMIN/members/irb4jlomnnDBuBDyJ0g7" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_REQUESTS_ADMIN/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_REQUESTS_ADMIN" + } + }, + "assignmentType": "CLIENT", + "created": "2023-07-06T21:52:48.000Z", + "id": "irb4jlodtdN4yJ88b0g7", + "label": "Access Requests Administrator", + "lastUpdated": "2023-07-06T21:52:48.000Z", + "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", + "role": "ACCESS_REQUESTS_ADMIN", + "status": "ACTIVE", + "type": "ACCESS_REQUESTS_ADMIN" + } + }, + "IAMStandardRoleResponseUser": { + "value": { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_REQUESTS_ADMIN/members/irb1q92TFAHzySt3x0g4" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_REQUESTS_ADMIN/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_REQUESTS_ADMIN" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb1q92TFAHzySt3x0g4", + "label": "Access Requests administrator", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", + "role": "ACCESS_REQUESTS_ADMIN", + "status": "ACTIVE", + "type": "ACCESS_REQUESTS_ADMIN" + } + }, + "IAMStandardRolesListResponse": { + "value": [ + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00ur32Vg0fvpyHZeQ0g3" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:17:40.000Z", + "id": "IFIFAX2BIRGUSTQ", + "label": "Application administrator", + "lastUpdated": "2019-02-06T16:17:40.000Z", + "status": "ACTIVE", + "type": "APP_ADMIN" + }, + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1gytb3XCr9Dkr18r2" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3/members/irb1qe6PGuMc7Oh8N0g4" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/cr0Yq6IJxGIr0ouum0g3/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb1q92TFAHzySt3x0g4", + "label": "UserCreatorRole", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "iamoJDFKaJxGIr0oamd9g", + "role": "cr0Yq6IJxGIr0ouum0g3", + "status": "ACTIVE", + "type": "CUSTOM" + }, + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1gytb3XCr9Dkr18r2" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_CERTIFICATIONS_ADMIN/members/irb1qe6PGuMc7Oh8N0g4" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/OKTA_IAM_TEST_DELIVERED_ROLE/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_CERTIFICATIONS_ADMIN" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb5e92YgBazyyQ3x1q5", + "label": "Access Certifications administrator", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", + "role": "ACCESS_CERTIFICATIONS_ADMIN", + "status": "ACTIVE", + "type": "ACCESS_CERTIFICATIONS_ADMIN" + } + ] + }, + "IAMStandardRolesListResponseClient": { + "value": [ + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/clients/0oa4ee9vgbIuqTUvd0g7" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_CERTIFICATIONS_ADMIN/members/irb1qe6PGuMc7Oh8N0g4" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/OKTA_IAM_TEST_DELIVERED_ROLE/permissionsZ" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_CERTIFICATIONS_ADMIN" + } + }, + "assignmentType": "CLIENT", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb5e92YgBazyyQ3x1q5", + "label": "Access Certifications Administrator", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", + "role": "ACCESS_CERTIFICATIONS_ADMIN", + "status": "ACTIVE", + "type": "ACCESS_CERTIFICATIONS_ADMIN" + } + ] + }, + "IAMStandardRolesListResponseGroup": { + "value": [ + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_CERTIFICATIONS_ADMIN/members/irb1qe6PGuMc7Oh8N0g4" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/OKTA_IAM_TEST_DELIVERED_ROLE/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_CERTIFICATIONS_ADMIN" + } + }, + "assignmentType": "GROUP", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb5e92YgBazyyQ3x1q5", + "label": "Access Certifications Administrator", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", + "role": "ACCESS_CERTIFICATIONS_ADMIN", + "status": "ACTIVE", + "type": "ACCESS_CERTIFICATIONS_ADMIN" + } + ] + }, + "IdPAppUserResponse": { + "summary": "IdP user", + "value": { + "_links": { + "idp": { + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bfdiumsUndnZ0h7" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bfdiumsUndnZ0h7/users/00u5t60iloOHN9pBi0h7" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7" + } + }, + "created": "2017-12-19T17:30:16.000Z", + "externalId": "externalId", + "id": "00u5t60iloOHN9pBi0h7", + "lastUpdated": "2017-12-19T17:30:16.000Z", + "profile": { + "displayName": null, + "email": null, + "firstName": null, + "honorificPrefix": null, + "honorificSuffix": null, + "lastName": null, + "middleName": null, + "profileUrl": null + } + } + }, + "IdPKeyCredentialRequest": { + "summary": "IdP key credential", + "value": { + "e": "65537", + "n": "101438407598598116085679865987760095721749307901605456708912786847324207000576780508113360584555007890315805735307890113536927352312915634368993759211767770602174860126854831344273970871509573365292777620005537635317282520456901584213746937262823585533063042033441296629204165064680610660631365266976782082747", + "x5c": [ + "MIIDnjCCAoagAwIBAgIGAVG3MN+PMA0GCSqGSIb3DQEBBQUAMIGPMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEDAOBgNVBAMMB2V4YW1wbGUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMTUxMjE4MjIyMjMyWhcNMjUxMjE4MjIyMzMyWjCBjzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRAwDgYDVQQDDAdleGFtcGxlMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtcnyvuVCrsFEKCwHDenS3Ocjed8eWDv3zLtD2K/iZfE8BMj2wpTfn6Ry8zCYey3mWlKdxIybnV9amrujGRnE0ab6Q16v9D6RlFQLOG6dwqoRKuZy33Uyg8PGdEudZjGbWuKCqqXEp+UKALJHV+k4wWeVH8g5d1n3KyR2TVajVJpCrPhLFmq1Il4G/IUnPe4MvjXqB6CpKkog1+ThWsItPRJPAM+RweFHXq7KfChXsYE7Mmfuly8sDQlvBmQyxZnFHVuiPfCvGHJjpvHy11YlHdOjfgqHRvZbmo30+y0X/oY/yV4YEJ00LL6eJWU4wi7ViY3HP6/VCdRjHoRdr5L/DwIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCzzhOFkvyYLNFj2WDcq1YqD4sBy1iCia9QpRH3rjQvMKDwQDYWbi6EdOX0TQ/IYR7UWGj+2pXd6v0t33lYtoKocp/4lUvT3tfBnWZ5KnObi+J2uY2teUqoYkASN7F+GRPVOuMVoVgm05ss8tuMb2dLc9vsx93sDt+XlMTv/2qi5VPwaDtqduKkzwW9lUfn4xIMkTiVvCpe0X2HneD2Bpuao3/U8Rk0uiPfq6TooWaoW3kjsmErhEAs9bA7xuqo1KKY9CdHcFhkSsMhoeaZylZHtzbnoipUlQKSLMdJQiiYZQ0bYL83/Ta9fulr1EERICMFt3GUmtYaZZKHpWSfdJp9" + ], + "x5t#S256": "wzPVobIrveR1x-PCbjsFGNV-6zn7Rm9KuOWOG4Rk6jE" + } + }, + "IdPKeyCredentialResponse": { + "summary": "IdP key credential", + "value": { + "created": "2016-01-03T18:15:47.000Z", + "e": "65537", + "kid": "your-key-id", + "kty": "RSA", + "lastUpdated": "2016-01-03T18:15:47.000Z", + "n": "101438407598598116085679865987760095721749307901605456708912786847324207000576780508113360584555007890315805735307890113536927352312915634368993759211767770602174860126854831344273970871509573365292777620005537635317282520456901584213746937262823585533063042033441296629204165064680610660631365266976782082747", + "use": "sig", + "x5c": [ + "MIIDnjCCAoagAwIBAgIGAVG3MN+PMA0GCSqGSIb3DQEBBQUAMIGPMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEDAOBgNVBAMMB2V4YW1wbGUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMTUxMjE4MjIyMjMyWhcNMjUxMjE4MjIyMzMyWjCBjzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRAwDgYDVQQDDAdleGFtcGxlMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtcnyvuVCrsFEKCwHDenS3Ocjed8eWDv3zLtD2K/iZfE8BMj2wpTfn6Ry8zCYey3mWlKdxIybnV9amrujGRnE0ab6Q16v9D6RlFQLOG6dwqoRKuZy33Uyg8PGdEudZjGbWuKCqqXEp+UKALJHV+k4wWeVH8g5d1n3KyR2TVajVJpCrPhLFmq1Il4G/IUnPe4MvjXqB6CpKkog1+ThWsItPRJPAM+RweFHXq7KfChXsYE7Mmfuly8sDQlvBmQyxZnFHVuiPfCvGHJjpvHy11YlHdOjfgqHRvZbmo30+y0X/oY/yV4YEJ00LL6eJWU4wi7ViY3HP6/VCdRjHoRdr5L/DwIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCzzhOFkvyYLNFj2WDcq1YqD4sBy1iCia9QpRH3rjQvMKDwQDYWbi6EdOX0TQ/IYR7UWGj+2pXd6v0t33lYtoKocp/4lUvT3tfBnWZ5KnObi+J2uY2teUqoYkASN7F+GRPVOuMVoVgm05ss8tuMb2dLc9vsx93sDt+XlMTv/2qi5VPwaDtqduKkzwW9lUfn4xIMkTiVvCpe0X2HneD2Bpuao3/U8Rk0uiPfq6TooWaoW3kjsmErhEAs9bA7xuqo1KKY9CdHcFhkSsMhoeaZylZHtzbnoipUlQKSLMdJQiiYZQ0bYL83/Ta9fulr1EERICMFt3GUmtYaZZKHpWSfdJp9" + ], + "x5t#S256": "wzPVobIrveR1x-PCbjsFGNV-6zn7Rm9KuOWOG4Rk6jE" + } + }, + "IdPSigningKeyCredentialResponse": { + "summary": "IdP signing key credential", + "value": { + "created": "2015-12-10T18:56:23.000Z", + "expiresAt": "2017-12-10T18:56:22.000Z", + "kid": "akm5hvbbevE341ovl0h7", + "kty": "RSA", + "use": "sig", + "x5c": [ + "MIIDnjCCAoagAwIBAgIGAVG3MN+PMA0GCSqGSIb3DQEBBQUAMIGPMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEDAOBgNVBAMMB2V4YW1wbGUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMTUxMjE4MjIyMjMyWhcNMjUxMjE4MjIyMzMyWjCBjzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRAwDgYDVQQDDAdleGFtcGxlMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtcnyvuVCrsFEKCwHDenS3Ocjed8eWDv3zLtD2K/iZfE8BMj2wpTfn6Ry8zCYey3mWlKdxIybnV9amrujGRnE0ab6Q16v9D6RlFQLOG6dwqoRKuZy33Uyg8PGdEudZjGbWuKCqqXEp+UKALJHV+k4wWeVH8g5d1n3KyR2TVajVJpCrPhLFmq1Il4G/IUnPe4MvjXqB6CpKkog1+ThWsItPRJPAM+RweFHXq7KfChXsYE7Mmfuly8sDQlvBmQyxZnFHVuiPfCvGHJjpvHy11YlHdOjfgqHRvZbmo30+y0X/oY/yV4YEJ00LL6eJWU4wi7ViY3HP6/VCdRjHoRdr5L/DwIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCzzhOFkvyYLNFj2WDcq1YqD4sBy1iCia9QpRH3rjQvMKDwQDYWbi6EdOX0TQ/IYR7UWGj+2pXd6v0t33lYtoKocp/4lUvT3tfBnWZ5KnObi+J2uY2teUqoYkASN7F+GRPVOuMVoVgm05ss8tuMb2dLc9vsx93sDt+XlMTv/2qi5VPwaDtqduKkzwW9lUfn4xIMkTiVvCpe0X2HneD2Bpuao3/U8Rk0uiPfq6TooWaoW3kjsmErhEAs9bA7xuqo1KKY9CdHcFhkSsMhoeaZylZHtzbnoipUlQKSLMdJQiiYZQ0bYL83/Ta9fulr1EERICMFt3GUmtYaZZKHpWSfdJp9" + ], + "x5t#S256": "wzPVobIrveR1x-PCbjsFGNV-6zn7Rm9KuOWOG4Rk6jE" + } + }, + "IdvExample": { + "summary": "Identity Verification (IDV) configuration example", + "value": { + "authorizeUrl": "https://auth.example.com/oauth/authorize", + "configUrl": "https://example.com/config/url", + "issuerUrl": "https://auth.example.com/", + "jwksUrl": "https://auth.example.com/.well-known/jwks.json", + "parUrl": "https://auth.example.com/oauth/par", + "privacyPolicyUrl": "https://example.com/legal/privacy", + "termsOfUseUrl": "https://example.com/legal/eula", + "tokenUrl": "https://auth.example.com/oauth/token" + } + }, + "IncodeIDVResponse": { + "summary": "Incode as IdP", + "value": { + "_links": { + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oaf35tu47hnH9mlZ0w6/users" + } + }, + "created": "2025-01-15T20:54:04.000Z", + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oaf35tu47hnH9mlZ0w6/lifecycle/deactivate" + }, + "id": "0oaf35tu47hnH9mlZ0w6", + "lastUpdated": "2025-01-15T20:54:05.000Z", + "name": "Incode IdP", + "policy": { + "maxClockSkew": 0, + "provisioning": { + "action": "DISABLED", + "groups": null, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "source.userName" + } + } + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://auth.incode.com/oauth2/authorize" + }, + "par": { + "binding": "HTTP-POST", + "url": "https://auth.incode.com/oauth2/par" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://auth.incode.com/oauth2/token" + } + }, + "scopes": [ + "openid", + "profile", + "identity_assurance" + ], + "type": "ID_PROOFING" + }, + "status": "ACTIVE", + "type": "IDV_INCODE" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "InlineHookMgmtCreateHTTPRequest": { + "summary": "Create an inline hook with HTTP authentication", + "value": { + "channel": { + "config": { + "authScheme": { + "key": "Authorization", + "type": "HEADER", + "value": "my-shared-secret" + }, + "headers": [ + { + "key": "x-any-key", + "value": "my-header-value" + } + ], + "method": "POST", + "uri": "https://example.com/tokenHook" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "name": "Token hook with HTTP authentication", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + } + }, + "InlineHookMgmtCreateHTTPResponse": { + "summary": "Inline hook with HTTP authentication response", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "authorization", + "type": "header" + }, + "headers": [], + "method": "POST", + "uri": "https://example.com/tokenHook" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2024-08-22T21:01:09.000Z", + "id": "calb7gacafgwgE7hc5e4", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "Token hook with HTTP authentication", + "status": "ACTIVE", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + } + }, + "InlineHookMgmtCreateOAuthClientSecretRequest": { + "summary": "Create an inline hook with OAuth 2.0 Client Secret", + "value": { + "channel": { + "config": { + "authType": "client_secret_post", + "clientId": "0oaj43vkrq7wKxZSI5e6", + "clientSecret": "b-iATvTu7sIocvhWx95S9kF.....vfZhM6q6khSaojLBejF21cUn5bPm9abi", + "headers": [], + "method": "POST", + "tokenUrl": "https://example.okta.com/oauth2/default/v1/token", + "uri": "https://example.com/tokenHook" + }, + "type": "OAUTH", + "version": "1.0.0" + }, + "name": "Registration hook with OAuth 2.0 Client Secret Post", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + } + }, + "InlineHookMgmtCreateOAuthClientSecretResponse": { + "summary": "Inline hook with OAuth 2.0 Client Secret response", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/lifecycle/activate" + }, + "execute": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/execute" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5" + } + }, + "channel": { + "config": { + "authScheme": null, + "authType": "client_secret_post", + "clientId": "0oaj43vkrq7wKxZSI5e6", + "headers": [], + "method": "POST", + "scope": null, + "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", + "uri": "https://example.com/registrationHook" + }, + "type": "OAUTH", + "version": "1.0.0" + }, + "created": "2024-08-22T21:01:09.000Z", + "id": "calj4fythrqj5Bxol5e5", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "Registration hook with OAuth 2.0 Client Secret Post", + "status": "ACTIVE", + "type": "com.okta.user.pre-registration", + "version": "1.0.0" + } + }, + "InlineHookMgmtCreateOAuthPrivateKeyRequest": { + "summary": "Create an inline hook with OAuth 2.0 Private Key", + "value": { + "channel": { + "config": { + "authType": "private_key_jwt", + "clientId": "0oaj43vkrq7wKxZSI5e6", + "headers": [ + { + "key": "x-any-key", + "value": "my-header-value" + } + ], + "hookKeyId": "HKYj4ft1a3fjmwZg05e6", + "method": "POST", + "tokenUrl": "https://example.okta.com/oauth2/default/v1/token", + "uri": "https://example.com/tokenHook" + }, + "type": "OAUTH", + "version": "1.0.0" + }, + "name": "Token hook with OAuth 2.0 Private Key authentication", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + } + }, + "InlineHookMgmtCreateOAuthPrivateKeyResponse": { + "summary": "Inline hook with OAuth 2.0 Private Key response", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/lifecycle/activate" + }, + "execute": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/execute" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6" + } + }, + "channel": { + "config": { + "authScheme": null, + "authType": "private_key_jwt", + "clientId": "0oaj43vkrq7wKxZSI5d7", + "headers": [], + "hookKeyId": "HKYj4ft1a3fjmwZg05d6", + "method": "POST", + "scope": null, + "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", + "uri": "https://example.com/tokenHook" + }, + "created": "2024-08-22T21:01:09.000Z", + "type": "OAUTH", + "version": "1.0.0" + }, + "id": "calj4fythrqj5Bxol4ai6", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "Token Hook with OAuth 2.0 Private Key JWT", + "status": "ACTIVE", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + } + }, + "InlineHookMgmtHTTPexample": { + "summary": "An inline hook with HTTP authentication", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "authorization", + "type": "header" + }, + "headers": [], + "method": "POST", + "uri": "https://example.com/tokenHook" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2024-08-22T21:01:09.000Z", + "id": "calb7gacafgwgE7hc5e4", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "Token hook with HTTP authentication", + "status": "ACTIVE", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + } + }, + "InlineHookMgmtHTTPexampleDeactivate": { + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "authorization", + "type": "header" + }, + "headers": [], + "method": "POST", + "uri": "https://example.com/tokenHook" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2024-08-22T21:01:09.000Z", + "id": "calb7gacafgwgE7hc5e4", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "Token hook with HTTP authentication", + "status": "INACTIVE", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + } + }, + "InlineHookMgmtOAuthCSPexample": { + "summary": "An inline hook example with OAuth 2.0 Client Secret Post", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/lifecycle/activate" + }, + "execute": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/execute" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5" + } + }, + "channel": { + "config": { + "authScheme": null, + "authType": "client_secret_post", + "clientId": "0oaj43vkrq7wKxZSI5e6", + "headers": [], + "method": "POST", + "scope": null, + "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", + "uri": "https://example.com/registrationHook" + }, + "type": "OAUTH", + "version": "1.0.0" + }, + "created": "2024-08-22T21:01:09.000Z", + "id": "calj4fythrqj5Bxol5e5", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "Registration hook with OAuth 2.0 Client Secret Post", + "status": "ACTIVE", + "type": "com.okta.user.pre-registration", + "version": "1.0.0" + } + }, + "InlineHookMgmtOauthPKJexample": { + "summary": "An inline hook example with OAuth 2.0 Private Key JWT", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/lifecycle/activate" + }, + "execute": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/execute" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6" + } + }, + "channel": { + "config": { + "authScheme": null, + "authType": "private_key_jwt", + "clientId": "0oaj43vkrq7wKxZSI5d7", + "headers": [], + "hookKeyId": "HKYj4ft1a3fjmwZg05d6", + "method": "POST", + "scope": null, + "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", + "uri": "https://example.com/tokenHook" + }, + "created": "2024-08-22T21:01:09.000Z", + "type": "OAUTH", + "version": "1.0.0" + }, + "id": "calj4fythrqj5Bxol4ai6", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "Token Hook with OAuth 2.0 Private Key JWT", + "status": "ACTIVE", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + } + }, + "InlineHookMgmtPutHTTPRequest": { + "summary": "Update an inline hook name", + "value": { + "channel": { + "config": { + "authScheme": { + "key": "Authorization", + "type": "HEADER", + "value": "my-shared-secret" + }, + "headers": [ + { + "key": "x-any-key", + "value": "my-header-value" + } + ], + "method": "POST", + "uri": "https://example.com/tokenHook" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "name": "New name token hook with HTTP authentication", + "version": "1.0.0" + } + }, + "InlineHookMgmtPutResponse": { + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "authorization", + "type": "header" + }, + "headers": [], + "method": "POST", + "uri": "https://example.com/tokenHook" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2024-08-22T21:01:09.000Z", + "description": "Inline hook response with a new name", + "id": "calb7gacafgwgE7hc5e4", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "New name token hook with HTTP authentication", + "status": "ACTIVE", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + } + }, + "InlineHookTelephony": { + "value": { + "_links": { + "deactivate": { + "hints": { + "allow\"": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/inlineHooks/caldpyulr3nbET2du1d7/lifecycle/deactivate" + }, + "execute": { + "hints": { + "allow\"": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/inlineHooks/caldpyulr3nbET2du1d7/execute" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/inlineHooks/caldpyulr3nbET2du1d7" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "x-telephony-key", + "type": "HEADER" + }, + "headers": [], + "method": "POST", + "uri": "https://your-external-webservice/sendOtp" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2024-03-28T17:30:25.000Z", + "id": "caldpyulr3nbET2du1d7", + "lastUpdated": "2024-05-07T16:35:18.000Z", + "name": "testTelephonyHook", + "status": "ACTIVE", + "type": "com.okta.telephony.provider", + "version": null + } + }, + "InlineHooktMgmtListAllexample": { + "summary": "List all inline hooks response", + "value": [ + { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "authorization", + "type": "header" + }, + "headers": [], + "method": "POST", + "uri": "https://example.com/tokenHook" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2024-08-22T21:01:09.000Z", + "id": "calb7gacafgwgE7hc5e4", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "Token hook with HTTP authentication", + "status": "ACTIVE", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/lifecycle/activate" + }, + "execute": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/execute" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5" + } + }, + "channel": { + "config": { + "authScheme": null, + "authType": "client_secret_post", + "clientId": "0oaj43vkrq7wKxZSI5e6", + "headers": [], + "method": "POST", + "scope": null, + "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", + "uri": "https://example.com/registrationHook" + }, + "type": "OAUTH", + "version": "1.0.0" + }, + "created": "2024-08-22T21:01:09.000Z", + "id": "calj4fythrqj5Bxol5e5", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "Registration hook with OAuth 2.0 Client Secret Post", + "status": "ACTIVE", + "type": "com.okta.user.pre-registration", + "version": "1.0.0" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/lifecycle/activate" + }, + "execute": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/execute" + }, + "self": { + "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6" + } + }, + "channel": { + "config": { + "authScheme": null, + "authType": "private_key_jwt", + "clientId": "0oaj43vkrq7wKxZSI5d7", + "headers": [], + "hookKeyId": "HKYj4ft1a3fjmwZg05d6", + "method": "POST", + "scope": null, + "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", + "uri": "https://example.com/tokenHook" + }, + "created": "2024-08-22T21:01:09.000Z", + "type": "OAUTH", + "version": "1.0.0" + }, + "id": "calj4fythrqj5Bxol4ai6", + "lastUpdated": "2024-09-05T16:06:09.000Z", + "name": "Token Hook with OAuth 2.0 Private Key JWT", + "status": "ACTIVE", + "type": "com.okta.oauth2.tokens.transform", + "version": "1.0.0" + } + ] + }, + "InterclientTrustMappingResponse": { + "summary": "Create an interclient target and allowed app mapping response", + "value": [ + { + "appInstanceId": "0oa8ghelqWXs70qD80g5", + "created": "2025-11-25T22:44:06.000Z", + "id": "itmahqusSr3v8Kk3B0g5", + "lastUpdated": "2025-11-25T22:44:06.000Z", + "lastUpdatedBy": "00u102rhXmxEGFKiB0g5", + "orgId": "00o102n9p4vX126Gp0g5", + "trustedAppInstanceId": "0oa5kw6q51dFckBE70g5" + } + ] + }, + "InvalidRotateUse": { + "summary": "Invalid use", + "value": { + "errorCauses": [ + { + "errorSummary": "Invalid value specified for key 'use' parameter" + } + ], + "errorCode": "E0000001", + "errorId": "oaeprak9qKHRlaWiclJ4oPJRQ", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: rotateKeys" + } + }, + "InvalidWellKnownAppleAppSiteRepresentationError": { + "summary": "apple-app-site-association representation contains authsrv", + "value": { + "errorCauses": [ + { + "errorSummary": "Content must not include any `authsrv` customization." + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: representation" + } + }, + "InvalidWellKnownArrayTypeError": { + "summary": "Invalid content type for assetlinks.json", + "value": { + "errorCauses": [ + { + "errorSummary": "Content must be a JSON array of objects." + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: representation" + } + }, + "InvalidWellKnownJsonTypeError": { + "summary": "Invalid content type for apple-app-site-association and webauthn", + "value": { + "errorCauses": [ + { + "errorSummary": "Content must be a JSON object." + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: representation" + } + }, + "InvalidWellKnownWebauthnRepresentationError": { + "summary": "webauthn representation doesn't contain origins", + "value": { + "errorCauses": [ + { + "errorSummary": "Content must only contain `origins`." + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: representation" + } + }, + "InvalidWellKnownWebauthnRepresentationOriginStringError": { + "summary": "webauthn representation - `origins` must be array of strings", + "value": { + "errorCauses": [ + { + "errorSummary": "The `origins` must be an array of strings." + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: representation" + } + }, + "KeyCredentialExample": { + "summary": "Key credential example", + "value": { + "created": "2015-12-10T18:56:23.000Z", + "e": "AQAB", + "expiresAt": "2017-12-10T18:56:22.000Z", + "kid": "SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-FIbm4", + "kty": "RSA", + "lastUpdated": "2024-08-13T18:26:57.000Z", + "n": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", + "use": "sig", + "x5c": [ + "MIIDqDCCApCgAwIBAgIGAVGNQFX5MA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTAeFw0xNTEyMTAxODU1MjJaFw0xNzEyMTAxODU2MjJaMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJJjrcnI6cXBiXNq9YDgfYrQe2O5qEHG4MXP8Ue0sMeefFkFEHYHnHUeZCq6WTAGqR+1LFgOl+Eq9We5V+qNlGIfkFkQ3iHGBrIALKqLCd0Et76HicDiegz7j9DtN+lo0hG/gfcw5783L5g5xeQ7zVmCQMkFwoUA0uA3bsfUSrmfORHJL+EMNQT8XIXD8NkG4g6u7ylHVRTLgXbe+W/p04m3EP6l41xl+MhIpBaPxDsyUvcKCNwkZN3aZIin1O9Y4YJuDHxrM64/VtLLp0sC05iawAmfsLunF7rdJAkWUpPn+xkviyNQ3UpvwAYuDr+jKLUdh2reRnm1PezxMIXzBVMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEARnFIjyitrCGbleFr3KeAwdOyeHiRmgeKupX5ZopgXtcseJoToUIinX5DVw2fVZPahqs0Q7/a0wcVnTRpw6946qZCwKd/PvZ1feVuVEA5Ui3+XvHuSH5xLp7NvYG1snNEvlbN3+NDUMlWj2NEbihowUBt9+UxTpQO3+N08q3aZk3hOZ+tHt+1Te7KEEL/4CM28GZ9MY7fSrS7MAgp1+ZXtn+kRlMrXnQ49qBda37brwDRqmSY9PwNMbev3r+9ZHwxr9W5wXW4Ev4C4xngA7RkVoyDbItSUho0I0M0u/LHuppclnXrw97xyO5Z883eIBvPVjfRcxsJxXJ8jx70ATDskw==" + ], + "x5t#S256\"": "5GOpy9CQVtfvBmu2T8BHvpKE4OGtC3BuS046t7p9pps" + } + }, + "LinkIdPAppUserResponse": { + "summary": "Linked IdP user", + "value": { + "_links": { + "idp": { + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62b57p7c8PaGpU0h7" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62b57p7c8PaGpU0h7/users/00ub0oNGTSWTBKOLGLNR" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + } + }, + "created": "2017-03-30T02:19:51.000Z", + "externalId": "121749775026145", + "id": "00ub0oNGTSWTBKOLGLNR", + "lastUpdated": "2017-03-30T02:19:51.000Z" + } + }, + "ListAllAgentPoolUpdatesResponse": { + "summary": "List all agent pool updates", + "value": [ + { + "_links": { + "self": { + "href": "/api/v1/agentPools/poolId1/updates" + } + }, + "agentType": "AD", + "agents": { + "id": "a533eu8npxdZ60Mvf5s6", + "isHidden": false, + "isLatestGAedVersion": true, + "lastConnection": 1750462090000, + "latestGAedVersion": true, + "name": "N079-H069", + "operationalStatus": "OPERATIONAL", + "poolId": "0oa3eu7ekG8tjbD9J5s6", + "type": "AD", + "updateMessage": "Queued for update.", + "updateStatus": "Scheduled", + "version": "3.20.0" + }, + "enabled": true, + "id": "poolId1", + "name": "testSchedule", + "notifyAdmin": true, + "schedule": { + "cron": "0 1 * * THU", + "duration": 420, + "timezone": "America/Los_Angeles" + }, + "status": "Scheduled", + "targetVersion": "3.20.0" + } + ] + }, + "ListAllAgentPoolsResponse": { + "summary": "List all agent pools", + "value": [ + { + "_links": { + "self": { + "href": "/api/v1/agentPools/poolId1" + } + }, + "agents": { + "active": true, + "errorState": true, + "id": "agentId1", + "indicator": "green", + "isHidden": false, + "isLatestGAedVersion": false, + "lastConnection": 1628263766000, + "message": "Agent connection is live", + "name": "WIN-region1A-dc", + "operationalStatus": "OPERATIONAL", + "poolId": "poolId1", + "state": "ACTIVE", + "supportAutoUpdate": true, + "updateMessage": "Queued for update.", + "upgradeRequired": false, + "version": "3.18.0" + }, + "disruptedAgents": 0, + "id": "poolId1", + "inactiveAgents": 1, + "name": "region1A.dc", + "operationalStatus": "OPERATIONAL", + "type": "AD" + } + ] + }, + "ListAllKeyCredentialsExample": { + "summary": "List all key credentials example", + "value": [ + { + "created": "2015-12-10T18:56:23.000Z", + "e": "AQAB", + "expiresAt": "2017-12-10T18:56:22.000Z", + "kid": "SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-FIbm4", + "kty": "RSA", + "lastUpdated": "2024-08-13T18:26:57.000Z", + "n": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", + "use": "sig", + "x5c": [ + "MIIDqDCCApCgAwIBAgIGAVGNQFX5MA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTAeFw0xNTEyMTAxODU1MjJaFw0xNzEyMTAxODU2MjJaMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJJjrcnI6cXBiXNq9YDgfYrQe2O5qEHG4MXP8Ue0sMeefFkFEHYHnHUeZCq6WTAGqR+1LFgOl+Eq9We5V+qNlGIfkFkQ3iHGBrIALKqLCd0Et76HicDiegz7j9DtN+lo0hG/gfcw5783L5g5xeQ7zVmCQMkFwoUA0uA3bsfUSrmfORHJL+EMNQT8XIXD8NkG4g6u7ylHVRTLgXbe+W/p04m3EP6l41xl+MhIpBaPxDsyUvcKCNwkZN3aZIin1O9Y4YJuDHxrM64/VtLLp0sC05iawAmfsLunF7rdJAkWUpPn+xkviyNQ3UpvwAYuDr+jKLUdh2reRnm1PezxMIXzBVMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEARnFIjyitrCGbleFr3KeAwdOyeHiRmgeKupX5ZopgXtcseJoToUIinX5DVw2fVZPahqs0Q7/a0wcVnTRpw6946qZCwKd/PvZ1feVuVEA5Ui3+XvHuSH5xLp7NvYG1snNEvlbN3+NDUMlWj2NEbihowUBt9+UxTpQO3+N08q3aZk3hOZ+tHt+1Te7KEEL/4CM28GZ9MY7fSrS7MAgp1+ZXtn+kRlMrXnQ49qBda37brwDRqmSY9PwNMbev3r+9ZHwxr9W5wXW4Ev4C4xngA7RkVoyDbItSUho0I0M0u/LHuppclnXrw97xyO5Z883eIBvPVjfRcxsJxXJ8jx70ATDskw==" + ], + "x5t#S256\"": "5GOpy9CQVtfvBmu2T8BHvpKE4OGtC3BuS046t7p9pps" + }, + { + "created": "2015-12-10T18:55:35.000Z", + "e": "AQAB", + "expiresAt": "2045-01-23T02:15:23.000Z", + "kid": "mXtzOtml09Dg1ZCeKxTRBo3KrQuBWFkJ5oxhVagjTzo", + "kty": "RSA", + "lastUpdated": "2024-08-13T18:26:57.000Z", + "n": "htbi5H5MN_oYaKcZ8vlWRZn2oTrPY0v8_2Br_VZPJgJ57dCgguq5dDk1Me_ax-B3kjBPdXcW8wEoUFaU30spyVeQjZrdqsSvF0nMW4OzrMOIqrGLwCrAoDBS8tutfk5Y7qc-5xABzxgu4BjgSK5nWXbCt_UR0DzVTknotmMGeT8tAej8F6GAphLa0YhIxWT7Jy-y_pdANsiUPRiZBoLueGI0rrCqgYHIQVjNoj4-si105KCXbQuyYM9_Cd-dyyu5KJ4Ic0cOW61gpx4pnecMgSy8OX57FEd06W2hExBd49ah6jra2KFMeOGe3rkIXirdkofl1mBgeQ77ruKO1wW9Qw", + "use": "sig", + "x5c": [ + "MIIDqDCCApCgAwIBAgIGAUsUkouzMA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTAeFw0xNTAxMjMwMjE0MjNaFw00NTAxMjMwMjE1MjNaMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKhmkmKsu3FYeBiJg44aN6Ah3g9gof1cytXJVMnblDUWpLfe/FMUQCssh8Y8NCYRri5jni4efBgk6B3SkC7ymqsOXILIEHSwUYWnAaqDOTxO101mHzryowu1+0PldRNoyTthahpprvAPYlTin9zrDTqFT+WY/zwoaN8H+CfixlW1nM85qF18zYYekkW50MSoHPcfJKe2ywIhPXTYTSBEPcHh8dQEjBrZn7A4qOoDnfOXll8OL7j2O6EVyTtHA0tLJHVLpwI4gSPsXFwEnHltjN57odwYe9yds0BbM/YG9i+am1+3cmZ6Uyd16mLGclrr05o9BHcEZ4ZctV2hr6whbRsCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEAnNlF27gRmhGTQ+GRAvbvYToFRgsIbBAPvRqB2LmEIiQ6UJd602w6uP1sv/zEzBYg4SnMLuVyWgOJ6d71dCvXdIO9mgAq6BaEPjlo0WhGyt+zGrpkMnIX5EwRa64kHydcPRHNA607wVYA96sJdyNJEMzBvjY9fJnfevzzDCN3NWpMS2T6rk6HP5IziI1VuFWY2OUC1kbCqLj1dUgp8koe3ftLL55ZpkAocnVMnrzBveNjgAOAiKTMcyS0bhESph9aVWvuHVZSfTnUjnTPb/4jA2YlB3ED+qaU3aqHwft1KXwZskNXBKXy7lyC+CMoeB3/ncFhSg/UllBooPPS3wYlNA==" + ], + "x5t#S256\"": "7CCyXWwKzH4P6PoBP91B1S_iIZVzuGffVnUXu-BTYQQ" + } + ] + }, + "ListAllKeysResponse": { + "summary": "List all keys response example", + "value": [ + { + "created": "2022-08-22T16:34:33.000Z", + "id": "HKY1i2htmXF5UNQhL0g4", + "isUsed": "true", + "keyId": "bb5bed7d-6e4d-488f-9c86-59b93a2bb3fb", + "lastUpdated": "2022-08-22T16:34:33.000Z", + "name": "My new key" + }, + { + "created": "2022-08-31T18:09:58.000Z", + "id": "HKY1p7jWLndGQV9M60g4", + "isUsed": "false", + "keyId": "7fbc27fd-e3df-4522-86bf-1930110256ad", + "lastUpdated": "2022-08-31T18:09:58.000Z", + "name": "Test key" + } + ] + }, + "ListAppGrantsEx": { + "summary": "List all app grants example", + "value": [ + { + "_embedded": { + "scope": { + "id": "okta.users.read" + } + }, + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}", + "title": "Application name" + }, + "client": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/{clientId}", + "title": "Client name" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}/grants/oag91n9ruw3dsaXzP0h6" + } + }, + "clientId": "{clientId}", + "created": "2023-02-21T16:54:00.000Z", + "createdBy": { + "id": "00u6eltha0nrSc47i0h7", + "type": "User" + }, + "id": "oag91n9ruw3dsaXzP0h6", + "issuer": "{yourOktaDomain}", + "lastUpdated": "2023-02-21T16:54:00.000Z", + "scopeId": "okta.users.read", + "source": "ADMIN", + "status": "ACTIVE" + }, + { + "_embedded": { + "scope": { + "id": "okta.apps.manage" + } + }, + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}", + "title": "Application name" + }, + "client": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/{clientId}", + "title": "Client name" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}/grants/oaghm3sh9ukdkvDmO0h6" + } + }, + "clientId": "{clientId}", + "created": "2023-02-03T21:57:49.000Z", + "createdBy": { + "id": "00u6eltha0nrSc47i0h7", + "type": "User" + }, + "id": "oaghm3sh9ukdkvDmO0h6", + "issuer": "{yourOktaDomain}", + "lastUpdated": "2023-02-03T21:57:49.000Z", + "scopeId": "okta.apps.manage", + "source": "ADMIN", + "status": "ACTIVE" + } + ] + }, + "ListAppLinks": { + "value": [ + { + "appAssignmentId": "0ua3omz7weMMMQJERBKY", + "appInstanceId": "0oa3omz2i9XRNSRIHBZO", + "appName": "google", + "credentialsSetup": false, + "hidden": false, + "id": "00ub0oNGTSWTBKOLGLNR", + "label": "Google Apps Mail", + "linkUrl": "https://{yourOktaDomain}/home/google/0oa3omz2i9XRNSRIHBZO/50", + "logoUrl": "https://{yourOktaDomain}/img/logos/google-mail.png", + "sortOrder": 0 + }, + { + "appAssignmentId": "0ua3omz7weMMMQJERBKY", + "appInstanceId": "0oa3omz2i9XRNSRIHBZO", + "appName": "google", + "credentialsSetup": false, + "hidden": false, + "id": "00ub0oNGTSWTBKOLGLNR", + "label": "Google Apps Calendar", + "linkUrl": "https://{yourOktaDomain}/home/google/0oa3omz2i9XRNSRIHBZO/54", + "logoUrl": "https://{yourOktaDomain}/img/logos/google-calendar.png", + "sortOrder": 1 + }, + { + "appAssignmentId": "0ua3omx46lYEZLPPRWBO", + "appInstanceId": "0oa3ompioiQCSTOYXVBK", + "appName": "boxnet", + "credentialsSetup": false, + "hidden": false, + "id": "00ub0oNGTSWTBKOLGLNR", + "label": "Box", + "linkUrl": "https://{yourOktaDomain}/home/boxnet/0oa3ompioiQCSTOYXVBK/72", + "logoUrl": "https://{yourOktaDomain}/img/logos/box.png", + "sortOrder": 3 + }, + { + "appAssignmentId": "0ua173qgj5VAVOBQMCVB", + "appInstanceId": "0oa12ecnxtBQMKOXJSMF", + "appName": "salesforce", + "credentialsSetup": true, + "hidden": false, + "id": "00ub0oNGTSWTBKOLGLNR", + "label": "Salesforce.com", + "linkUrl": "https://{yourOktaDomain}/home/salesforce/0oa12ecnxtBQMKOXJSMF/46", + "logoUrl": "https://{yourOktaDomain}/img/logos/salesforce_logo.png", + "sortOrder": 2 + } + ] + }, + "ListAppServiceAccounts": { + "summary": "List app service accounts", + "value": [ + { + "containerGlobalName": "salesforce", + "containerInstanceName": "salesforce-1", + "containerOrn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:salesforce:0oa1gjh63g214q0Hq0g4", + "created": "2024-04-04T15:56:05.000Z", + "description": "This is for accessing salesforce Prod-1", + "id": "a747a818-a4c4-4446-8a87-704216495a08", + "lastUpdated": "2024-04-05T18:15:44.000Z", + "name": "salesforce Prod-1 account", + "ownerGroupIds": [ + "00g57qp78yZT2XBA40g7" + ], + "ownerUserIds": [ + "00u11s48P9zGW8yqm0g5" + ], + "status": "NO_ISSUES", + "statusDetail": "ROTATED", + "username": "testuser-salesforce-1@example.com" + }, + { + "containerGlobalName": "salesforce", + "containerInstanceName": "salesforce-5", + "containerOrn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:salesforce:0oa1gjh63g214q0Hq0g4", + "created": "2024-04-04T15:56:05.000Z", + "description": "This is for accessing salesforce Prod-5", + "id": "a747a818-a4c4-4446-8a87-704216495a09", + "lastUpdated": "2024-04-05T18:15:44.000Z", + "name": "salesforce Prod-5 account", + "ownerGroupIds": [ + "00g57qp78yZT2XBA40g7" + ], + "ownerUserIds": [ + "00u11s48P9zGW8yqm0g5" + ], + "status": "NO_ISSUES", + "statusDetail": "ROTATED", + "username": "testuser-salesforce-5@example.com" + } + ] + }, + "ListAssocAuthServerResponse": { + "summary": "List associated authorization servers", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}" + } + }, + "audiences": [ + "https://api.resource.com" + ], + "created": "2023-05-17T22:25:57.000Z", + "credentials": { + "signing": { + "kid": "WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4", + "lastRotated": "2023-05-17T22:25:57.000Z", + "nextRotation": "2023-08-15T22:25:57.000Z", + "rotationMode": "DYNAMIC", + "use": "sig" + } + }, + "description": "Sample Authorization Server description", + "id": "{authorizationServerId}", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "issuerMode": "CUSTOM_URL", + "lastUpdated": "2023-05-17T22:25:57.000Z", + "name": "Sample Authorization Server", + "status": "ACTIVE" + } + ] + }, + "ListAuthServersResponse": { + "summary": "List all custom authorization servers in your org", + "value": [ + { + "_links": { + "claims": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate" + }, + "metadata": [ + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server", + "name": "oauth-authorization-server" + }, + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration", + "name": "openid-configuration" + } + ], + "policies": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies" + }, + "rotateKey": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate" + }, + "scopes": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}" + } + }, + "audiences": [ + "https://api.resource.com" + ], + "created": "2023-05-17T22:25:57.000Z", + "credentials": { + "signing": { + "kid": "WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4", + "lastRotated": "2023-05-17T22:25:57.000Z", + "nextRotation": "2023-08-15T22:25:57.000Z", + "rotationMode": "AUTO" + } + }, + "description": "Sample Authorization Server description", + "id": "{authorizationServerId}", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "issuerMode": "ORG_URL", + "lastUpdated": "2023-05-17T22:25:57.000Z", + "name": "Sample Authorization Server", + "status": "ACTIVE" + } + ] + }, + "ListAuthorizationServerKeys": { + "summary": "All credential keys", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc" + } + }, + "alg": "RS256", + "e": "AQAB", + "kid": "RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc", + "kty": "RSA", + "n": "g0MirhrysJMPm_wK45jvMbbyanfhl-jmTBv0o69GeifPaISaXGv8LKn3-CyJvUJcjjeHE17KtumJWVxUDRzFqtIMZ1ctCZyIAuWO0n LKilg7_EIDXJrS8k14biqkPO1lXGFwtjo3zLHeFSLw6sWf-CEN9zv6Ff3IAXb-RMYpfh-bVrxIgWsWCxjLW-UKI3la-gs0nWHH2PJr5HLJuI JIOL5HLJuIJIOLWahqTnm_r1LSCSYr6N4C-fh--w2_BW8DzTHalBYe76bNr0d7AqtR4tGazmrvrc79Wa2bjyxmhhN1u9jSaZQqq-3VZEod8q3, WHH2PJ5v1LoXniJQ4a2W8nDVqb6h4E8MUKYOpljTfQ", + "status": "ACTIVE", + "use": "sig" + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo" + } + }, + "alg": "RS256", + "e": "AQAB", + "kid": "Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo", + "kty": "RSA", + "n": "l1hZ_g2sgBE3oHvu34T-5XP18FYJWgtul_nRNg-5xra5ySkaXEOJUDRERUG0HrR42uqf9jYrUTwg9fp-SqqNIdHRaN8EwRSDRsKAwK 3 HIJ2NJfgmrrO2ABkeyUq6rzHxAumiKv1iLFpSawSIiTEBJERtUCDcjbbqyHVFuivIFgH8L37 - XDIDb0XG - R8DOoOHLJPTpsgH - rJe M5w96VIRZInsGC5OGWkFdtgk6OkbvVd7_TXcxLCpWeg1vlbmX - 0 TmG5yjSj7ek05txcpxIqYu - 7 FIGT0KKvXge_BOSEUlJpBhLKU28 OtsOnmc3NLIGXB - GeDiUZiBYQdPR - myB4ZoQ", + "status": "NEXT", + "use": "sig" + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/h5Sr3LXcpQiQlAUVPdhrdLFoIvkhRTAVs_h39bQnxlU" + } + }, + "alg": "RS256", + "e": "AQAB", + "kid": "h5Sr3LXcpQiQlAUVPdhrdLFoIvkhRTAVs_h39bQnxlU", + "kty": "RSA", + "n": "lC4ehVB6W0OCtNPnz8udYH9Ao83B6EKnHA5eTcMOap_lQZ-nKtS1lZwBj4wXRVc1XmS0d2OQFA1VMQ-dHLDE3CiGfsGqWbaiZFdW7U GLO1nAwfDdH6xp3xwpKOMewDXbAHJlXdYYAe2ap - CE9c5WLTUBU6JROuWcorHCNJisj1aExyiY5t3JQQVGpBz2oUIHo7NRzQoKimvp dMvMzcYnTlk1dhlG11b1GTkBclprm1BmOP7Ltjd7aEumOJWS67nKcAZzl48Zyg5KtV11V9F9dkGt25qHauqFKL7w3wu - DYhT0hmyFc wn - tXS6e6HQbfHhR_MQxysLtDGOk2ViWv8AQ", + "status": "EXPIRED", + "use": "sig" + } + ] + }, + "ListAuthorizationServerPolicies": { + "summary": "List authorization server policies", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies/00palyaappA22DPkj0h7/lifecycle/deactivate" + }, + "rules": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies/00palyaappA22DPkj0h7/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies/00palyaappA22DPkj0h7" + } + }, + "conditions": { + "clients": { + "include": [ + "ALL_CLIENTS" + ] + } + }, + "created": "2017-05-26T19:43:53.000Z", + "description": "Vendor2 policy description", + "id": "00palyaappA22DPkj0h7", + "lastUpdated": "2017-06-07T15:28:17.000Z", + "name": "Vendor2 Policy", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "OAUTH_AUTHORIZATION_POLICY" + } + ] + }, + "ListAuthorizationServerPolicyRules": { + "summary": "List authorization server policy rules", + "value": [ + { + "_links": { + "self": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/0prbsjfyl01zfSZ9K0h7/lifecycle/deactivate" + }, + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/0prbsjfyl01zfSZ9K0h7" + } + }, + "actions": { + "token": { + "accessTokenLifetimeMinutes": 60, + "inlineHook": { + "id": "cal4egvp1mbMldrYN0g7" + }, + "refreshTokenLifetimeMinutes": 0, + "refreshTokenWindowMinutes": 10080 + } + }, + "conditions": { + "grantTypes": { + "include": [ + "implicit", + "client_credentials", + "authorization_code", + "password" + ] + }, + "people": { + "groups": { + "exclude": [], + "include": [ + "EVERYONE" + ] + }, + "users": { + "exclude": [], + "include": [] + } + }, + "scopes": { + "include": [ + "*" + ] + } + }, + "created": "2017-08-25T16:57:02.000Z", + "id": "0prbsjfyl01zfSZ9K0h7", + "lastUpdated": "2017-08-30T14:51:05.000Z", + "name": "Default Policy Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "RESOURCE_ACCESS" + } + ] + }, + "ListBasicSMTPServer": { + "summary": "List containing basic authentication SMTP server", + "value": { + "email-servers": [ + { + "alias": "CustomServer1", + "authType": "BASIC_SMTP_AUTH", + "enabled": true, + "host": "smtp.example.com", + "id": "ces7n3u7sSohfoaou0g1", + "port": 587, + "username": "user@example.com" + } + ] + } + }, + "ListBrandsResponse": { + "value": [ + { + "_links": { + "emailDomain": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/email-domains/OeD114iNkrcN6aR680g4" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4" + }, + "themes": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/themes" + } + }, + "agreeToCustomPrivacyPolicy": false, + "customPrivacyPolicyUrl": null, + "defaultApp": { + "appInstanceId": "0oa114iNkrcN6aR680g4", + "appLinkName": null, + "classicApplicationUri": null + }, + "emailDomainId": "OeD114iNkrcN6aR680g4", + "id": "bnd114iNkrcN6aR680g4", + "isDefault": true, + "locale": "en", + "name": "Okta Default", + "removePoweredByOkta": false + } + ] + }, + "ListClientsResponse": { + "summary": "List all client resources for which an authorization server has tokens", + "value": [ + { + "_links": { + "client": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/{clientId}", + "title": "My Web App" + }, + "tokens": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/clients/{clientId}/tokens" + } + }, + "client_id": "{clientId}", + "client_name": "My Web App", + "client_uri": "null,", + "logo_uri": "null," + } + ] + }, + "ListCustomTokenClaimsResponse": { + "summary": "List all custom token claims for an authorization server", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims/{claimId}" + } + }, + "alwaysIncludeInToken": true, + "apiResourceId": null, + "claimType": "RESOURCE", + "conditions": { + "scopes": [ + "profile" + ] + }, + "id": "{claimId}", + "name": "sub", + "status": "ACTIVE", + "system": true, + "value": "(appuser != null) ? appuser.userName : app.clientId", + "valueType": "EXPRESSION" + } + ] + }, + "ListEmailCustomizationResponse": { + "value": [ + { + "_links": { + "preview": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4/preview" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4" + }, + "template": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + }, + "test": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" + } + }, + "body": "

Hello, ${user.profile.firstName}. Click here to activate your account.", + "created": "2021-11-09T20:38:10.000Z", + "id": "oel11u6DqUiMbQkpl0g4", + "isDefault": true, + "language": "en", + "lastUpdated": "2021-11-11T20:38:10.000Z", + "subject": "Welcome to ${org.name}!" + } + ] + }, + "ListEmailTemplateResponse": { + "value": [ + { + "_embedded": { + "customizationCount": 0, + "settings": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings" + }, + "template": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + } + }, + "recipients": "ALL_USERS" + } + }, + "_links": { + "customizations": { + "hints": { + "allow": [ + "GET", + "POST", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations" + }, + "defaultContent": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + }, + "settings": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings" + }, + "test": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" + } + }, + "name": "UserActivation" + } + ] + }, + "ListFactorsResults": { + "summary": "List of enrolled factors for the specified user", + "value": [ + { + "_links": { + "questions": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/questions" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ufs2bysphxKODSZKWVCT" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2014-04-15T18:10:06.000Z", + "factorType": "question", + "id": "ufs2bysphxKODSZKWVCT", + "lastUpdated": "2014-04-15T18:10:06.000Z", + "profile": { + "question": "favorite_art_piece", + "questionText": "What is your favorite piece of art?" + }, + "provider": "OKTA", + "status": "ACTIVE", + "vendorName": "OKTA" + }, + { + "_embedded": { + "activation": { + "encoding": "base32", + "keyLength": 16, + "sharedSecret": "HE64TMLL2IUZW2ZLB", + "timeStep": 30 + } + }, + "_links": { + "next": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf2gsyictRQDSGTDZE/lifecycle/activate", + "name": "activate" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf2gsyictRQDSGTDZE" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + } + }, + "created": "2014-06-27T20:27:33.000Z", + "factorType": "token:software:totp", + "id": "ostf2gsyictRQDSGTDZE", + "lastUpdated": "2014-06-27T20:27:33.000Z", + "profile": { + "credentialId": "dade.murphy@example.com" + }, + "provider": "OKTA", + "status": "PENDING_ACTIVATION" + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/sms2gt8gzgEBPUWBIFHN" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/sms2gt8gzgEBPUWBIFHN/verify" + } + }, + "created": "2014-06-27T20:27:26.000Z", + "factorType": "sms", + "id": "sms2gt8gzgEBPUWBIFHN", + "lastUpdated": "2014-06-27T20:27:26.000Z", + "profile": { + "phoneNumber": "+1-555-415-1337" + }, + "provider": "OKTA", + "status": "ACTIVE" + } + ] + }, + "ListFeatureDependenciesResponse": { + "summary": "List all dependencies for a feature", + "value": [ + { + "_links": { + "dependencies": { + "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies" + }, + "dependents": { + "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents" + }, + "self": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7" + } + }, + "description": "Example feature description", + "id": "ftrZooGoT8b41iWRiQs7", + "name": "Example feature name", + "stage": { + "state": "OPEN", + "value": "EA" + }, + "status": "ENABLED", + "type": "self-service" + } + ] + }, + "ListFeatureDependentsResponse": { + "summary": "List all feature dependents for the specified feature", + "value": [ + { + "_links": { + "dependencies": { + "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies" + }, + "dependents": { + "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents" + }, + "self": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7" + } + }, + "description": "Example feature description", + "id": "ftrZooGoT8b41iWRiQs7", + "name": "Example feature name", + "stage": { + "state": "OPEN", + "value": "EA" + }, + "status": "ENABLED", + "type": "self-service" + } + ] + }, + "ListFeaturesResponse": { + "summary": "List all self-service features for your org", + "value": [ + { + "_links": { + "dependencies": { + "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies" + }, + "dependents": { + "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents" + }, + "self": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7" + } + }, + "description": "Example feature description", + "id": "ftrZooGoT8b41iWRiQs7", + "name": "Example feature name", + "stage": { + "state": "CLOSED", + "value": "BETA" + }, + "status": "DISABLED", + "type": "self-service" + } + ] + }, + "ListGroupPushMappingsResponse_Example": { + "value": [ + { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" + }, + "sourceGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000000" + }, + "targetGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000001" + } + }, + "created": "2025-01-01T00:00:00Z", + "errorSummary": "", + "id": "gPm00000000000000000", + "lastPush": "2025-01-01T00:00:00Z", + "lastUpdated": "2025-01-01T00:00:00Z", + "sourceGroupId": "00g00000000000000000", + "status": "ACTIVE", + "targetGroupId": "00g00000000000000001" + }, + { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" + }, + "sourceGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000002" + }, + "targetGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000003" + } + }, + "created": "2025-01-02T00:00:00Z", + "errorSummary": "", + "id": "gPm00000000000000001", + "lastPush": "2025-01-02T00:00:00Z", + "lastUpdated": "2025-01-02T00:00:00Z", + "sourceGroupId": "00g00000000000000002", + "status": "INACTIVE", + "targetGroupId": "00g00000000000000003" + } + ] + }, + "ListGroupPushMappingsResponse_ExampleWithActiveFilter": { + "value": [ + { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" + }, + "sourceGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000000" + }, + "targetGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000001" + } + }, + "created": "2025-01-01T00:00:00Z", + "errorSummary": "", + "id": "gPm00000000000000000", + "lastPush": "2025-01-01T00:00:00Z", + "lastUpdated": "2025-01-01T00:00:00Z", + "sourceGroupId": "00g00000000000000000", + "status": "ACTIVE", + "targetGroupId": "00g00000000000000001" + } + ] + }, + "ListIdPUsersResponse": { + "summary": "List of linked IdP users", + "value": [ + { + "_links": { + "idp": { + "href": "https://{yourOktaDomain}/api/v1/idps/0oa4lb6lbtmH355Hx0h7" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa4lb6lbtmH355Hx0h7/users/00u5cl9lo7nMjHjPr0h7" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00u5cl9lo7nMjHjPr0h7" + } + }, + "created": "2015-11-03T19:10:11.000Z", + "externalId": "109912936038778", + "id": "00u5cl9lo7nMjHjPr0h7", + "lastUpdated": "2015-11-03T19:11:49.000Z", + "profile": { + "displayName": "Carol Johnson", + "email": "carol_johnson@tfbnw.net", + "firstName": "Carol", + "lastName": "Johnson", + "middleName": "Lee", + "profile": "https://www.facebook.com/app_scoped_user_id/109912936038778/" + } + } + ] + }, + "ListInterclientAllowedAppsResponse": { + "summary": "List interclient allowed apps example", + "value": [ + "0oa1elyw9EAkUNUrW0g5", + "0oa5mihmA6vMpXcm50g5", + "0oa89ks1irGAcYwXw0g5" + ] + }, + "ListInterclientTargetAppsResponse": { + "summary": "List interclient target apps", + "value": [ + "0oa1elyw9EAkUNUrW0g5", + "0oa5mihmA6vMpXcm50g5", + "0oa89ks1irGAcYwXw0g5" + ] + }, + "ListLinkedObjects": { + "summary": "List all linked object definitions", + "value": [ + { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/meta/schemas/user/linkedObjects/manager" + } + }, + "associated": { + "description": "Subordinate link property", + "name": "subordinate", + "title": "subordinate", + "type": "USER" + }, + "primary": { + "description": "Manager link property", + "name": "manager", + "title": "manager", + "type": "USER" + } + } + ] + }, + "ListLogs": { + "summary": "List all System Log events", + "value": [ + { + "actor": { + "alternateId": "john.doe@example.com", + "detailEntry": null, + "displayName": "John Doe", + "id": "00uttidj01jqL21aM1d6", + "type": "User" + }, + "authenticationContext": { + "authenticationProvider": null, + "authenticationStep": 0, + "credentialProvider": null, + "credentialType": null, + "externalSessionId": "idxBager62CSveUkTxvgRtonA", + "interface": null, + "issuer": null, + "rootSessionId": "idxBager62CSveUkTxvgRtonA" + }, + "client": { + "device": "Computer", + "geographicalContext": { + "city": "New York", + "country": "United States", + "geolocation": { + "lat": 40.3157, + "lon": -74.01 + }, + "postalCode": 10013, + "state": "New York" + }, + "id": null, + "ipAddress": "10.0.0.1", + "userAgent": { + "browser": "CHROME", + "os": "Mac OS X", + "rawUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36" + }, + "zone": null + }, + "debugContext": { + "debugData": { + "requestId": "ab609228fe84ce59cdcbfa690bcce016", + "requestUri": "/idp/idx/authenticators/poll", + "url": "/idp/idx/authenticators/poll" + } + }, + "device": { + "device_integrator": null, + "disk_encryption_type": "ALL_INTERNAL_VOLUMES", + "id": "guofdhyjex1feOgbN1d9", + "jailbreak": null, + "managed": false, + "name": "Mac15,6", + "os_platform": "OSX", + "os_version": "14.6.0", + "registered": true, + "screen_lock_type": "BIOMETRIC", + "secure_hardware_present": true + }, + "displayMessage": "User login to Okta", + "eventType": "user.session.start", + "legacyEventType": "core.user_auth.login_success", + "outcome": { + "reason": null, + "result": "SUCCESS" + }, + "published": "2024-08-13T15:58:20.353Z", + "request": { + "ipChain": [ + { + "geographicalContext": { + "city": "New York", + "country": "United States", + "geolocation": { + "lat": 40.3157, + "lon": -74.01 + }, + "postalCode": 10013, + "state": "New York" + }, + "ip": "10.0.0.1", + "source": null, + "version": "V4" + } + ] + }, + "securityContext": { + "asNumber": 394089, + "asOrg": "ASN 0000", + "domain": null, + "isProxy": false, + "isp": "google" + }, + "severity": "INFO", + "target": [ + { + "alternateId": "unknown", + "detailEntry": null, + "displayName": "Okta Verify", + "id": "pfdfdhyjf0HMbkP2e1d7", + "type": "AuthenticatorEnrollment" + }, + { + "alternateId": "Okta Admin Console", + "detailEntry": null, + "displayName": "Okta Admin Console", + "id": "0oatxlef9sQvvqInq5d6", + "type": "AppInstance" + } + ], + "transaction": { + "detail": null, + "id": "ab609228fe84ce59cdcbfa690bgce016", + "type": "WEB" + }, + "uuid": "dc9fd3c0-598c-11ef-8478-2b7584bf8d5a", + "version": 0 + } + ] + }, + "ListLogsWithAdditionalSecurityContext": { + "summary": "List all System Log events with more security context", + "value": { + "actor": { + "alternateId": "john.doe@example.com", + "detailEntry": null, + "displayName": "John Doe", + "id": "00uttidj01jqL21aM1d6", + "type": "User" + }, + "authenticationContext": { + "authenticationProvider": null, + "authenticationStep": 0, + "credentialProvider": null, + "credentialType": null, + "externalSessionId": "idxBager62CSveUkTxvgRtonA", + "interface": null, + "issuer": null, + "rootSessionId": "idxBager62CSveUkTxvgRtonA" + }, + "client": { + "device": "Computer", + "geographicalContext": { + "city": "New York", + "country": "United States", + "geolocation": { + "lat": 40.3157, + "lon": -74.01 + }, + "postalCode": 10013, + "state": "New York" + }, + "id": null, + "ipAddress": "10.0.0.1", + "userAgent": { + "browser": "CHROME", + "os": "Mac OS X", + "rawUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36" + }, + "zone": null + }, + "debugContext": { + "debugData": { + "requestId": "ab609228fe84ce59cdcbfa690bcce016", + "requestUri": "/idp/idx/authenticators/poll", + "url": "/idp/idx/authenticators/poll" + } + }, + "device": { + "device_integrator": null, + "disk_encryption_type": "ALL_INTERNAL_VOLUMES", + "id": "guofdhyjex1feOgbN1d9", + "jailbreak": null, + "managed": false, + "name": "Mac15,6", + "os_platform": "OSX", + "os_version": "14.6.0", + "registered": true, + "screen_lock_type": "BIOMETRIC", + "secure_hardware_present": true + }, + "displayMessage": "User login to Okta", + "eventType": "user.session.start", + "legacyEventType": "core.user_auth.login_success", + "outcome": { + "reason": null, + "result": "SUCCESS" + }, + "published": "2024-08-13T15:58:20.353Z", + "request": { + "ipChain": [ + { + "geographicalContext": { + "city": "New York", + "country": "United States", + "geolocation": { + "lat": 40.3157, + "lon": -74.01 + }, + "postalCode": 10013, + "state": "New York" + }, + "ip": "10.0.0.1", + "ipDetails": { + "asNumber": 394089, + "asOrg": "ASN 0000", + "isp": "google" + }, + "source": null, + "version": "V4" + } + ] + }, + "securityContext": { + "asNumber": 394089, + "asOrg": "ASN 0000", + "botProtection": { + "level": "LOW" + }, + "domain": null, + "ipDetails": { + "asNumber": 394089, + "asOrg": "ASN 0000", + "isp": "google" + }, + "isProxy": false, + "isp": "google", + "risk": { + "detectionName": "Suspected Session Hijacking", + "level": "HIGH", + "reasons": [ + "Anomalous Device" + ] + }, + "userBehaviors": [ + { + "id": "bhv3pcdHYo3rVDL0w0g4", + "name": "New Device", + "result": "NEGATIVE" + }, + { + "id": "bhvexm4UkQc71MgEw0g4", + "name": "New Geo-Location", + "result": "POSITIVE" + } + ] + }, + "severity": "INFO", + "target": [ + { + "alternateId": "unknown", + "detailEntry": null, + "displayName": "Okta Verify", + "id": "pfdfdhyjf0HMbkP2e1d7", + "type": "AuthenticatorEnrollment" + }, + { + "alternateId": "Okta Admin Console", + "detailEntry": null, + "displayName": "Okta Admin Console", + "id": "0oatxlef9sQvvqInq5d6", + "type": "AppInstance" + } + ], + "transaction": { + "detail": null, + "id": "ab609228fe84ce59cdcbfa690bgce016", + "type": "WEB" + }, + "uuid": "dc9fd3c0-598c-11ef-8478-2b7584bf8d5a", + "version": 0 + }, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "ListMappingsResponse": { + "summary": "List all profile mappings response", + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/mappings/prm1k48weFSOnEUnw0g4" + } + }, + "id": "prm1k47ghydIQOTBW0g4", + "source": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscsbePhQ3yqt4cVv0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/types/user/otysbePhQ3yqt4cVv0g3" + } + }, + "id": "otysbePhQ3yqt4cVv0g3", + "name": "user", + "type": "user" + }, + "target": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/apps/0oa1qmn4LZQQEH0wZ0g4/default" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1qmn4LZQQEH0wZ0g4" + } + }, + "id": "0oa1qmn4LZQQEH0wZ0g4", + "name": "okta_org2org", + "type": "appuser" + } + } + ] + }, + "ListOAuth2ResourceServerJsonWebKeys": { + "summary": "All OAuth2 Resource Server JSON Web Keys", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/resourceservercredentials/keys/RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc" + } + }, + "created": "2023-04-06T21:32:33.000Z", + "e": "AQAB", + "id": "apk40n33xfjbPaf6D0g5", + "kid": "RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc", + "kty": "RSA", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "n": "g0MirhrysJMPm_wK45jvMbbyanfhl-jmTBv0o69GeifPaISaXGv8LKn3-CyJvUJcjjeHE17KtumJWVxUDRzFqtIMZ1ctCZyIAuWO0n LKilg7_EIDXJrS8k14biqkPO1lXGFwtjo3zLHeFSLw6sWf-CEN9zv6Ff3IAXb-RMYpfh-bVrxIgWsWCxjLW-UKI3la-gs0nWHH2PJr5HLJuI JIOL5HLJuIJIOLWahqTnm_r1LSCSYr6N4C-fh--w2_BW8DzTHalBYe76bNr0d7AqtR4tGazmrvrc79Wa2bjyxmhhN1u9jSaZQqq-3VZEod8q3, WHH2PJ5v1LoXniJQ4a2W8nDVqb6h4E8MUKYOpljTfQ", + "status": "ACTIVE", + "use": "enc" + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/resourceservercredentials/keys/Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo" + } + }, + "created": "2023-04-06T21:32:33.000Z", + "e": "AQAB", + "id": "apk33a45xfjbDfg6D0g5", + "kid": "Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo", + "kty": "RSA", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "n": "l1hZ_g2sgBE3oHvu34T-5XP18FYJWgtul_nRNg-5xra5ySkaXEOJUDRERUG0HrR42uqf9jYrUTwg9fp-SqqNIdHRaN8EwRSDRsKAwK 3 HIJ2NJfgmrrO2ABkeyUq6rzHxAumiKv1iLFpSawSIiTEBJERtUCDcjbbqyHVFuivIFgH8L37 - XDIDb0XG - R8DOoOHLJPTpsgH - rJe M5w96VIRZInsGC5OGWkFdtgk6OkbvVd7_TXcxLCpWeg1vlbmX - 0 TmG5yjSj7ek05txcpxIqYu - 7 FIGT0KKvXge_BOSEUlJpBhLKU28 OtsOnmc3NLIGXB - GeDiUZiBYQdPR - myB4ZoQ", + "status": "INACTIVE", + "use": "enc" + } + ] + }, + "ListOAuthClientCredentialsServer": { + "summary": "List containing OAuth 2.0 client credentials SMTP server", + "value": { + "email-servers": [ + { + "alias": "OAuthServer1", + "authType": "OAUTH2_CLIENT_CREDENTIALS", + "clientId": "oauth-client-id", + "enabled": true, + "host": "smtp.oauth.com", + "id": "ces7n3u7sSohfoaou0g2", + "port": 587, + "scopes": [ + "send_email" + ], + "tokenEndpoint": "https://oauth.example.com/token", + "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC", + "username": "user@oauth.com" + } + ] + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "ListOAuthJWTServer": { + "summary": "List containing OAuth 2.0 JWT bearer grant SMTP server", + "value": { + "email-servers": [ + { + "alias": "OAuthServer2", + "audience": "https://smtp.oauth.com", + "authType": "OAUTH2_JWT_BEARER_GRANT", + "clientId": "oauth-client-id", + "enabled": true, + "host": "smtp.oauth.com", + "id": "ces7n3u7sSohfoaou0g3", + "issuer": "https://oauth.example.com", + "port": 587, + "scopes": [ + "org.email.send" + ], + "signingAlgorithm": "RS256", + "subject": "user@oauth.com", + "tokenEndpoint": "https://oauth.example.com/token", + "username": "user@oauth.com" + } + ] + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "ListOfSecurityEventsProviderInstances": { + "summary": "List of security events providers", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.okta.com/api/v1/security-events-providers/sse1qg25RpusjUP6m0g5/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://example.okta.com/api/v1/security-events-providers/sse1qg25RpusjUP6m0g5" + } + }, + "id": "sse1qg25RpusjUP6m0g5", + "name": "Security events provider with well-known URL", + "settings": { + "issuer": "Issuer", + "jwks_url": "https://example.okta.com/jwks/path", + "well_known_url": "https://example.okta.com/.well-known/ssf-configuration" + }, + "status": "ACTIVE", + "type": "okta" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.okta.com/api/v1/security-events-providers/sse1qu4fUtsoD12iF0g5/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://example.okta.com/api/v1/security-events-providers/sse1qu4fUtsoD12iF0g5" + } + }, + "id": "sse1qu4fUtsoD12iF0g5", + "name": "Security events provider with an issuer and a JWKS URL", + "settings": { + "issuer": "Issuer", + "jwks_url": "https://example.okta.com/jwks/path" + }, + "status": "ACTIVE", + "type": "okta" + } + ] + }, + "ListOktaManagedUserAccounts": { + "summary": "List Okta managed user accounts", + "value": [ + { + "created": "2023-04-04T15:56:05.000Z", + "description": "Shared admin account for managing AD integrations", + "email": "shr-ad-admin-01@example.com", + "id": "d1b65a78-21ed-429b-8ea3-eec96f2748d6", + "lastUpdated": "2023-05-05T18:15:44.000Z", + "name": "AD Integrations Admin", + "oktaUserId": "00u11s48P9zGW8yqm0g5", + "ownerGroupIds": [ + "00g57qp78yZT2XBA40g7" + ], + "ownerUserIds": [ + "00u22t59Q0aHbNEXi1h8" + ], + "status": "NO_ISSUES", + "statusDetail": "UNMANAGED", + "username": "shr-ad-admin-01@example.com" + }, + { + "created": "2023-06-15T10:30:00.000Z", + "description": "Service account for SCIM provisioning", + "email": "scim-service@example.com", + "id": "e2c76b89-32fe-530c-9fb4-ffd07f3859e7", + "lastUpdated": "2023-06-15T10:30:00.000Z", + "name": "SCIM Integration Service Account", + "oktaUserId": "00u33u60R1bIcOFYj2i9", + "ownerGroupIds": [], + "ownerUserIds": [ + "00u22t59Q0aHbNEXi1h8" + ], + "status": "UNSECURED", + "statusDetail": "STAGED", + "username": "scim-service@example.com" + } + ] + }, + "ListRealmAssignmentsResponse": { + "value": [ + { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/realm-assignments/rul2jy7jLUlnO3ng00g4", + "method": "GET", + "rel": "self" + } + }, + "actions": { + "assignUserToRealm": { + "realmId": "00g1b7rvh0xPLKXFf0g5" + } + }, + "conditions": { + "expression": { + "value": "user.profile.role ==\\\"Manager\\\"" + }, + "profileSourceId": "0oa4enoRyjwSCy5hx0g4" + }, + "created": "2022-04-04T15:56:05.000Z", + "domains": [ + "atko.com", + "user.com" + ], + "id": "rul2jy7jLUlnO3ng00g4", + "isDefault": false, + "lastUpdated": "2022-05-05T18:15:44.000Z", + "name": "Realm Assignment 1", + "priority": 0, + "status": "ACTIVE" + }, + { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/realm-assignments/rul2jy7jLUlnO5ng00g4", + "method": "GET", + "rel": "self" + } + }, + "actions": { + "assignUserToRealm": { + "realmId": "00g1b7rvh0xPLKXFf2g5" + } + }, + "conditions": { + "expression": { + "value": "string" + }, + "profileSourceId": "0oa4enoRyjwSCy6hx0g4," + }, + "created": "2022-04-04T15:56:05.000Z", + "domains": [ + "atko.com", + "user.com" + ], + "id": "rul2jy7jLUlnO5ng00g4", + "isDefault": true, + "lastUpdated": "2022-05-05T18:15:44.000Z", + "name": "Catch-all", + "priority": 499, + "status": "ACTIVE" + } + ] + }, + "ListRealmAwareUsersResponse": { + "summary": "List all users", + "value": [ + { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4" + } + }, + "activated": null, + "created": "2022-04-04T15:56:05.000Z", + "credentials": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00u118oQYT4TBGuay0g4", + "lastLogin": "2022-05-04T19:50:52.000Z", + "lastUpdated": "2022-05-05T18:15:44.000Z", + "passwordChanged": "2022-04-04T16:00:22.000Z", + "profile": { + "email": "alice.smith@example.com", + "firstName": "Alice", + "lastName": "Smith", + "login": "alice.smith@example.com", + "mobilePhone": null, + "secondEmail": null + }, + "realmId": "guo1afiNtSnZYILxO0g4", + "status": "ACTIVE", + "statusChanged": null, + "type": { + "id": "oty1162QAr8hJjTaq0g4" + } + } + ] + }, + "ListRealmsResponse": { + "value": [ + { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/realms/guox9jQ16k9V8IFEL0g3", + "method": "GET", + "rel": "self" + } + }, + "created": "2022-04-04T15:56:05.000Z", + "id": "guox9jQ16k9V8IFEL0g3", + "isDefault": false, + "lastUpdated": "2022-05-05T18:15:44.000Z", + "profile": { + "domains": [ + "atko.com", + "user.com" + ], + "name": "Car Co", + "realmType": "PARTNER" + } + } + ] + }, + "ListRefreshTokensClientsResponse": { + "summary": "List all refresh tokens for a client", + "value": [ + { + "_embedded": { + "scopes": [ + { + "_links": { + "scope": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/{scopeId}", + "title": "openid" + } + }, + "description": "Signals that a request is an OpenID request", + "displayName": "openid", + "id": "{scopeId}", + "name": "openid" + }, + { + "_links": { + "scope": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/{scopeId}", + "itle": "Keep you signed in to the app" + } + }, + "description": "This keeps you signed in to the app, even when you aren't using it.", + "displayName": "Keep you signed in to the app", + "id": "{scopeID}", + "name": "offline_access" + } + ] + }, + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}", + "title": "My Web App" + }, + "authorizationServer": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}", + "title": "Authorization Server name" + }, + "client": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/{clientId}", + "title": "My Web App" + }, + "revoke": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/clients/{clientId}/tokens/{tokenId}" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/clients/{clientId}/tokens/{tokenId}" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/{userId}", + "title": "Joe User" + } + }, + "client_id": "{clientId}", + "created": "2023-09-21T19:59:56.000Z", + "expiresAt": "2023-09-28T20:00:38.000Z", + "id": "{refreshTokenId}", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "lastUpdated": "2023-09-21T20:00:38.000Z", + "scopes": [ + "offline_access", + "openid" + ], + "status": "ACTIVE", + "userId": "{userId}" + } + ] + }, + "ListRiskProviderResponse": { + "summary": "List risk provider response example", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/risk/providers/00rp12r4skkjkjgsn" + } + }, + "action": "log_only", + "clientId": "00ckjsfgjkdkjdkkljjsd", + "created": "2021-01-05 22:18:30", + "id": "00rp12r4skkjkjgsn", + "lastUpdated": "2021-01-05 22:18:30", + "name": "Risk-Partner-X" + } + ] + }, + "ListServiceAccounts": { + "summary": "List service accounts with mixed account types", + "value": [ + { + "accountType": "APP_ACCOUNT", + "created": "2023-04-04T15:56:05.000Z", + "description": "This is for accessing AWS Prod-5", + "details": { + "appGlobalName": "AWS Account Federation", + "appInstanceName": "AWS Prod-5", + "credentials": { + "username": "testuser@example.com" + }, + "oktaApplicationId": "aln1aqcs055ZRoizW0g8" + }, + "id": "a747a818-a4c4-4446-8a87-704216495a08", + "lastUpdated": "2023-05-05T18:15:44.000Z", + "name": "AWS Prod-5 account", + "ownerGroupIds": [ + "00g57qp78yZT2XBA40g7" + ], + "ownerUserIds": [ + "00u11s48P9zGW8yqm0g5" + ], + "status": "NO_ISSUES", + "statusDetail": "ROTATED" + }, + { + "accountType": "OKTA_USER_ACCOUNT", + "created": "2023-04-04T15:56:05.000Z", + "description": "Shared admin account for managing AD integrations", + "details": { + "credentials": { + "username": "shr-ad-admin-01@example.com" + }, + "email": "shr-ad-admin-01@example.com", + "oktaUserId": "00u11s48P9zGW8yqm0g5" + }, + "id": "d1b65a78-21ed-429b-8ea3-eec96f2748d6", + "lastUpdated": "2023-05-05T18:15:44.000Z", + "name": "AD Integrations Admin", + "ownerGroupIds": [ + "00g57qp78yZT2XBA40g7" + ], + "ownerUserIds": [ + "00u11s48P9zGW8yqm0g5" + ], + "status": "NO_ISSUES", + "statusDetail": "UNMANAGED" + } + ] + }, + "ListSessionsResponseForGetSessions": { + "value": [ + { + "created": "2022-04-04T15:56:05.000Z", + "id": "aps1qqonvr2SZv6o70h8", + "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", + "importType": "INCREMENTAL", + "lastUpdated": "2022-05-05T16:15:44.000Z", + "status": "CREATED" + }, + { + "created": "2022-04-04T16:56:05.000Z", + "id": "aps1quck606ngubVq0h8", + "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", + "importType": "INCREMENTAL", + "lastUpdated": "2022-05-05T17:15:44.000Z", + "status": "TRIGGERED" + }, + { + "created": "2022-04-04T17:56:05.000Z", + "id": "aps1qzy2acb5jDlUc0h8", + "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", + "importType": "INCREMENTAL", + "lastUpdated": "2022-05-05T18:15:44.000Z", + "status": "IN_PROGRESS" + }, + { + "created": "2022-04-04T18:56:05.000Z", + "id": "aps1qqne8c1JHkMdF0h8", + "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", + "importType": "INCREMENTAL", + "lastUpdated": "2022-05-05T19:15:44.000Z", + "status": "EXPIRED" + }, + { + "created": "2022-04-04T19:56:05.000Z", + "id": "aps1qqonvr2SZv6o70h8", + "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", + "importType": "INCREMENTAL", + "lastUpdated": "2022-05-05T20:15:44.000Z", + "status": "CLOSED" + } + ] + }, + "ListThemesResponse": { + "value": [ + { + "backgroundImage": null, + "emailTemplateTouchPointVariant": "OKTA_DEFAULT", + "endUserDashboardTouchPointVariant": "OKTA_DEFAULT", + "errorPageTouchPointVariant": "OKTA_DEFAULT", + "favicon": "https://{yourOktaDomain}/favicon.ico", + "id": "thdul904tTZ6kWVhP0g3", + "loadingPageTouchPointVariant": "OKTA_DEFAULT", + "logo": "https://{yourOktaDomain}/assets/img/logos/okta-logo.47066819ac7db5c13f4c431b2687cef6.png", + "primaryColorContrastHex": "#000000", + "primaryColorHex": "#1662dd", + "secondaryColorContrastHex": "#000000", + "secondaryColorHex": "#ebebed", + "signInPageTouchPointVariant": "OKTA_DEFAULT" + } + ] + }, + "ListUISchemaResponse": { + "summary": "Lists all UI schemas response", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://example.com/api/v1/meta/uischemas/uis4a7liocgcRgcxZ0g7" + } + }, + "created": "2022-07-25T12:56:31.000Z", + "id": "uis4a7liocgcRgcxZ0g7", + "lastUpdated": "2022-07-26T11:53:59.000Z", + "uiSchema": { + "buttonLabel": "Submit", + "elements": [ + { + "label": "First name", + "options": { + "format": "text" + }, + "scope": "#/properties/firstName", + "type": "Control" + }, + { + "label": "Last name", + "options": { + "format": "text" + }, + "scope": "#/properties/lastName", + "type": "Control" + }, + { + "label": "Email", + "options": { + "format": "text" + }, + "scope": "#/properties/email", + "type": "Control" + }, + { + "label": "Country code", + "options": { + "format": "select" + }, + "scope": "#/properties/countryCode", + "type": "Control" + }, + { + "label": "bool2", + "options": { + "format": "checkbox" + }, + "scope": "#/properties/bool2", + "type": "Control" + }, + { + "label": "date", + "options": { + "format": "text" + }, + "scope": "#/properties/date", + "type": "Control" + }, + { + "label": "enum", + "options": { + "format": "radio" + }, + "scope": "#/properties/enum", + "type": "Control" + } + ], + "label": "Sign in", + "type": "Group" + } + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://example.com/api/v1/meta/uischemas/uis4abjqkkKXVPGAU0g7" + } + }, + "created": "2022-07-25T12:56:31.000Z", + "id": "uis4abjqkkKXVPGAU0g7", + "lastUpdated": "2022-07-26T11:53:59.000Z", + "uiSchema": { + "buttonLabel": "Submit", + "elements": [ + { + "label": "First name", + "options": { + "format": "text" + }, + "scope": "#/properties/firstName", + "type": "Control" + }, + { + "label": "Last name", + "options": { + "format": "text" + }, + "scope": "#/properties/lastName", + "type": "Control" + }, + { + "label": "Email", + "options": { + "format": "text" + }, + "scope": "#/properties/email", + "type": "Control" + }, + { + "label": "Country code", + "options": { + "format": "select" + }, + "scope": "#/properties/countryCode", + "type": "Control" + }, + { + "label": "bool2", + "options": { + "format": "checkbox" + }, + "scope": "#/properties/bool2", + "type": "Control" + }, + { + "label": "date", + "scope": "#/properties/date", + "type": "Control" + }, + { + "label": "enum", + "options": { + "format": "radio" + }, + "scope": "#/properties/enum", + "type": "Control" + } + ], + "label": "Sign in 2", + "type": "Group" + } + } + ] + }, + "ListUserBlocksAnyDevicesResponse": { + "value": [ + { + "appliesTo": "ANY_DEVICES", + "type": "DEVICE_BASED" + } + ] + }, + "ListUserBlocksUnknownDevicesResponse": { + "value": [ + { + "appliesTo": "UNKNOWN_DEVICES", + "type": "DEVICE_BASED" + } + ] + }, + "ListUserClients": { + "value": [ + { + "_links": { + "grants": { + "href": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7/clients/0oabskvc6442nkvQO0h7/grants" + }, + "tokens": { + "href": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7/clients/0oabskvc6442nkvQO0h7/tokens" + } + }, + "client_id": "0oabskvc6442nkvQO0h7", + "client_name": "My App", + "client_uri": null, + "logo_uri": null + } + ] + }, + "ListUserGroups": { + "value": [ + { + "id": "0gabcd1234", + "profile": { + "description": "Users can access cloud apps", + "name": "Cloud app users" + } + }, + { + "id": "0gefgh5678", + "profile": { + "description": "Users can access internal apps", + "name": "Internal app users" + } + } + ] + }, + "ListUsersFieldsResponse": { + "description": "Response for query fields=status,profile:(firstName,city)", + "summary": "List all users with API projections", + "value": [ + { + "id": "00u1xke1apZnmHgpB1d7", + "profile": { + "city": "Chicago", + "firstName": "Alice" + }, + "status": "ACTIVE" + }, + { + "id": "00u269cmneNMFHCH51d7", + "profile": { + "ListUsersResponse": null, + "city": "New York", + "firstName": "Bob" + }, + "status": "ACTIVE" + } + ] + }, + "ListUsersFilterResponse": { + "description": "Filtered response with filter=status+eq%22LOCKED_OUT%22", + "summary": "List all users with a filter", + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u3m5wrdPjJYUFb81d6" + } + }, + "activated": "2020-10-22T15:15:30.000Z", + "created": "2020-10-22T15:15:30.000Z", + "credentials": { + "emails": [ + { + "status": "VERIFIED", + "type": "PRIMARY", + "value": "johntest@example.com" + } + ], + "password": {}, + "provider": { + "name": "IMPORT", + "type": "IMPORT" + } + }, + "id": "00u3m5wrdPjJYUFb81d6", + "lastLogin": null, + "lastUpdated": "2020-10-22T16:09:13.000Z", + "passwordChanged": "2020-10-22T15:15:30.000Z", + "profile": { + "email": "johnrichards@example.com", + "firstName": "John", + "lastName": "Richards", + "login": "johnrichards@example.com", + "mobilePhone": null, + "secondEmail": null + }, + "status": "LOCKED_OUT", + "statusChanged": "2020-10-22T16:09:13.000Z", + "type": { + "id": "oty2di92xFgQTiKEJ1d6" + } + } + ] + }, + "ListUsersQResponse": { + "description": "Response for query q=john", + "summary": "Find a user (q)", + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u3ojhmm3cCa3a221d7" + } + }, + "activated": "2022-05-13T20:05:41.000Z", + "created": "2022-05-13T20:05:39.000Z", + "credentials": { + "emails": [ + { + "status": "VERIFIED", + "type": "PRIMARY", + "value": "tony.johnson@example.com" + } + ], + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00u3ojhmm3cCa3a221d7", + "lastLogin": null, + "lastUpdated": "2022-05-13T20:05:41.000Z", + "passwordChanged": "2022-05-13T20:05:41.000Z", + "profile": { + "email": "tony.johnson@example.com", + "firstName": "Tony", + "lastName": "Johnson", + "login": "tony.johnson@example.com", + "mobilePhone": null, + "secondEmail": null + }, + "status": "ACTIVE", + "statusChanged": "2022-05-13T20:05:41.000Z", + "type": { + "id": "oty2di92xFgQTiKEJ1d6" + } + }, + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u3m5wrdPjJYUFb81d6" + } + }, + "activated": "2020-10-22T15:15:30.000Z", + "created": "2020-10-22T15:15:30.000Z", + "credentials": { + "emails": [ + { + "status": "VERIFIED", + "type": "PRIMARY", + "value": "johnmclean@example.com" + } + ], + "password": {}, + "provider": { + "name": "IMPORT", + "type": "IMPORT" + } + }, + "id": "00u3m5wrdPjJYUFb81d6", + "lastLogin": null, + "lastUpdated": "2020-10-22T16:09:13.000Z", + "passwordChanged": "2020-10-22T15:15:30.000Z", + "profile": { + "email": "johnmclean@example.com", + "firstName": "John", + "lastName": "Mclean", + "login": "johnmclean@example.com", + "mobilePhone": null, + "secondEmail": null + }, + "status": "LOCKED_OUT", + "statusChanged": "2020-10-22T16:09:13.000Z", + "type": { + "id": "oty2di92xFgQTiKEJ1d6" + } + }, + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u3ojdzgjrAhuYGg1d7" + } + }, + "activated": "2022-05-13T20:06:22.000Z", + "created": "2022-05-13T20:06:20.000Z", + "credentials": { + "emails": [ + { + "status": "VERIFIED", + "type": "PRIMARY", + "value": "john.j.phillips@example.com" + } + ], + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00u3ojdzgjrAhuYGg1d7", + "lastLogin": null, + "lastUpdated": "2022-05-13T20:06:22.000Z", + "passwordChanged": "2022-05-13T20:06:21.000Z", + "profile": { + "email": "john.j.phillips@example.com", + "firstName": "Jack", + "lastName": "Phillips", + "login": "john.j.phillips@example.com", + "mobilePhone": null, + "secondEmail": null + }, + "status": "ACTIVE", + "statusChanged": "2022-05-13T20:06:22.000Z", + "type": { + "id": "oty2di92xFgQTiKEJ1d6" + } + } + ] + }, + "ListUsersResponse": { + "summary": "List all users", + "value": [ + { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4" + } + }, + "activated": null, + "created": "2022-04-04T15:56:05.000Z", + "credentials": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00u118oQYT4TBTemp0g4", + "lastLogin": "2022-05-04T19:50:52.000Z", + "lastUpdated": "2022-05-05T18:15:44.000Z", + "passwordChanged": "2022-04-04T16:00:22.000Z", + "profile": { + "email": "alice.smith@example.com", + "firstName": "Alice", + "lastName": "Smith", + "login": "alice.smith@example.com", + "mobilePhone": null, + "secondEmail": null + }, + "status": "ACTIVE", + "statusChanged": null, + "type": { + "id": "oty1162QAr8hJjTaq0g4" + } + } + ] + }, + "ListUsersSearchResponse": { + "description": "Response for search=profile.department%20eq%20%22Engineering%22", + "summary": "List all users with search", + "value": [ + { + "activated": null, + "created": "2021-11-17T16:11:16.000Z", + "id": "00u1xke1apZnmHgpB1d7", + "lastLogin": null, + "lastUpdated": "2022-05-24T15:39:09.000Z", + "passwordChanged": null, + "profile": { + "department": "Engineering", + "email": "ben.richler@example.com", + "firstName": "Ben", + "lastName": "Richler", + "login": "ben.richler@example.com", + "mobilePhone": null, + "secondEmail": "" + }, + "status": "STAGED", + "statusChanged": null, + "type": { + "id": "oty2di92xFgQTiKEJ1d6" + } + }, + { + "activated": null, + "created": "2021-12-17T15:16:55.000Z", + "id": "00u269cmneNMFHCH51d7", + "lastLogin": null, + "lastUpdated": "2022-05-24T15:38:04.000Z", + "passwordChanged": "2021-12-17T15:16:56.000Z", + "profile": { + "department": "Engineering", + "email": "janice.benson@gmail.com", + "firstName": "Janice", + "lastName": "Benson", + "login": "janice.benson@gmail.com", + "mobilePhone": null, + "secondEmail": null + }, + "status": "PROVISIONED", + "statusChanged": null, + "type": { + "id": "oty2di92xFgQTiKEJ1d6" + } + } + ] + }, + "ListYubikeyOptTokensResponse": { + "summary": "List YubiKey OTP token response", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/factors/yubikey_token/tokens/ykkwcx13nrDq8g4oy0g3" + } + }, + "created": "2020-01-14T21:53:09.000Z", + "id": "ykkwcx13nrDq8g4oy0g3", + "lastUpdated": "2020-01-14T21:53:09.000Z", + "lastVerified": "2020-01-14T21:53:06.000Z", + "profile": { + "serial": "000003632071" + }, + "status": "UNASSIGNED" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00uu0x8sxTr9HcHOo0g3/factors/ykfxduQAhl89YyPrV0g3" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/factors/yubikey_token/tokens/ykkxdtCA1fKVxyu6R0g3" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00uu0x8sxTr9HcHOo0g3" + } + }, + "activated": "2020-06-09T23:47:29.000Z", + "created": "2020-06-09T23:42:05.000Z", + "id": "ykkxdtCA1fKVxyu6R0g3", + "lastUpdated": "2020-06-09T23:47:29.000Z", + "lastVerified": "2020-06-09T23:47:29.000Z", + "profile": { + "serial": "000009508427" + }, + "status": "ACTIVE" + } + ] + }, + "ListsAllUserTypes": { + "summary": "Lists all user types", + "value": [ + { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + } + }, + "created": "2021-07-05T20:40:38.000Z", + "createdBy": "sprz9fj1ycBcsgopy1d6", + "default": false, + "description": "A new custom user type", + "displayName": "New user type", + "id": "otyfnly5cQjJT9PnR0g4", + "lastUpdated": "2021-07-05T20:40:38.000Z", + "lastUpdatedBy": "sprz9fj1ycBcsgopy1d6", + "name": "newUserType" + }, + { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + } + }, + "created": "2021-07-05T20:40:38.000Z", + "createdBy": "sprz9fj1ycBcsgopy1d6", + "default": true, + "description": "Okta user profile template with default permission settings", + "displayName": "User", + "id": "otyz9fj2jMiRBC1ZT1d6", + "lastUpdated": "2021-07-05T20:40:38.000Z", + "lastUpdatedBy": "sprz9fj1ycBcsgopy1d6", + "name": "user" + } + ] + }, + "ListsOwnerOneResponse": { + "summary": "Lists a response with one owner", + "value": [ + { + "displayName": "Product & Engineering", + "id": "00g1gae1k0znUcLuU0h8", + "lastUpdated": "2023-03-29 18:18:37.0", + "originId": "null", + "originType": "OKTA_DIRECTORY", + "resolved": true, + "type": "GROUP" + } + ] + }, + "ListsOwnersMultipleResponse": { + "summary": "Lists a response with multiple owners", + "value": [ + { + "displayName": "Mabel Mora", + "id": "00u1cmbqjkkmFXeqb0h8", + "lastUpdated": "2023-03-29T18:30:58.000Z", + "originId": "null", + "originType": "OKTA_DIRECTORY", + "resolved": true, + "type": "USER" + }, + { + "displayName": "Cinda Canning", + "id": "00u1cmc52x5B86cnZ0h8", + "lastUpdated": "2023-03-29T18:30:55.000Z", + "originId": "null", + "originType": "OKTA_DIRECTORY", + "resolved": true, + "type": "USER" + } + ] + }, + "LogStreamActivateResponse": { + "summary": "Activate log stream response", + "value": { + "_links": { + "deactivate": { + "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate", + "method": "POST" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4", + "method": "GET" + } + }, + "created": "2023-03-24T21:02:43.000Z", + "id": "0oa1orqUGCIoCGNxf0g4", + "lastUpdated": "2023-03-24T21:22:43.000Z", + "name": "Example AWS EventBridge", + "settings": { + "accountId": "123456789012", + "eventSourceName": "your-event-source-name", + "region": "us-east-2" + }, + "status": "ACTIVE", + "type": "aws_eventbridge" + } + }, + "LogStreamDeactivateResponse": { + "summary": "Deactivate log stream response", + "value": { + "_links": { + "activate": { + "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa7agphh5FT7H521d7/lifecycle/activate", + "method": "POST" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa7agphh5FT7H521d7", + "method": "GET" + } + }, + "created": "2023-03-24T21:15:13.000Z", + "id": "0oa7agphh5FT7H521d7", + "lastUpdated": "2023-03-24T21:23:00.000Z", + "name": "Splunk Cloud Example", + "settings": { + "edition": "aws", + "host": "okexample.splunkcloud.com" + }, + "status": "INACTIVE", + "type": "splunk_cloud_logstreaming" + } + }, + "LogStreamGetAllResponse": { + "summary": "Lists all log streams", + "value": [ + { + "_links": { + "deactivate": { + "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate", + "method": "POST" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4", + "method": "GET" + } + }, + "created": "2023-03-24T21:02:43.000Z", + "id": "0oa1orqUGCIoCGNxf0g4", + "lastUpdated": "2023-03-24T21:02:43.000Z", + "name": "Example AWS EventBridge", + "settings": { + "accountId": "123456789012", + "eventSourceName": "your-event-source-name", + "region": "us-east-2" + }, + "status": "ACTIVE", + "type": "aws_eventbridge" + } + ] + }, + "LogStreamPostRequest": { + "summary": "Create an AWS EventBridge log stream", + "value": { + "name": "Example AWS EventBridge", + "settings": { + "accountId": "123456789012", + "eventSourceName": "your-event-source-name", + "region": "us-east-2" + }, + "type": "aws_eventbridge" + } + }, + "LogStreamPostResponse": { + "summary": "AWS EventBridge log stream response", + "value": { + "_links": { + "deactivate": { + "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate", + "method": "POST" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4", + "method": "GET" + } + }, + "created": "2023-03-24T21:02:43.000Z", + "id": "0oa1orqUGCIoCGNxf0g4", + "lastUpdated": "2023-03-24T21:02:43.000Z", + "name": "Example AWS EventBridge", + "settings": { + "accountId": "123456789012", + "eventSourceName": "your-event-source-name", + "region": "us-east-2" + }, + "status": "ACTIVE", + "type": "aws_eventbridge" + } + }, + "LogStreamPutRequest": { + "summary": "Replace AWS EventBridge name", + "value": { + "name": "Updated AWS EventBridge", + "settings": { + "accountId": "123456789012", + "eventSourceName": "your-event-source-name", + "region": "us-east-2" + }, + "type": "aws_eventbridge" + } + }, + "LogStreamPutResponse": { + "summary": "Replace AWS EventBridge name response", + "value": { + "_links": { + "deactivate": { + "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate", + "method": "POST" + }, + "self": { + "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4", + "method": "GET" + } + }, + "created": "2023-03-24T21:02:43.000Z", + "id": "0oa1orqUGCIoCGNxf0g4", + "lastUpdated": "2023-03-24T21:12:43.000Z", + "name": "Updated AWS EventBridge", + "settings": { + "accountId": "123456789012", + "eventSourceName": "your-event-source-name", + "region": "us-east-2" + }, + "status": "ACTIVE", + "type": "aws_eventbridge" + } + }, + "LogStreamSchemaAws": { + "value": { + "$id": "http://{yourOktaDomain}/api/v1/meta/schemas/logStream/aws_eventbridge", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "errorMessage": { + "properties": { + "name": "Name can't exceed 100 characters." + } + }, + "properties": { + "name": { + "description": "A name for this log stream in Okta", + "pattern": "^.{1,100}$", + "title": "Name", + "type": "string", + "writeOnce": false + }, + "settings": { + "description": "Configuration properties specific to AWS EventBridge", + "errorMessage": { + "properties": { + "accountId": "Account number must be 12 digits.", + "eventSourceName": "Event source name can use numbers, letters, the symbols \".\", \"-\" or \"_\". It must use fewer than 76 characters." + } + }, + "properties": { + "accountId": { + "description": "Your Amazon AWS Account ID.", + "pattern": "^\\d{12}$", + "title": "AWS Account ID", + "type": "string", + "writeOnce": true + }, + "eventSourceName": { + "description": "An alphanumeric name (no spaces) to identify this event source in AWS EventBridge.", + "pattern": "^[\\.\\-_A-Za-z0-9]{1,75}$", + "title": "AWS Event Source Name", + "type": "string", + "writeOnce": true + }, + "region": { + "description": "The destination AWS region for your system log events.", + "oneOf": [ + { + "const": "us-east-2", + "title": "US East (Ohio)" + }, + { + "const": "us-east-1", + "title": "US East (N. Virginia)" + }, + { + "const": "us-west-1", + "title": "US West (N. California)" + }, + { + "const": "us-west-2", + "title": "US West (Oregon)" + }, + { + "const": "ca-central-1", + "title": "Canada (Central)" + }, + { + "const": "eu-central-1", + "title": "Europe (Frankfurt)" + }, + { + "const": "eu-west-1", + "title": "Europe (Ireland)" + }, + { + "const": "eu-west-2", + "title": "Europe (London)" + }, + { + "const": "eu-west-3", + "title": "Europe (Paris)" + }, + { + "const": "eu-south-1", + "title": "Europe (Milan)" + }, + { + "const": "eu-north-1", + "title": "Europe (Stockholm)" + } + ], + "title": "AWS Region", + "type": "string", + "writeOnce": true + } + }, + "required": [ + "eventSourceName", + "accountId", + "region" + ], + "type": "object" + } + }, + "required": [ + "name", + "settings" + ], + "title": "AWS EventBridge", + "type": "object" + } + }, + "LogStreamSchemaList": { + "value": [ + { + "$id": "http://{yourOktaDomain}/api/v1/meta/schemas/logStream/aws_eventbridge", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "errorMessage": { + "properties": { + "name": "Name can't exceed 100 characters." + } + }, + "properties": { + "name": { + "description": "A name for this log stream in Okta", + "pattern": "^.{1,100}$", + "title": "Name", + "type": "string", + "writeOnce": false + }, + "settings": { + "description": "Configuration properties specific to AWS EventBridge", + "errorMessage": { + "properties": { + "accountId": "Account number must be 12 digits.", + "eventSourceName": "Event source name can use numbers, letters, the symbols \".\", \"-\" or \"_\". It must use fewer than 76 characters." + } + }, + "properties": { + "accountId": { + "description": "Your Amazon AWS Account ID.", + "pattern": "^\\d{12}$", + "title": "AWS Account ID", + "type": "string", + "writeOnce": true + }, + "eventSourceName": { + "description": "An alphanumeric name (no spaces) to identify this event source in AWS EventBridge.", + "pattern": "^[\\.\\-_A-Za-z0-9]{1,75}$", + "title": "AWS Event Source Name", + "type": "string", + "writeOnce": true + }, + "region": { + "description": "The destination AWS region for your system log events.", + "oneOf": [ + { + "const": "us-east-2", + "title": "US East (Ohio)" + }, + { + "const": "us-east-1", + "title": "US East (N. Virginia)" + }, + { + "const": "us-west-1", + "title": "US West (N. California)" + }, + { + "const": "us-west-2", + "title": "US West (Oregon)" + }, + { + "const": "ca-central-1", + "title": "Canada (Central)" + }, + { + "const": "eu-central-1", + "title": "Europe (Frankfurt)" + }, + { + "const": "eu-west-1", + "title": "Europe (Ireland)" + }, + { + "const": "eu-west-2", + "title": "Europe (London)" + }, + { + "const": "eu-west-3", + "title": "Europe (Paris)" + }, + { + "const": "eu-south-1", + "title": "Europe (Milan)" + }, + { + "const": "eu-north-1", + "title": "Europe (Stockholm)" + } + ], + "title": "AWS Region", + "type": "string", + "writeOnce": true + } + }, + "required": [ + "eventSourceName", + "accountId", + "region" + ], + "type": "object" + } + }, + "required": [ + "name", + "settings" + ], + "title": "AWS EventBridge", + "type": "object" + }, + { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "errorMessage": { + "properties": { + "name": "Name can't exceed 100 characters." + } + }, + "id": "http://{yourOktaDomain}/api/v1/meta/schemas/logStream/splunk_cloud_logstreaming", + "properties": { + "name": { + "description": "A name for this log stream in Okta", + "pattern": "^.{1,100}$", + "title": "Name", + "type": "string", + "writeOnce": false + }, + "settings": { + "description": "Configuration properties specific to Splunk Cloud", + "errorMessage": { + "properties": { + "host": "Host should be a domain without http or https. For example: acme.splunkcloud.com" + } + }, + "properties": { + "host": { + "description": "The domain for your Splunk Cloud instance without http or https. For example: acme.splunkcloud.com", + "pattern": "^([a-z0-9]+(-[a-z0-9]+)*){1,100}\\.splunkcloud(gc|fed)?\\.com$", + "title": "Host", + "type": "string", + "writeOnce": false + }, + "token": { + "description": "The token from your Splunk Cloud HTTP Event Collector (HEC).", + "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", + "title": "HEC Token", + "type": "string", + "writeOnce": false + } + }, + "required": [ + "host", + "token" + ], + "type": "object" + } + }, + "required": [ + "name", + "settings" + ], + "title": "Splunk Cloud", + "type": "object" + } + ] + }, + "LogStreamSchemaSplunk": { + "value": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "errorMessage": { + "properties": { + "name": "Name can't exceed 100 characters." + } + }, + "id": "http://{yourOktaDomain}/api/v1/meta/schemas/logStream/splunk_cloud_logstreaming", + "properties": { + "name": { + "description": "A name for this log stream in Okta", + "pattern": "^.{1,100}$", + "title": "Name", + "type": "string", + "writeOnce": false + }, + "settings": { + "description": "Configuration properties specific to Splunk Cloud", + "errorMessage": { + "properties": { + "host": "Host should be a domain without http or https. For example: acme.splunkcloud.com" + } + }, + "properties": { + "host": { + "description": "The domain for your Splunk Cloud instance without http or https. For example: acme.splunkcloud.com", + "pattern": "^([a-z0-9]+(-[a-z0-9]+)*){1,100}\\.splunkcloud(gc|fed)?\\.com$", + "title": "Host", + "type": "string", + "writeOnce": false + }, + "token": { + "description": "The token from your Splunk Cloud HTTP Event Collector (HEC).", + "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", + "title": "HEC Token", + "type": "string", + "writeOnce": false + } + }, + "required": [ + "host", + "token" + ], + "type": "object" + } + }, + "required": [ + "name", + "settings" + ], + "title": "Splunk Cloud", + "type": "object" + } + }, + "LogTargetChangeDetails": { + "summary": "Example of the `changeDetails` property on the target", + "value": { + "from": { + "vpnLocationOptions": "DISABLED", + "vpnSettingsZones": { + "exclude": null, + "include": null + } + }, + "to": { + "message": "You must a use VPN to connect to this application", + "vpnLocationOptions": "ZONE", + "vpnSettingsZones": { + "exclude": null, + "include": [ + "ALL_ZONES" + ] + } + } + } + }, + "MacOSOSAccountListResponse": { + "summary": "List of macOS accounts", + "value": [ + { + "_embedded": { + "accountLinkedEnrollments": [ + { + "_embedded": { + "lastAuthenticatedOn": "2026-04-09T17:22:56.000Z" + }, + "created": "2026-01-19T17:22:30.000Z", + "id": "ukp1fxtdiJkUQiX220g5", + "lastUpdated": "2026-01-19T17:22:30.000Z", + "profile": { + "authenticationMethod": "PASSWORD" + }, + "status": "ACTIVE", + "type": "platform_sso" + } + ], + "users": [ + { + "id": "00u1fxs5JcdX9jsfc0g5", + "profile": { + "email": "carmel.sonne@okta.com", + "firstName": "Carmel", + "lastName": "Sonne", + "login": "carmel.sonne@okta.com" + }, + "status": "ACTIVE" + } + ] + }, + "_links": { + "device": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4/os-accounts/dao3qgkIEKjhNZudR0g4" + } + }, + "created": "2026-01-19T17:22:30.000Z", + "deviceId": "guo4a5u7JHHhjXrMK0g4", + "id": "dao3qgkIEKjhNZudR0g4", + "lastSeenAt": "2026-04-09T17:22:56.000Z", + "lastUpdated": "2026-01-19T17:22:30.000Z", + "platform": "MACOS", + "profile": { + "accountUuid": "4ac29c85-d847-4492-96cb-46e337170c33", + "fullName": "Carmel Sonne", + "type": "MACOS", + "username": "carmel.sonne" + }, + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "Carmel Sonne" + }, + "resourceId": "dao3qgkIEKjhNZudR0g4", + "resourceType": "DOSAccount", + "status": "ACTIVE" + } + ] + }, + "MacOSOSAccountResponse": { + "summary": "macOS account", + "value": { + "_embedded": { + "accountLinkedEnrollments": [ + { + "_embedded": { + "lastAuthenticatedOn": "2026-04-09T17:22:56.000Z" + }, + "created": "2026-01-19T17:22:30.000Z", + "id": "ukp1fxtdiJkUQiX220g5", + "lastUpdated": "2026-01-19T17:22:30.000Z", + "profile": { + "authenticationMethod": "PASSWORD" + }, + "status": "ACTIVE", + "type": "platform_sso" + } + ], + "users": [ + { + "id": "00u1fxs5JcdX9jsfc0g5", + "profile": { + "email": "carmel.sonne@okta.com", + "firstName": "Carmel", + "lastName": "Sonne", + "login": "carmel.sonne@okta.com" + }, + "status": "ACTIVE" + } + ] + }, + "_links": { + "device": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4/os-accounts/dao3qgkIEKjhNZudR0g4" + } + }, + "created": "2026-01-19T17:22:30.000Z", + "deviceId": "guo4a5u7JHHhjXrMK0g4", + "id": "dao3qgkIEKjhNZudR0g4", + "lastSeenAt": "2026-04-09T17:22:56.000Z", + "lastUpdated": "2026-01-19T17:22:30.000Z", + "platform": "MACOS", + "profile": { + "accountUuid": "4ac29c85-d847-4492-96cb-46e337170c33", + "fullName": "Carmel Sonne", + "type": "MACOS", + "username": "carmel.sonne" + }, + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "Carmel Sonne" + }, + "resourceId": "dao3qgkIEKjhNZudR0g4", + "resourceType": "DOSAccount", + "status": "ACTIVE" + } + }, + "MembershipPayload": { + "value": { + "memberExternalId": "USEREXT123456784C2IFA" + } + }, + "MicrosoftIdPResponse": { + "summary": "Microsoft IdP", + "value": { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oajmvdFawBih4gey0g3&\n client_id={clientId}&response_type={responseType}&response_mode={responseMode}&\n scope={scopes}&redirect_uri={redirectUri}&state={state}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2016-03-29T16:47:36.000Z", + "id": "0oajmvdFawBih4gey0g3", + "lastUpdated": "2016-03-29T16:47:36.000Z", + "name": "Microsoft", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://login.microsoftonline.com/common/oauth2/v2.0/token" + } + }, + "scopes": [ + "openid", + "email", + "profile", + "https://graph.microsoft.com/User.Read" + ], + "type": "OIDC" + }, + "status": "ACTIVE", + "type": "MICROSOFT" + } + }, + "MultipleIdPCsrsResponse": { + "summary": "IdP CSRs", + "value": [ + { + "_links": { + "publish": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50/lifecycle/publish" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50" + } + }, + "created": "2017-03-28T01:11:10.000Z", + "csr": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9/tKvvbFN59T4raoCs/78KRm4fSefHQOv1TKLXo4wTLbsqYWRWc5u0sd5orUMQgPQOyj3i6qh13mALY4BzrT057EG1BUNjGg29QgYlnOk2iX890e5BIDMQQEIKFrvOi2V8cLUkLvE2ydRn0VO1Q1frbUkYeStJYC5Api2JQsYRwa+1ZeDH1ITnIzUaugWhW2WB2lSnwZkenne5KtffxMPYVu+IhNRHoKaRA6Z51YNhMJIx17JM2hs/H4Ka3drk6kzDf7ofk/yBpb9yBWyU7CTSQhdoHidxqFprMDaT66W928t3AeOENHBuwn8c2K9WeGG+bELNyQRJVmawIDAQABoCowKAYJKoZIhvcNAQkOMRswGTAXBgNVHREEEDAOggxkZXYub2t0YS5jb20wDQYJKoZIhvcNAQELBQADggEBAA2hsVJRVM+A83X9MekjTnIbt19UNT8wX7wlE9jUKirWsxceLiZBpVGn9qfKhhVIpvdaIRSeoFYS2Kg/m1G6bCvjmZLcrQ5FcEBjZH2NKfNppGVnfC2ugtUkBtCB+UUzOhKhRKJtGugenKbP33zRWWIqnd2waF6Cy8TIuqQVPbwEDN9bCbAs7ND6CFYNguY7KYjWzQOeAR716eqpEEXuPYAS4nx/ty4ylonR8cv+gpq51rvq80A4k/36aoeM0Y6I4w64vhTfuvWW2UYFUD+/+y2FA2CSP4JfctySrf1s525v6fzTFZ3qZbB5OZQtP2b8xYWktMzywsxGKDoVDB4wkH4=", + "id": "h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50", + "kty": "RSA" + }, + { + "_links": { + "publish": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/-_-BFwAGoUYN-DDvsSKQFdx7OXaPZqrEPpFDO1hu-rg/lifecycle/publish" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/-_-BFwAGoUYN-DDvsSKQFdx7OXaPZqrEPpFDO1hu-rg" + } + }, + "created": "2017-03-28T01:21:10.000Z", + "csr": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9/tKvvbFN59T4raoCs/78KRm4fSefHQOv1TKLXo4wTLbsqYWRWc5u0sd5orUMQgPQOyj3i6qh13mALY4BzrT057EG1BUNjGg29QgYlnOk2iX890e5BIDMQQEIKFrvOi2V8cLUkLvE2ydRn0VO1Q1frbUkYeStJYC5Api2JQsYRwa+1ZeDH1ITnIzUaugWhW2WB2lSnwZkenne5KtffxMPYVu+IhNRHoKaRA6Z51YNhMJIx17JM2hs/H4Ka3drk6kzDf7ofk/yBpb9yBWyU7CTSQhdoHidxqFprMDaT66W928t3AeOENHBuwn8c2K9WeGG+bELNyQRJVmawIDAQABoCowKAYJKoZIhvcNAQkOMRswGTAXBgNVHREEEDAOggxkZXYub2t0YS5jb20wDQYJKoZIhvcNAQELBQADggEBAA2hsVJRVM+A83X9MekjTnIbt19UNT8wX7wlE9jUKirWsxceLiZBpVGn9qfKhhVIpvdaIRSeoFYS2Kg/m1G6bCvjmZLcrQ5FcEBjZH2NKfNppGVnfC2ugtUkBtCB+UUzOhKhRKJtGugenKbP33zRWWIqnd2waF6Cy8TIuqQVPbwEDN9bCbAs7ND6CFYNguY7KYjWzQOeAR716eqpEEXuPYAS4nx/ty4ylonR8cv+gpq51rvq80A4k/36aoeM0Y6I4w64vhTfuvWW2UYFUD+/+y2FA2CSP4JfctySrf1s525v6fzTFZ3qZbB5OZQtP2b8xYWktMzywsxGKDoVDB4wkH4=", + "id": "-_-BFwAGoUYN-DDvsSKQFdx7OXaPZqrEPpFDO1hu-rg", + "kty": "RSA" + } + ] + }, + "MultipleIdPKeyCredentialsResponse": { + "summary": "IdP key credentials", + "value": [ + { + "created": "2016-01-03T18:15:47.000Z", + "e": "65537", + "kid": "your-key-id", + "kty": "RSA", + "lastUpdated": "2016-01-03T18:15:47.000Z", + "n": "101438407598598116085679865987760095721749307901605456708912786847324207000576780508113360584555007890315805735307890113536927352312915634368993759211767770602174860126854831344273970871509573365292777620005537635317282520456901584213746937262823585533063042033441296629204165064680610660631365266976782082747", + "use": "sig", + "x5c": [ + "MIIDnjCCAoagAwIBAgIGAVG3MN+PMA0GCSqGSIb3DQEBBQUAMIGPMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEDAOBgNVBAMMB2V4YW1wbGUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMTUxMjE4MjIyMjMyWhcNMjUxMjE4MjIyMzMyWjCBjzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRAwDgYDVQQDDAdleGFtcGxlMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtcnyvuVCrsFEKCwHDenS3Ocjed8eWDv3zLtD2K/iZfE8BMj2wpTfn6Ry8zCYey3mWlKdxIybnV9amrujGRnE0ab6Q16v9D6RlFQLOG6dwqoRKuZy33Uyg8PGdEudZjGbWuKCqqXEp+UKALJHV+k4wWeVH8g5d1n3KyR2TVajVJpCrPhLFmq1Il4G/IUnPe4MvjXqB6CpKkog1+ThWsItPRJPAM+RweFHXq7KfChXsYE7Mmfuly8sDQlvBmQyxZnFHVuiPfCvGHJjpvHy11YlHdOjfgqHRvZbmo30+y0X/oY/yV4YEJ00LL6eJWU4wi7ViY3HP6/VCdRjHoRdr5L/DwIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCzzhOFkvyYLNFj2WDcq1YqD4sBy1iCia9QpRH3rjQvMKDwQDYWbi6EdOX0TQ/IYR7UWGj+2pXd6v0t33lYtoKocp/4lUvT3tfBnWZ5KnObi+J2uY2teUqoYkASN7F+GRPVOuMVoVgm05ss8tuMb2dLc9vsx93sDt+XlMTv/2qi5VPwaDtqduKkzwW9lUfn4xIMkTiVvCpe0X2HneD2Bpuao3/U8Rk0uiPfq6TooWaoW3kjsmErhEAs9bA7xuqo1KKY9CdHcFhkSsMhoeaZylZHtzbnoipUlQKSLMdJQiiYZQ0bYL83/Ta9fulr1EERICMFt3GUmtYaZZKHpWSfdJp9" + ], + "x5t#S256": "wzPVobIrveR1x-PCbjsFGNV-6zn7Rm9KuOWOG4Rk6jE" + }, + { + "alg": "EC", + "created": "2020-04-24T20:51:20.000Z", + "crv": "P-521", + "expiresAt": "2040-03-01T20:22:29.000Z", + "kid": "your-kid", + "kty": "EC", + "lastUpdated": "2020-04-24T20:51:20.000Z", + "use": "sig", + "x": "Vv5Rh5de5ig7Qg-A-4HDGGDloMlkxp6PDE3nwzgAQPD3XXrLE7G364LhePRpYupQs62WgCoYb4CDXN0erf3WJXg", + "x5c": [ + "MIICqDCCAgqgAwIBAgIJAOkmCa/S8dHiMAoGCCqGSM49BAMCMG0xCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMRAwDgYDVQQKDAdKYW5reUNvMR8wHQYDVQQDDBZUZXN0IElkZW50aXR5IFByb3ZpZGVyMB4XDTIwMDMwNjIwMjIyOVoXDTQwMDMwMTIwMjIyOVowbTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEDAOBgNVBAoMB0phbmt5Q28xHzAdBgNVBAMMFlRlc3QgSWRlbnRpdHkgUHJvdmlkZXIwgZswEAYHKoZIzj0CAQYFK4EEACMDgYYABABW/lGHl17mKDtCD4D7gcMYYOWgyWTGno8MTefDOABA8PddessTsbfrguF49Gli6lCzrZaAKhhvgINc3R6t/dYleAE3lY6LAocOoLe9xDkeggXNcSuP5fDc1x5R9GHTXl44vLoJOLSLsMbOXVMXIXoqbPDzTSYUy24aFdv4W4LZxW6ak6NQME4wHQYDVR0OBBYEFChTXNWvs4z1qjRVemPDD/hqlDQ4MB8GA1UdIwQYMBaAFChTXNWvs4z1qjRVemPDD/hqlDQ4MAwGA1UdEwQFMAMBAf8wCgYIKoZIzj0EAwIDgYsAMIGHAkIBuDhHMNLbBIsorbKtjxJzHJ2ItCSD2wAwqYv/6JBtA2ulKN5gRTSqdNCnqFsZ1/nYY7FFVXHEuQ2N3pPq7Ri8h84CQSgCq1UQyd0lFtb7+57JbiGb6LVaRqRm7vwx8zLRA+tVjIM1DlQ2Gbxkj3nlkzmM93j9wchiqGdQidyKnF6EBnfd" + ], + "x5t#S256": "TUx-AIwypm2pZURHNqafk7ZDxqQP_ypzIyUwDDnPOlw", + "y": "ATeVjosChw6gt73EOR6CBc1xK4_l8NzXHlH0YdNeXji8ugk4tIuwxs5dUxcheips8PNNJhTLbhoV2_hbgtnFbpqT" + } + ] + }, + "MultipleIdPSigningKeyCredentialsResponse": { + "summary": "IdP signing key credentials", + "value": [ + { + "created": "2015-12-10T18:56:23.000Z", + "expiresAt": "2017-12-10T18:56:22.000Z", + "kid": "akm5hvbbevE341ovl0h7", + "kty": "RSA", + "use": "sig", + "x5c": [ + "MIIDqDCCApCgAwIBAgIGAVGNQFX5MA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTAeFw0xNTEyMTAxODU1MjJaFw0xNzEyMTAxODU2MjJaMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJJjrcnI6cXBiXNq9YDgfYrQe2O5qEHG4MXP8Ue0sMeefFkFEHYHnHUeZCq6WTAGqR+1LFgOl+Eq9We5V+qNlGIfkFkQ3iHGBrIALKqLCd0Et76HicDiegz7j9DtN+lo0hG/gfcw5783L5g5xeQ7zVmCQMkFwoUA0uA3bsfUSrmfORHJL+EMNQT8XIXD8NkG4g6u7ylHVRTLgXbe+W/p04m3EP6l41xl+MhIpBaPxDsyUvcKCNwkZN3aZIin1O9Y4YJuDHxrM64/VtLLp0sC05iawAmfsLunF7rdJAkWUpPn+xkviyNQ3UpvwAYuDr+jKLUdh2reRnm1PezxMIXzBVMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEARnFIjyitrCGbleFr3KeAwdOyeHiRmgeKupX5ZopgXtcseJoToUIinX5DVw2fVZPahqs0Q7/a0wcVnTRpw6946qZCwKd/PvZ1feVuVEA5Ui3+XvHuSH5xLp7NvYG1snNEvlbN3+NDUMlWj2NEbihowUBt9+UxTpQO3+N08q3aZk3hOZ+tHt+1Te7KEEL/4CM28GZ9MY7fSrS7MAgp1+ZXtn+kRlMrXnQ49qBda37brwDRqmSY9PwNMbev3r+9ZHwxr9W5wXW4Ev4C4xngA7RkVoyDbItSUho0I0M0u/LHuppclnXrw97xyO5Z883eIBvPVjfRcxsJxXJ8jx70ATDskw==" + ], + "x5t#S256": "5GOpy9CQVtfvBmu2T8BHvpKE4OGtC3BuS046t7p9pps" + }, + { + "created": "2015-12-10T18:55:35.000Z", + "expiresAt": "2045-01-23T02:15:23.000Z", + "kid": "akm5hvbn1vojA9Fsa0h7", + "kty": "RSA", + "use": "sig", + "x5c": [ + "MIIDqDCCApCgAwIBAgIGAVGNQFX5MA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTAeFw0xNTEyMTAxODU1MjJaFw0xNzEyMTAxODU2MjJaMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJJjrcnI6cXBiXNq9YDgfYrQe2O5qEHG4MXP8Ue0sMeefFkFEHYHnHUeZCq6WTAGqR+1LFgOl+Eq9We5V+qNlGIfkFkQ3iHGBrIALKqLCd0Et76HicDiegz7j9DtN+lo0hG/gfcw5783L5g5xeQ7zVmCQMkFwoUA0uA3bsfUSrmfORHJL+EMNQT8XIXD8NkG4g6u7ylHVRTLgXbe+W/p04m3EP6l41xl+MhIpBaPxDsyUvcKCNwkZN3aZIin1O9Y4YJuDHxrM64/VtLLp0sC05iawAmfsLunF7rdJAkWUpPn+xkviyNQ3UpvwAYuDr+jKLUdh2reRnm1PezxMIXzBVMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEARnFIjyitrCGbleFr3KeAwdOyeHiRmgeKupX5ZopgXtcseJoToUIinX5DVw2fVZPahqs0Q7/a0wcVnTRpw6946qZCwKd/PvZ1feVuVEA5Ui3+XvHuSH5xLp7NvYG1snNEvlbN3+NDUMlWj2NEbihowUBt9+UxTpQO3+N08q3aZk3hOZ+tHt+1Te7KEEL/4CM28GZ9MY7fSrS7MAgp1+ZXtn+kRlMrXnQ49qBda37brwDRqmSY9PwNMbev3r+9ZHwxr9W5wXW4Ev4C4xngA7RkVoyDbItSUho0I0M0u/LHuppclnXrw97xyO5Z883eIBvPVjfRcxsJxXJ8jx70ATDskw==" + ], + "x5t#S256": "7CCyXWwKzH4P6PoBP91B1S_iIZVzuGffVnUXu-BTYQQ" + } + ] + }, + "MultipleIdPsResponse": { + "summary": "Multiple IdPs", + "value": [ + { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62b57p7c8PaGpU0h7&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2016-03-24T23:18:27.000Z", + "id": "0oa62b57p7c8PaGpU0h7", + "lastUpdated": "2016-03-24T23:18:27.000Z", + "name": "Facebook", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://www.facebook.com/dialog/oauth" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://graph.facebook.com/v2.5/oauth/access_token" + } + }, + "scopes": [ + "public_profile", + "email" + ], + "type": "OAUTH2" + }, + "status": "ACTIVE", + "type": "FACEBOOK" + }, + { + "_links": { + "acs": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/sso/saml2/0oa62bc8wppPw0UGr0h7", + "type": "application/xml" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/lifecycle/deactivate" + }, + "metadata": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/metadata.xml", + "type": "application/xml" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/users" + } + }, + "created": "2016-03-24T23:14:54.000Z", + "id": "0oa62bc8wppPw0UGr0h7", + "lastUpdated": "2016-03-24T23:14:54.000Z", + "name": "Example SAML IdP", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": "(\\S+@example\\.com)", + "matchType": "USERNAME", + "userNameTemplate": { + "template": "saml.subjectNameId" + } + }, + "trustClaims": false + }, + "protocol": { + "algorithms": { + "request": { + "signature": { + "algorithm": "SHA-256", + "scope": "REQUEST" + } + }, + "response": { + "signature": { + "algorithm": "SHA-256", + "scope": "ANY" + } + } + }, + "credentials": { + "trust": { + "additionalKids": [ + "additional-key-id" + ], + "audience": "http://www.okta.com/123", + "issuer": "https://idp.example.com", + "kid": "your-key-id" + } + }, + "endpoints": { + "acs": { + "binding": "HTTP-POST", + "type": "INSTANCE" + }, + "sso": { + "binding": "HTTP-POST", + "destination": "https://idp.example.com", + "url": "https://idp.example.com" + } + }, + "settings": { + "nameFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified" + }, + "type": "SAML2" + }, + "status": "ACTIVE", + "type": "SAML2" + }, + { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62bfdiumsUndnZ0h7&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2016-03-24T23:21:49.000Z", + "id": "0oa62bfdiumsUndnZ0h7", + "lastUpdated": "2016-03-24T23:21:49.000Z", + "name": "Google", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://accounts.google.com/o/oauth2/auth" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://www.googleapis.com/oauth2/v3/token" + } + }, + "scopes": [ + "profile", + "email", + "openid" + ], + "type": "OIDC" + }, + "status": "ACTIVE", + "type": "GOOGLE" + }, + { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62bfdjnK55Z5x80h7&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2016-03-24T23:23:59.000Z", + "id": "0oa62bfdjnK55Z5x80h7", + "lastUpdated": "2016-03-24T23:23:59.000Z", + "name": "LinkedIn", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://www.linkedin.com/uas/oauth2/authorization" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://www.linkedin.com/uas/oauth2/accessToken" + } + }, + "scopes": [ + "r_basicprofile", + "r_emailaddress" + ], + "type": "OAUTH2" + }, + "status": "ACTIVE", + "type": "LINKEDIN" + }, + { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oajmvdFawBih4gey0g3&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2016-03-29T16:47:36.000Z", + "id": "0oajmvdFawBih4gey0g3", + "lastUpdated": "2016-03-29T16:47:36.000Z", + "name": "Microsoft", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.userPrincipalName" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://login.microsoftonline.com/common/oauth2/v2.0/token" + } + }, + "scopes": [ + "openid", + "email", + "profile", + "https://graph.microsoft.com/User.Read" + ], + "type": "OIDC" + }, + "status": "ACTIVE", + "type": "MICROSOFT" + }, + { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oaulob4BFVa4zQvt0g3&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}&nonce={nonce}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" + } + }, + "created": "2019-02-07T20:07:47.000Z", + "id": "0oaulob4BFVa4zQvt0g3", + "lastUpdated": "2019-02-07T20:07:47.000Z", + "name": "Example OpenID Connect IdP", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.email" + } + }, + "trustClaims": false + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "client_secret": "your-client-secret" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/authorize" + }, + "jwks": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/keys" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://idp.example.com/token" + }, + "userInfo": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/userinfo" + } + }, + "issuer": { + "url": "https://idp.example.com" + }, + "scopes": [ + "openid" + ], + "type": "OIDC" + }, + "status": "ACTIVE", + "type": "OIDC" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}.okta.com/api/v1/idps/0oa6jxasyhwM2ZHJh0g4/lifecycle/deactivate" + }, + "keys": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}.okta.com/api/v1/idps/credentials/keys/45dec5ff-8cdc-48c0-85fe-a4869f1753dc" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}.okta.com/api/v1/idps/0oa6jxasyhwM2ZHJh0g4/users" + } + }, + "created": "2020-01-07T00:19:27.000Z", + "id": "0oa6jxasyhwM2ZHJh0g4", + "lastUpdated": "2020-01-07T00:19:27.000Z", + "name": "Smart Card IDP Name", + "policy": { + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "DISABLED", + "groups": null, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "EMAIL", + "userNameTemplate": { + "template": "idpuser.subjectAltNameEmail" + } + }, + "trustClaims": false + }, + "properties": { + "additionalAmr": [ + "sc", + "hwk", + "pin", + "mfa" + ] + }, + "protocol": { + "credentials": { + "trust": { + "audience": null, + "issuer": "CN=Test Smart Card, OU=Test OU, O=Test O, C=US", + "kid": "45dec5ff-8cdc-48c0-85fe-a4869f1753dc", + "revocation": "CRL", + "revocationCacheLifetime": 2880 + } + }, + "endpoints": { + "sso": { + "url": "https://{yourOktaDomain}.okta.com/login/cert" + } + }, + "type": "MTLS" + }, + "status": "ACTIVE", + "type": "X509" + } + ] + }, + "NextAuthorizationServerKey": { + "summary": "Next authorization server key", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo" + } + }, + "alg": "RS256", + "e": "AQAB", + "kid": "Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo", + "kty": "RSA", + "n": "l1hZ_g2sgBE3oHvu34T-5XP18FYJWgtul_nRNg-5xra5ySkaXEOJUDRERUG0HrR42uqf9jYrUTwg9fp-SqqNIdHRaN8EwRSDRsKAwK 3 HIJ2NJfgmrrO2ABkeyUq6rzHxAumiKv1iLFpSawSIiTEBJERtUCDcjbbqyHVFuivIFgH8L37 - XDIDb0XG - R8DOoOHLJPTpsgH - rJe M5w96VIRZInsGC5OGWkFdtgk6OkbvVd7_TXcxLCpWeg1vlbmX - 0 TmG5yjSj7ek05txcpxIqYu - 7 FIGT0KKvXge_BOSEUlJpBhLKU28 OtsOnmc3NLIGXB - GeDiUZiBYQdPR - myB4ZoQ", + "status": "NEXT", + "use": "sig" + } + }, + "NumberMatchingChallengeRequest": { + "value": { + "useNumberMatchingChallenge": true + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "NzErrorApiValidationFailed": { + "summary": "API Validation Failed", + "value": { + "errorCauses": [], + "errorCode": "E0000003", + "errorId": "samplewNxQUR9iohr4QYlD0eg", + "errorLink": "E0000003", + "errorSummary": "The request body was not well-formed." + } + }, + "NzErrorResourceNotFound": { + "summary": "Resource Not Found", + "value": { + "errorCauses": [], + "errorCode": "E0000007", + "errorId": "samplejCSVaKFDkCMElmKQ", + "errorLink": "E0000007", + "errorSummary": "Not found: Resource not found: itd (NetworkZone)" + } + }, + "OAuth2AuthSettings": { + "summary": "OAuth2 auth settings example", + "value": { + "authType": "OAUTH2", + "oAuth2Settings": { + "authorizeEndpoint": "https://example.com/oauth/authorize", + "clientId": "client123", + "clientSecret": "secret456", + "scopes": [ + "scope1", + "scope2" + ], + "tokenEndpoint": "https://example.com/oauth/token" + } + } + }, + "OAuth2RefreshTokenResponseEx": { + "summary": "OAuth 2.0 refresh token example", + "value": { + "_embedded": { + "scopes": [ + { + "_links": { + "scope": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scppb56cIl4GvGxy70g3", + "title": "offline_access" + } + }, + "description": "Requests a refresh token by default and is used to obtain more access tokens without re-prompting the user for authentication", + "id": "scppb56cIl4GvGxy70g3", + "name": "offline_access" + }, + { + "_links": { + "scope": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scp142iq2J8IGRUCS0g4", + "title": "Drive car" + } + }, + "description": "Allows the user to drive a car", + "displayName": "Drive car", + "id": "scp142iq2J8IGRUCS0g4", + "name": "car:drive" + } + ] + }, + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7", + "title": "Native" + }, + "authorizationServer": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7", + "title": "Example Authorization Server" + }, + "client": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oabskvc6442nkvQO0h7", + "title": "Example Client App" + }, + "revoke": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00upcgi9dyWEOeCwM0g3", + "title": "Saml Jackson" + } + }, + "clientId": "0oabskvc6442nkvQO0h7", + "created": "2023-03-09T03:18:06.000Z", + "expiresAt": "2023-03-16T03:18:06.000Z", + "id": "oar579Mcp7OUsNTlo0g3", + "issuer": "https://{yourOktaDomain}/oauth2/ausain6z9zIedDCxB0h7", + "lastUpdated": "2023-03-09T03:18:06.000Z", + "scopes": [ + "offline_access", + "car:drive" + ], + "status": "ACTIVE", + "userId": "00u5t60iloOHN9pBi0h7" + } + }, + "OAuth2RefreshTokenResponseListEx": { + "summary": "App refresh token list example", + "value": [ + { + "_embedded": { + "scopes": [ + { + "_links": { + "scope": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scppb56cIl4GvGxy70g3", + "title": "offline_access" + } + }, + "description": "Requests a refresh token by default and is used to obtain more access tokens without re-prompting the user for authentication", + "id": "scppb56cIl4GvGxy70g3", + "name": "offline_access" + }, + { + "_links": { + "scope": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scp142iq2J8IGRUCS0g4", + "title": "Drive car" + } + }, + "description": "Allows the user to drive a car", + "displayName": "Drive car", + "id": "scp142iq2J8IGRUCS0g4", + "name": "car:drive" + } + ] + }, + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7", + "title": "Native" + }, + "authorizationServer": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7", + "title": "Example Authorization Server" + }, + "client": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oabskvc6442nkvQO0h7", + "title": "Example Client App" + }, + "revoke": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00upcgi9dyWEOeCwM0g3", + "title": "Saml Jackson" + } + }, + "clientId": "0oabskvc6442nkvQO0h7", + "created": "2023-03-09T03:18:06.000Z", + "expiresAt": "2023-03-16T03:18:06.000Z", + "id": "oar579Mcp7OUsNTlo0g3", + "issuer": "https://{yourOktaDomain}/oauth2/ausain6z9zIedDCxB0h7", + "lastUpdated": "2023-03-09T03:18:06.000Z", + "scopes": [ + "offline_access", + "car:drive" + ], + "status": "ACTIVE", + "userId": "00u5t60iloOHN9pBi0h7" + } + ] + }, + "OAuth2ResourceServerJsonWebKey": { + "summary": "JSON Web Key example", + "value": { + "_links": { + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/resourceservercredentials/keys/RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc/lifecycle/delete" + } + }, + "alg": "RS256", + "created": "2023-04-06T21:32:33.000Z", + "e": "AQAB", + "id": "apk2f4zrZbs8nUa7p0g4", + "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", + "status": "INACTIVE", + "use": "enc" + } + }, + "OAuthClientCredentialsPatchRequest": { + "summary": "Update OAuth 2.0 client credentials server", + "value": { + "alias": "OAuthServer1 New Alias", + "authType": "OAUTH2_CLIENT_CREDENTIALS", + "clientSecret": "New client secret" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "OAuthClientCredentialsPatchResponse": { + "summary": "OAuth 2.0 client credentials server patch response", + "value": { + "alias": "OAuthServer1 New Alias", + "authType": "OAUTH2_CLIENT_CREDENTIALS", + "clientId": "oauth-client-id", + "enabled": false, + "host": "smtp.oauth.com", + "id": "ces7n3u7sSohfoaou0g2", + "port": 587, + "scopes": [ + "send_email" + ], + "tokenEndpoint": "https://oauth.example.com/token", + "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC", + "username": "user@oauth.com" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "OAuthClientCredentialsRequest": { + "summary": "Create OAuth client credentials server", + "value": { + "alias": "OAuthServer1", + "authType": "OAUTH2_CLIENT_CREDENTIALS", + "clientId": "oauth-client-id", + "clientSecret": "oauth-client-secret", + "enabled": false, + "host": "smtp.oauth.com", + "port": 587, + "scopes": [ + "send_email" + ], + "tokenEndpoint": "https://oauth.example.com/token", + "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC", + "username": "user@oauth.com" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "OAuthClientCredentialsResponse": { + "summary": "OAuth 2.0 client credentials server response", + "value": { + "alias": "OAuthServer1", + "authType": "OAUTH2_CLIENT_CREDENTIALS", + "clientId": "oauth-client-id", + "enabled": false, + "host": "smtp.oauth.com", + "id": "ces7n3u7sSohfoaou0g2", + "port": 587, + "scopes": [ + "send_email" + ], + "tokenEndpoint": "https://oauth.example.com/token", + "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC", + "username": "user@oauth.com" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "OAuthJWTPatchRequest": { + "summary": "Update OAuth 2.0 JWT bearer grant server", + "value": { + "alias": "OAuthServer2 New Alias", + "authType": "OAUTH2_JWT_BEARER_GRANT", + "keyId": "New keyId", + "privateKey": "-----BEGIN PRIVATE KEY-----\n... New Private Key Contents ...\n-----END PRIVATE KEY-----\n" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "OAuthJWTPatchResponse": { + "summary": "OAuth 2.0 JWT bearer grant server patch response", + "value": { + "alias": "OAuthServer2 New Alias", + "audience": "https://smtp.oauth.com", + "authType": "OAUTH2_JWT_BEARER_GRANT", + "clientId": "oauth-client-id", + "enabled": false, + "host": "smtp.oauth.com", + "id": "ces7n3u7sSohfoaou0g3", + "issuer": "https://oauth.example.com", + "port": 587, + "scopes": [ + "org.email.send" + ], + "signingAlgorithm": "RS256", + "subject": "user@oauth.com", + "username": "user@oauth.com" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "OAuthJWTRequest": { + "summary": "Create OAuth 2.0 JWT bearer grant server", + "value": { + "alias": "OAuthServer2", + "audience": "https://smtp.oauth.com", + "authType": "OAUTH2_JWT_BEARER_GRANT", + "clientId": "oauth-client-id", + "enabled": false, + "host": "smtp.oauth.com", + "issuer": "https://oauth.example.com", + "keyId": "oauth-key-id", + "port": 587, + "privateKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n", + "scopes": [ + "org.email.send" + ], + "signingAlgorithm": "RS256", + "subject": "user@oauth.com", + "tokenEndpoint": "https://oauth.example.com/token", + "username": "user@oauth.com" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "OAuthJWTResponse": { + "summary": "OAuth 2.0 JWT bearer grant server response", + "value": { + "alias": "OAuthServer2", + "audience": "https://smtp.oauth.com", + "authType": "OAUTH2_JWT_BEARER_GRANT", + "clientId": "oauth-client-id", + "enabled": false, + "host": "smtp.oauth.com", + "id": "ces7n3u7sSohfoaou0g3", + "issuer": "https://oauth.example.com", + "port": 587, + "scopes": [ + "org.email.send" + ], + "signingAlgorithm": "RS256", + "subject": "user@oauth.com", + "username": "user@oauth.com" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "OktaIntegrationIdpResponse": { + "summary": "Okta Integration IdP", + "value": { + "_links": { + "authorize": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://idp.example.com/oauth2/v1/authorize?idp=0oaulob4BFVa4zQvt0g3&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}&nonce={nonce}", + "templated": true + }, + "clientRedirectUri": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://idp.example.com/oauth2/v1/authorize/callback" + } + }, + "created": "2025-02-07T20:07:47.000Z", + "id": "0oazzok2vl5aeUH0B0g4", + "lastUpdated": "2025-02-07T20:07:47.000Z", + "name": "Example Okta Integration IdP", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": false + }, + "subject": { + "filter": "", + "matchAttribute": "", + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.email" + } + }, + "trustClaims": true + }, + "protocol": { + "credentials": { + "client": { + "client_id": "your-client-id", + "pkce_required": "true", + "token_endpoint_auth_method": "private_key_jwt" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/oauth2/v1/authorize" + }, + "jwks": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/oauth2/v1/keys" + }, + "token": { + "binding": "HTTP-POST", + "url": "https://idp.example.com/oauth2/v1/token" + }, + "userInfo": { + "binding": "HTTP-REDIRECT", + "url": "https://idp.example.com/oauth2/v1/userinfo" + } + }, + "issuer": { + "url": "https://idp.example.com" + }, + "scopes": [ + "openid", + "email", + "profile" + ], + "type": "OIDC" + }, + "status": "ACTIVE", + "type": "OKTA_INTEGRATION" + } + }, + "OktaManagedUserAccountResponse": { + "summary": "Okta managed user account response", + "value": { + "created": "2023-04-04T15:56:05.000Z", + "description": "Shared admin account for managing AD integrations", + "email": "shr-ad-admin-01@example.com", + "id": "d1b65a78-21ed-429b-8ea3-eec96f2748d6", + "lastUpdated": "2023-05-05T18:15:44.000Z", + "name": "AD Integrations Admin", + "oktaUserId": "00u11s48P9zGW8yqm0g5", + "ownerGroupIds": [ + "00g57qp78yZT2XBA40g7" + ], + "ownerUserIds": [ + "00u22t59Q0aHbNEXi1h8" + ], + "status": "UNSECURED", + "statusDetail": "STAGED", + "username": "shr-ad-admin-01@example.com" + } + }, + "OktaSupportCase": { + "summary": "Org Support case", + "value": { + "impersonation": { + "expiration": "2024-01-24T11:13:14.000Z", + "status": "ENABLED" + }, + "selfAssigned": { + "status": "NOT_REQUIRED" + } + } + }, + "OktaSupportCases": { + "summary": "Org Support cases", + "value": [ + { + "caseNumber": "1000001", + "impersonation": { + "expiration": "2024-01-24T11:13:14.000Z", + "status": "ENABLED" + }, + "selfAssigned": { + "status": "REQUESTED" + }, + "subject": "Reset admin password" + }, + { + "caseNumber": "1000002", + "impersonation": { + "expiration": null, + "status": "REQUESTED" + }, + "selfAssigned": { + "status": "NOT_REQUIRED" + }, + "subject": "Review IP restriction configuration" + } + ] + }, + "OpenidConnectEx": { + "summary": "OPENID_CONNECT", + "value": { + "credentials": { + "oauthClient": { + "token_endpoint_auth_method": "client_secret_post" + } + }, + "label": "Sample Client profile", + "name": "oidc_client", + "profile": { + "label": "oauth2 client app 1" + }, + "settings": { + "oauthClient": { + "application_type": "native", + "client_uri": "http://localhost:8080", + "grant_types": [ + "authorization_code" + ], + "logo_uri": "http://developer.okta.com/assets/images/logo-new.png", + "participate_slo": false, + "redirect_uris": [ + "https://example.com/oauth2/callback", + "myapp://callback" + ], + "response_types": [ + "token", + "id_token", + "code" + ] + } + }, + "signOnMode": "OPENID_CONNECT" + } + }, + "OpenidConnectPutEx": { + "summary": "OPENID_CONNECT", + "value": { + "label": "Sample Client profile updated", + "name": "oidc_client", + "signOnMode": "OPENID_CONNECT" + } + }, + "OpenidConnectPutResponseEx": { + "summary": "OPENID_CONNECT", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "oauthClient": { + "autoKeyRotation": true, + "client_id": "0oahonkqCRR6TSNlg4", + "client_secret": "wj9bOsLK0BRNJqy7KMMnaE7m8qrW51bPO2n1-PYvkOmhHRYgcuOecQkEwq9MPYa5", + "pkce_required": true, + "token_endpoint_auth_method": "client_secret_post" + }, + "signing": { + "kid": "H34mvc6VrfV5yvy5wA8ikMFws6WInx4nvsAs-7EYbVc" + }, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample Client profile updated", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "oidc_client", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:oidc_client:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": {}, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "oauthClient": { + "application_type": "native", + "client_uri": "http://localhost:8080", + "dpop_bound_access_tokens": false, + "grant_types": [ + "authorization_code" + ], + "idp_initiated_login": { + "default_scope": [], + "mode": "DISABLED" + }, + "issuer_mode": "DYNAMIC", + "logo_uri": "http://developer.okta.com/assets/images/logo-new.png", + "redirect_uris": [ + "https://example.com/oauth2/callback", + "myapp://callback" + ], + "response_types": [ + "token", + "id_token", + "code" + ], + "wildcard_redirect": "DISABLED" + } + }, + "signOnMode": "OPENID_CONNECT", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "oidc_client_link": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": true, + "web": true + } + } + } + }, + "OpenidConnectResponseEx": { + "summary": "OPENID_CONNECT", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "oauthClient": { + "autoKeyRotation": true, + "client_id": "0oahonkqCRR6TSNlg4", + "client_secret": "wj9bOsLK0BRNJqy7KMMnaE7m8qrW51bPO2n1-PYvkOmhHRYgcuOecQkEwq9MPYa5", + "pkce_required": true, + "token_endpoint_auth_method": "client_secret_post" + }, + "signing": { + "kid": "H34mvc6VrfV5yvy5wA8ikMFws6WInx4nvsAs-7EYbVc" + }, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample Client profile", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "oidc_client", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:oidc_client:0oafxqCAJWWGELFTYASJ", + "profile": { + "label": "oauth2 client app 1" + }, + "settings": { + "app": {}, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "oauthClient": { + "application_type": "native", + "client_uri": "http://localhost:8080", + "dpop_bound_access_tokens": false, + "grant_types": [ + "authorization_code" + ], + "idp_initiated_login": { + "default_scope": [], + "mode": "DISABLED" + }, + "issuer_mode": "DYNAMIC", + "logo_uri": "http://developer.okta.com/assets/images/logo-new.png", + "redirect_uris": [ + "https://example.com/oauth2/callback", + "myapp://callback" + ], + "response_types": [ + "token", + "id_token", + "code" + ], + "wildcard_redirect": "DISABLED" + } + }, + "signOnMode": "OPENID_CONNECT", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "oidc_client_link": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": true, + "web": true + } + } + } + }, + "OperationCompletedResponse": { + "summary": "Operation Completed Response", + "value": { + "completed": "2023-10-01T12:10:00Z", + "created": "2023-10-01T12:00:00Z", + "id": "rdj2ccmltchKESW8u0g5", + "started": "2023-10-01T12:05:00Z", + "status": "COMPLETED", + "type": "read:directories" + } + }, + "OperationFailedResponse": { + "summary": "Operation Failed Response", + "value": { + "completed": "2023-10-01T12:10:00Z", + "created": "2023-10-01T12:00:00Z", + "id": "rdj2ccmltchKESW8u0g5", + "started": "2023-10-01T12:05:00Z", + "status": "FAILED", + "type": "read:directories" + } + }, + "OperationInProgressResponse": { + "summary": "Operation In Progress Response", + "value": { + "created": "2023-10-01T12:00:00Z", + "id": "rdj2ccmltchKESW8u0g5", + "started": "2023-10-01T12:05:00Z", + "status": "IN_PROGRESS", + "type": "read:directories" + } + }, + "OperationResponse": { + "value": { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/operations/rre4mje4ez6B2a7B60g7", + "method": "GET", + "rel": "self" + } + }, + "assignmentOperation": { + "configuration": { + "actions": { + "assignUserToRealm": { + "realmId": "00g1b7rvh0xPLKXFf0g5" + } + }, + "conditions": { + "expression": { + "value": "string" + }, + "profileSourceId": "0oa4enoRyjwSCy5hx0g4" + }, + "id": "0pr1b7rxZj2ibQzfP0g5", + "name": "Realm Assignment 1" + } + }, + "completed": "2023-10-25T21:02:54.000Z", + "created": "2023-10-25T21:02:54.000Z", + "id": "rre4mje4ez6B2a7B60g7", + "numUserMoved": 50, + "realmId": "00g1b7rvh0xPLKXFf0g5", + "realmName": "Realm Name", + "started": "2023-10-25T21:02:54.000Z", + "status": "COMPLETED", + "type": "realm:assignment" + } + }, + "OptInStatusResponse": { + "summary": "Opt in response", + "value": { + "_links": { + "optInStatus": { + "href": "http://your-subdomain.okta.com/api/v1/iam/governance/optIn" + } + }, + "optInStatus": "OPTING_IN" + } + }, + "OptOutStatusResponse": { + "summary": "Opt out response", + "value": { + "_links": { + "optInStatus": { + "href": "http://your-subdomain.okta.com/api/v1/iam/governance/optIn" + } + }, + "optInStatus": "OPTING_OUT" + } + }, + "OrgCAPTCHASettingsConfigured": { + "summary": "org-wide Captcha settings are configured", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "POST", + "PUT", + "DELETE" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/captchas/abcd4567" + } + }, + "captchaId": "abcd4567", + "enabledPages": [ + "SSR", + "SIGN_IN" + ] + } + }, + "OrgCAPTCHASettingsDisable": { + "summary": "Disable org-wide Captcha settings", + "value": { + "captchaId": "null", + "enabledPages": "null" + } + }, + "OrgCAPTCHASettingsDisabled": { + "summary": "Disabled org-wide Captcha settings", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/captchas/" + } + }, + "captchaId": "null", + "enabledPages": "[]" + } + }, + "OrgCAPTCHASettingsEmpty": { + "summary": "Org-wide Captcha settings aren't configured", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "POST", + "PUT", + "DELETE" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/captchas" + } + }, + "captchaId": null, + "enabledPages": [] + } + }, + "OrgCAPTCHASettingsUpdate": { + "summary": "Update org-wide Captcha settings", + "value": { + "captchaId": "abcd4567", + "enabledPages": [ + "SSR", + "SIGN_IN" + ] + } + }, + "OrgCAPTCHASettingsUpdated": { + "summary": "Updated org-wide Captcha settings", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "POST", + "PUT", + "DELETE" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/captchas/abcd4567" + } + }, + "captchaId": "abcd4567", + "enabledPages": [ + "SSR", + "SIGN_IN" + ] + } + }, + "OrgSettingResponse": { + "summary": "Org setting response", + "value": { + "_links": { + "contacts": { + "href": "https://vantest.oktapreview.com/api/v1/org/contacts" + }, + "logo": null, + "oktaCommunication": { + "href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaCommunication" + }, + "oktaSupport": { + "href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaSupport" + }, + "preferences": { + "href": "https://{yourOktaDomain}/v1/org/preferences" + }, + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/logo" + } + }, + "address1": "100 1st St", + "address2": "6th floor", + "city": "San Fransico", + "companyName": "okta", + "country": "United States", + "created": "2024-01-24T14:15:22Z", + "endUserSupportHelpURL": "support.okta.com", + "expiresAt": "2024-12-24T14:15:22Z", + "id": "00o3qqiw0vSCIwu8I0g7", + "lastUpdated": "2024-07-21T14:15:22Z", + "phoneNumber": "+18887227871", + "postalCode": "94105", + "state": "California", + "status": "ACTIVE", + "subdomain": "okta", + "supportPhoneNumber": "+18887227871", + "website": "www.okta.com" + } + }, + "PasswordImportPayloadExample": { + "summary": "An example password import inline hook request body", + "value": { + "cloudEventVersion": "0.1", + "contentType": "application/json", + "data": { + "action": { + "credential": "UNVERIFIED" + }, + "context": { + "credential": { + "password": "Okta", + "username": "isaac.brock@example.com" + }, + "request": { + "id": "XiIl6wn7005Rr@fjYqeC7CCDBxw", + "ipAddress": "66.124.153.138", + "method": "POST", + "url": { + "value": "/idp/idx/challenge/answer" + } + } + } + }, + "eventId": "3o9jBzq1SmOGmmsDsqyyeQ", + "eventTime": "2020-01-17T21:23:56.000Z", + "eventType": "com.okta.user.credential.password.import", + "eventTypeVersion": "1.0", + "source": "https://${yourOktaDomain}/api/v1/inlineHooks/cbl2ad6phv9fsPLcF0g7" + } + }, + "PasswordImportUnVerifiedResponse": { + "summary": "An example password hook response for an unverified user password", + "value": { + "commands": [ + { + "type": "com.okta.action.update", + "value": { + "credential": "UNVERIFIED" + } + } + ] + } + }, + "PasswordImportVerifiedResponse": { + "summary": "An example password hook response for a verified user password", + "value": { + "commands": [ + { + "type": "com.okta.action.update", + "value": { + "credential": "VERIFIED" + } + } + ] + } + }, + "PerClientRateLimitSettingsEnforceDefault": { + "value": { + "defaultMode": "ENFORCE" + } + }, + "PerClientRateLimitSettingsEnforceDefaultWithOverrides": { + "value": { + "defaultMode": "ENFORCE", + "useCaseModeOverrides": { + "OAUTH2_AUTHORIZE": "PREVIEW", + "OIE_APP_INTENT": "DISABLE" + } + } + }, + "PerClientRateLimitSettingsPreviewDefaultWithOverrides": { + "value": { + "defaultMode": "PREVIEW", + "useCaseModeOverrides": { + "LOGIN_PAGE": "ENFORCE" + } + } + }, + "PermissionResponse": { + "value": { + "_links": { + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.manage" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "label": "okta.users.manage", + "lastUpdated": "2021-02-06T16:20:57.000Z" + } + }, + "PermissionResponseWithConditions": { + "value": { + "_links": { + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.read" + } + }, + "conditions": { + "include": { + "okta:ResourceAttribute/User/Profile": [ + "city", + "state", + "zipCode" + ] + } + }, + "created": "2021-02-06T16:20:57.000Z", + "label": "okta.users.read", + "lastUpdated": "2021-02-06T16:20:57.000Z" + } + }, + "PermissionsResponse": { + "value": { + "permissions": [ + { + "_links": { + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.create" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "label": "okta.users.create", + "lastUpdated": "2021-02-06T16:20:57.000Z" + }, + { + "_links": { + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.read" + } + }, + "conditions": { + "include": { + "okta:ResourceAttribute/User/Profile": [ + "city", + "state", + "zipCode" + ] + } + }, + "created": "2021-02-06T16:20:57.000Z", + "label": "okta.users.read", + "lastUpdated": "2021-02-06T16:20:57.000Z" + }, + { + "_links": { + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.groups.read" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "label": "okta.groups.read", + "lastUpdated": "2021-02-06T16:20:57.000Z" + }, + { + "_links": { + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.userprofile.manage" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "label": "okta.users.userprofile.manage", + "lastUpdated": "2021-02-06T16:20:57.000Z" + } + ] + } + }, + "PersonaIDVResponse": { + "summary": "Persona as IdP", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bfdjnK55Z5x80h7/lifecycle/activate" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bfdjnK55Z5x80h7/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bfdjnK55Z5x80h7" + } + }, + "created": "2023-10-01T12:00:00.000Z", + "id": "0oa62bfdjnK55Z5x80h7", + "lastUpdated": "2023-10-01T12:00:00.000Z", + "name": "Persona IDV", + "policy": { + "maxClockSkew": 0, + "provisioning": { + "action": "DISABLED", + "groups": null, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "source.userName" + } + } + }, + "properties": { + "inquiryTemplateId": "itmpl_HSctx8fNvXoHtrQfz2hxUVH8RBjG" + }, + "protocol": { + "credentials": { + "bearer": { + "apiKey": "your-api-key" + } + }, + "endpoints": { + "authorization": { + "binding": "HTTP-REDIRECT", + "url": "https://withpersona.com/verify" + } + }, + "type": "ID_PROOFING" + }, + "status": "ACTIVE", + "type": "IDV_PERSONA" + } + }, + "PreviewEmailCustomizationResponse": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel2kk1zYJBJbeaGo0g4/preview" + }, + "template": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + }, + "test": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" + } + }, + "body": "

Hello, John. Click here to activate your account.", + "subject": "Welcome to Okta!" + } + }, + "PreviewEmailTemplateDefaultContentResponse": { + "value": { + "_links": { + "defaultContent": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test/default-content" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content/preview" + }, + "template": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" + } + }, + "body": "

Hello, John. Click here to activate your account.", + "subject": "Welcome to Okta!" + } + }, + "PrincipalRateLimitEntityReplaceRequestSSWSToken": { + "summary": "Replace a principal rate limit entity request", + "value": { + "defaultConcurrencyPercentage": 75, + "defaultPercentage": 50, + "principalId": "prlh5hd6act3aHDrr1f5", + "principalType": "SSWS_TOKEN" + } + }, + "PrincipalRateLimitEntityReplaceResponseSSWSToken": { + "summary": "Replace a principal rate limit entity response example", + "value": { + "createdBy": "00u7xut94qEWYx5ss1d4", + "createdDate": "2022-05-19T20:05:32.720Z", + "defaultConcurrencyPercentage": 75, + "defaultPercentage": 50, + "id": "0oacamvryxiyMqgiY1e5", + "lastUpdate": "2022-05-20T21:13:07.410Z", + "lastUpdatedBy": "00u7xut94qEWYx5ss1d4", + "orgId": "org1234", + "principalId": "prlh5hd6act3aHDrr1f5", + "principalType": "SSWS_TOKEN" + } + }, + "PrincipalRateLimitEntityRequestSSWSToken": { + "summary": "Create a principal rate limit entity request example", + "value": { + "defaultConcurrencyPercentage": 75, + "defaultPercentage": 50, + "principalId": "prlh5hd6act3aHDrr1f5", + "principalType": "SSWS_TOKEN" + } + }, + "PrincipalRateLimitEntityResponseSSWSToken": { + "summary": "Create a principal rate limit entity response example", + "value": { + "createdBy": "00u7xut94qEWYx5ss1d4", + "createdDate": "2022-05-19T20:05:32.720Z", + "defaultConcurrencyPercentage": 75, + "defaultPercentage": 50, + "id": "0oacamvryxiyMqgiY1e5", + "lastUpdate": "2022-05-20T21:13:07.410Z", + "lastUpdatedBy": "00u7xut94qEWYx5ss1d4", + "orgId": "org1234", + "principalId": "prlh5hd6act3aHDrr1f5", + "principalType": "SSWS_TOKEN" + } + }, + "PrincipalRateLimitsOAuthClientListAllExample": { + "summary": "List all OAuth 2.0 client principal rate limits", + "value": [ + { + "createdBy": "00uid52637YwIXkJq1d4", + "createdDate": "2023-05-02T20:37:38.000Z", + "defaultConcurrencyPercentage": 40, + "defaultPercentage": 40, + "id": "prl7yh347wuzN5P1C1e7", + "lastUpdate": "2024-11-29T14:56:06.000Z", + "lastUpdatedBy": "00uid52637YwIXkJq1d4", + "orgId": "00o7xut90ucsjAQ7S1e6", + "principalId": "0oa7yh346zIE1y84p1e7", + "principalType": "OAUTH_CLIENT" + }, + { + "createdBy": "00uid52637YwIXkJq1d4", + "createdDate": "2023-12-07T21:58:02.000Z", + "defaultConcurrencyPercentage": 50, + "defaultPercentage": 50, + "id": "prlbqdob5bhM6nff61e7", + "lastUpdate": "2023-12-07T21:58:02.000Z", + "lastUpdatedBy": "00uid52637YwIXkJq1d4", + "orgId": "00o7xut90ucsjAQ7S1e6", + "principalId": "0oabqdob4da0JGuMf1e7", + "principalType": "OAUTH_CLIENT" + }, + { + "createdBy": "00uid52637YwIXkJq1d4", + "createdDate": "2024-01-12T20:59:18.000Z", + "defaultConcurrencyPercentage": 50, + "defaultPercentage": 50, + "id": "prlcamvrzvkglWHqR1e7", + "lastUpdate": "2024-01-12T20:59:18.000Z", + "lastUpdatedBy": "00uid52637YwIXkJq1d4", + "orgId": "00o7xut90ucsjAQ7S1d7", + "principalId": "0oacamvryxiyMqgiY1e7", + "principalType": "OAUTH_CLIENT" + } + ] + }, + "PrincipalRateLimitsSSWSListAllExample": { + "summary": "List all SSWS API token principal rate limits", + "value": [ + { + "createdBy": "00u7xut94qEWYx5ss1d4", + "createdDate": "2024-09-12T17:28:56.000Z", + "defaultConcurrencyPercentage": 50, + "defaultPercentage": 50, + "id": "prlh5hd7qct3aHDry1f6", + "lastUpdate": "2024-09-12T17:28:56.000Z", + "lastUpdatedBy": "00uid52637YwIXkJq1d4", + "orgId": "00o7xut90ucsjAQ7S1e6", + "principalId": "00T14q3ns31qMEJUU1d7", + "principalType": "SSWS_TOKEN" + }, + { + "createdBy": "00uid52637YwIXkJq1d4", + "createdDate": "2024-11-13T17:07:14.000Z", + "defaultConcurrencyPercentage": 50, + "defaultPercentage": 50, + "id": "prlid6w9ilOWlVbpG1f6", + "lastUpdate": "2024-11-13T17:07:14.000Z", + "lastUpdatedBy": "00uid52637YwIXkJq1d4", + "orgId": "00o7xut90ucsjAQ7S1e6", + "principalId": "00T16ewcxyIrMV6Lb1d7", + "principalType": "SSWS_TOKEN" + } + ] + }, + "PrivilegedResourceClaimAppAccountResponse": { + "value": { + "containerDetails": { + "_links": { + "login": { + "href": "https://appinstance-admin.oktapreview.com/home/google/0oa103099SBEb3Z2b0g4," + }, + "logo": { + "href": "https://appinstance-admin.oktapreview.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png," + } + }, + "appName": "google,", + "containerId": "0oa103099SBEb3Z2b0g4,", + "displayName": "Google App1,", + "globalAppId": "964b82aa-85b4-5645-b790-83312c473480,", + "passwordPushSupported": "true,", + "provisioningEnabled": "true," + }, + "created": "2024-06-10T11:11:01.000Z", + "credentialSyncInfo": { + "errorCode": "", + "errorReason": "", + "secretVersionId": "", + "syncState": "NOT_SYNCED", + "syncTime": "" + }, + "credentials": { + "userName": "testuser@example.com" + }, + "id": "opa100xTfFs4MasRf0g4", + "lastUpdated": "2024-06-10T11:11:01.000Z", + "resourceType": "APP_ACCOUNT", + "status": "ACTIVE" + } + }, + "PrivilegedResourceClaimOktaAccountResponse": { + "value": { + "created": "2024-06-10T11:11:01.000Z", + "credentialSyncInfo": { + "errorCode": "", + "errorReason": "", + "secretVersionId": "", + "syncState": "NOT_SYNCED", + "syncTime": "" + }, + "credentials": { + "userName": "username" + }, + "id": "opa100xTfFs4MasRf0g4", + "lastUpdated": "2024-06-10T11:11:01.000Z", + "profile": { + "email": "testuser@example.com" + }, + "resourceId": "00u100xTfFs4MasRf0g4,", + "resourceType": "OKTA_USER_ACCOUNT", + "status": "ACTIVE" + } + }, + "PrivilegedResourceCreateAppAccountRequest": { + "value": { + "containerDetails": { + "containerId": "0oa103099SBEb3Z2b0g4" + }, + "credentials": { + "userName": "testuser@example.com" + }, + "resourceType": "APP_ACCOUNT" + } + }, + "PrivilegedResourceCreateAppAccountResponse": { + "value": { + "containerDetails": { + "_links": { + "login": { + "href": "https://appinstance-admin.oktapreview.com/home/google/0oa103099SBEb3Z2b0g4," + }, + "logo": { + "href": "https://appinstance-admin.oktapreview.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png," + } + }, + "appName": "google,", + "containerId": "0oa103099SBEb3Z2b0g4,", + "displayName": "Google App1,", + "globalAppId": "964b82aa-85b4-5645-b790-83312c473480,", + "passwordPushSupported": "true,", + "provisioningEnabled": "true," + }, + "created": "2024-06-10T11:11:01.000Z", + "credentialSyncInfo": { + "errorCode": "", + "errorReason": "", + "secretVersionId": "", + "syncState": "NOT_SYNCED", + "syncTime": "" + }, + "credentials": { + "userName": "testuser@example.com" + }, + "id": "opa100xTfFs4MasRf0g4", + "lastUpdated": "2024-06-10T11:11:01.000Z", + "resourceType": "APP_ACCOUNT", + "status": "INACTIVE" + } + }, + "PrivilegedResourceCreateOktaAccountRequestConvert": { + "value": { + "resourceId": "00u100xTfFs4MasRf0g4", + "resourceType": "OKTA_USER_ACCOUNT" + } + }, + "PrivilegedResourceCreateOktaAccountRequestNew": { + "value": { + "credentials": { + "userName": "username" + }, + "profile": { + "email": "testuser@example.com" + }, + "resourceType": "OKTA_USER_ACCOUNT" + } + }, + "PrivilegedResourceCreateOktaAccountResponse": { + "value": { + "created": "2024-06-10T11:11:01.000Z", + "credentialSyncInfo": { + "errorCode": "", + "errorReason": "", + "secretVersionId": "", + "syncState": "NOT_SYNCED", + "syncTime": "" + }, + "credentials": { + "userName": "username" + }, + "id": "opa100xTfFs4MasRf0g4", + "lastUpdated": "2024-06-10T11:11:01.000Z", + "profile": { + "email": "testuser@example.com" + }, + "resourceId": "00u100xTfFs4MasRf0g4,", + "resourceType": "OKTA_USER_ACCOUNT", + "status": "INACTIVE" + } + }, + "PrivilegedResourceFilterCreatePayload": { + "summary": "Filters request body", + "value": { + "appGroups": [ + { + "externalId": 18070146415, + "name": "domainAdminsGroup1" + }, + { + "externalId": 7968626130, + "name": "domainAdminsGroup2" + } + ], + "organizationalUnits": [ + { + "name": "OU=example1,DN=globo,DN=com" + }, + { + "name": "OU=example2,DN=globo,DN=com" + } + ] + } + }, + "PrivilegedResourceRotatePasswordAppAccountResponse": { + "value": { + "containerDetails": { + "_links": { + "login": { + "href": "https://appinstance-admin.oktapreview.com/home/google/0oa103099SBEb3Z2b0g4," + }, + "logo": { + "href": "https://appinstance-admin.oktapreview.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png," + } + }, + "appName": "google,", + "containerId": "0oa103099SBEb3Z2b0g4,", + "displayName": "Google App1,", + "globalAppId": "964b82aa-85b4-5645-b790-83312c473480,", + "passwordPushSupported": "true,", + "provisioningEnabled": "true," + }, + "created": "2024-06-10T11:11:01.000Z", + "credentialSyncInfo": { + "errorCode": "", + "errorReason": "", + "secretVersionId": "9f8400-e29b-41d4-a716-926655440034", + "syncState": "SYNCING", + "syncTime": "" + }, + "credentials": { + "userName": "testuser@example.com" + }, + "id": "opa100xTfFs4MasRf0g4", + "lastUpdated": "2024-06-10T11:11:01.000Z", + "resourceType": "APP_ACCOUNT", + "status": "ACTIVE" + } + }, + "PrivilegedResourceRotatePasswordOktaAccountResponse": { + "value": { + "created": "2024-06-10T11:11:01.000Z", + "credentialSyncInfo": { + "errorCode": "", + "errorReason": "", + "secretVersionId": "9f8400-e29b-41d4-a716-926655440034", + "syncState": "SYNCED", + "syncTime": "2024-06-11T11:11:01.000Z" + }, + "credentials": { + "userName": "username" + }, + "id": "opa100xTfFs4MasRf0g4", + "lastUpdated": "2024-06-10T11:11:01.000Z", + "profile": { + "email": "testuser@example.com" + }, + "resourceId": "00u100xTfFs4MasRf0g4,", + "resourceType": "OKTA_USER_ACCOUNT", + "status": "ACTIVE" + } + }, + "PrivilegedResourcesAppAccountUpdateRequest": { + "value": { + "username": "username" + } + }, + "PrivilegedResourcesFetchResponse": { + "summary": "List privileged resources", + "value": [ + { + "created": "2024-06-10T11:11:01.000Z", + "credentialSyncInfo": { + "errorCode": "", + "errorReason": "", + "secretVersionId": "9f8400-e29b-41d4-a716-926655440034", + "syncState": "SYNCED", + "syncTime": "2024-06-10T11:30:01.000Z" + }, + "credentials": { + "userName": "john.adams@ct12-100k.local.domain" + }, + "id": "opa100xTfFs4MasRf0g4", + "lastUpdated": "2024-06-10T11:11:01.000Z", + "profile": { + "displayName": "John Adams", + "dn": "CN=John Adams,OU=Sales,DC=ct12-100k,DC=local", + "email": "john.adams@ct12-100k.local.domain", + "firstName": "John", + "lastName": "Adams", + "objectSid": "sid-1234", + "samAccountName": "john-adams" + }, + "resourceType": "APP_ACCOUNT", + "status": "ACTIVE" + }, + { + "created": "2024-06-10T11:11:01.000Z", + "credentialSyncInfo": { + "errorCode": "", + "errorReason": "", + "secretVersionId": "9f8400-e29b-41d4-a716-926655440034", + "syncState": "SYNCED", + "syncTime": "2024-06-10T11:30:01.000Z" + }, + "credentials": { + "userName": "testuser@example.com" + }, + "id": "opa100xTfFs4MasRf0g5", + "lastUpdated": "2024-06-10T11:11:01.000Z", + "profile": { + "displayName": "John Doe", + "dn": "CN=John Doe,OU=Sales,DC=ct12-100k,DC=local", + "email": "john.doe@ct12-100k.local.domain", + "firstName": "John", + "lastName": "Doe", + "objectSid": "sid-5678", + "samAccountName": "john-doe" + }, + "resourceType": "APP_ACCOUNT", + "status": "ACTIVE" + } + ] + }, + "PrivilegedResourcesGetAppAccountResponse": { + "value": { + "containerDetails": { + "_links": { + "login": { + "href": "https://appinstance-admin.oktapreview.com/home/google/0oa103099SBEb3Z2b0g4," + }, + "logo": { + "href": "https://appinstance-admin.oktapreview.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png," + } + }, + "appName": "google,", + "containerId": "0oa103099SBEb3Z2b0g4,", + "displayName": "Google App1,", + "globalAppId": "964b82aa-85b4-5645-b790-83312c473480,", + "passwordPushSupported": "true,", + "provisioningEnabled": "true," + }, + "created": "2024-06-10T11:11:01.000Z", + "credentialSyncInfo": { + "errorCode": "UNKNOWN_ERROR", + "errorReason": "Password update failed", + "secretVersionId": "9f8400-e29b-41d4-a716-926655440034", + "syncState": "SYNC_FAILED", + "syncTime": "2024-06-10T11:30:01.000Z" + }, + "credentials": { + "userName": "testuser@example.com" + }, + "id": "opa100xTfFs4MasRf0g4", + "lastUpdated": "2024-06-10T11:11:01.000Z", + "resourceType": "APP_ACCOUNT", + "status": "ACTIVE" + } + }, + "PrivilegedResourcesGetOktaAccountResponse": { + "value": { + "created": "2024-06-10T11:11:01.000Z", + "credentialSyncInfo": { + "errorCode": "", + "errorReason": "", + "secretVersionId": "9f8400-e29b-41d4-a716-926655440034", + "syncState": "SYNCED", + "syncTime": "2024-06-10T11:30:01.000Z" + }, + "credentials": { + "userName": "testuser@example.com" + }, + "id": "opa100xTfFs4MasRf0g4", + "lastUpdated": "2024-06-10T11:11:01.000Z", + "profile": { + "email": "testuser@example.com" + }, + "resourceId": "00u100xTfFs4MasRf0g4,", + "resourceType": "OKTA_USER_ACCOUNT", + "status": "ACTIVE" + } + }, + "PrivilegedResourcesOktaUserAccountUpdateRequest": { + "value": { + "profile": { + "email": "testuser@example.com" + }, + "username": "username" + } + }, + "ProfileEnrollmentRequest": { + "summary": "An example registration hook profile enrollment (SSR) inline hook request body", + "value": { + "cloudEventVersion": 0.1, + "contentType": "application/json", + "data": { + "action": "ALLOW", + "context": { + "request": { + "id": "123testId456", + "ipAddress": "127.0.0.1", + "method": "POST", + "url": { + "value": "/idp/idx/enroll/new" + } + } + }, + "userProfile": { + "email": "rosario.jones@example.com", + "firstName": "Rosario", + "lastName": "Jones", + "login": "rosario.jones@example.com" + } + }, + "eventId": "04Dmt8BcT_aEgM", + "eventTime": "2022-04-25T17:35:27.000Z", + "eventType": "com.okta.user.pre-registration", + "eventTypeVersion": 1, + "requestType": "self.service.registration", + "source": "regt4qeBKU29vSoPz0g3" + } + }, + "ProfileEnrollmentResponse": { + "summary": "An example registration hook profile enrollment (SSR) inline hook response", + "value": { + "commands": [ + { + "type": "com.action.update", + "value": { + "registration": "ALLOW" + } + } + ] + } + }, + "ProfileEnrollmentResponseDeny": { + "summary": "An example profile enrollment (SSR) inline hook deny response", + "value": { + "commands": [ + { + "type": "com.action.update", + "value": { + "registration": "DENY" + } + } + ], + "error": { + "errorCauses": [ + { + "domain": "end-user", + "errorSummary": "Only example.com emails can register.", + "location": "data.userProfile.email", + "locationType": "body", + "reason": "INVALID_EMAIL_DOMAIN" + } + ], + "errorSummary": "Incorrect email address. Please contact your admin." + } + } + }, + "ProgressiveProfileRequest": { + "summary": "An example progressive profile inline hook request", + "value": { + "cloudEventVersion": 0.1, + "contentType": "application/json", + "data": { + "action": "ALLOW", + "context": { + "request": { + "id": "123dummyId456", + "ipAddress": "127.0.0.1", + "method": "POST", + "url": { + "value": "/idp/idx/enroll/update" + } + }, + "user": { + "_links": { + "factors": { + "href": "/api/v1/users/00u48gwcu01WxvNol0g7/factors" + }, + "groups": { + "href": "/api/v1/users/00u48gwcu01WxvNol0g7/groups" + } + }, + "id": "00u48gwcu01WxvNo", + "passwordChanged": "2022-01-01T00:00:00.000Z", + "profile": { + "firstName": "Rosario", + "lastName": "Jones\"", + "locale": "en_US", + "login": "rosario.jones@example.com", + "timeZone": "America/Los_Angeles" + } + } + }, + "userProfileUpdate": { + "employeeNumber": 1234 + } + }, + "eventId": "vzYp_zMwQu2htIWRbNJdfw", + "eventTime": "2022-04-25T04:04:41.000Z", + "eventType": "com.okta.user.pre-registration", + "eventTypeVersion": 1, + "requestType": "progressive.profile", + "source": "regt4qeBKU29vS" + } + }, + "ProgressiveProfileResponse": { + "summary": "An example progressive profile inline hook response", + "value": { + "commands": [ + { + "type": "com.okta.user.progressive.profile.update'", + "value": "request.body.data.userProfileUpdate['employeeNumber']" + } + ] + } + }, + "ProgressiveProfileResponseDeny": { + "summary": "An example progressive profile inline hook deny response", + "value": { + "commands": [ + { + "type": "com.action.update", + "value": { + "registration": "DENY" + } + } + ], + "error": { + "errorCauses": [ + { + "domain": "end-user", + "errorSummary": "Only employee numbers with 4 digits can register.", + "location": "data.userProfile.employeeNumber", + "locationType": "body", + "reason": "INVALID_EMPLOYEE_NUMBER" + } + ], + "errorSummary": "Incorrect employee number. Enter an employee number with 4 digits." + } + } + }, + "ProvisioningConnectionOAuthOrg2OrgWithRotationRequestEx": { + "summary": "Provisioning connection with OAuth 2.0 for Okta Org2Org app with key rotation", + "value": { + "profile": { + "authScheme": "OAUTH", + "clientId": "0oa2h6su6bVFyJzIf1d7", + "signing": { + "rotationMode": "AUTO" + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "ProvisioningConnectionOAuthOrg2OrgWithRotationResponseEx": { + "summary": "Provisioning connection with OAuth 2.0 for Okta Org2Org (okta_org2org) app", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default" + } + }, + "authScheme": "OAUTH2", + "profile": { + "authScheme": "OAUTH2", + "clientId": "0oa2wmzEtqh49C1Sr0g4", + "signing": { + "rotationMode": "AUTO" + } + }, + "status": "ENABLED" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "ProvisioningConnectionOauthO365RequestEx": { + "summary": "Provisioning connection with OAuth 2.0 for Microsoft Office 365 app", + "value": { + "profile": { + "authScheme": "OAUTH2", + "settings": { + "adminPassword": "office_admin-password", + "adminUsername": "office_admin-username" + } + } + } + }, + "ProvisioningConnectionOauthRequestEx": { + "summary": "Provisioning connection with OAuth 2.0", + "value": { + "profile": { + "authScheme": "OAUTH2" + } + } + }, + "ProvisioningConnectionOauthResponseEx": { + "summary": "Provisioning connection with OAuth 2.0 for Microsoft Office 365 app", + "value": { + "_links": { + "authorize": { + "guidance": [ + "Specifies the URI to invoke in a browser for granting scope consent required to complete the OAuth 2.0 connection." + ], + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://login.microsoftonline.com/myofficetenant.onmicrosoft.com/oauth2/authorize?response_type=code&state=>&client_id=&redirect_uri=&scope=" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default" + } + }, + "profile": { + "authScheme": "OAUTH2" + }, + "status": "ENABLED" + } + }, + "ProvisioningConnectionTokenOrg2OrgRequestEx": { + "summary": "Provisioning connection with token for Okta Org2Org app", + "value": { + "profile": { + "authScheme": "TOKEN", + "clientId": "0oa2h6su6bVFyJzIf1d7" + } + } + }, + "ProvisioningConnectionTokenRequestEx": { + "summary": "Provisioning connection with token for Zscaler 2.0 (zscalerbyz) app", + "value": { + "baseUrl": "https://scim.zscalerbeta.net/1234567/890/scim", + "profile": { + "authScheme": "TOKEN", + "token": "00NgAPZqUVy8cX9ehNzzahEE5b-On9sImTcInvWp-x" + } + } + }, + "ProvisioningConnectionTokenResponseWithProfileOrg2OrgEx": { + "summary": "Provisioning connection with token for Okta Org2Org (okta_org2org) app", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default" + } + }, + "authScheme": "TOKEN", + "baseUrl": "https://targetorg.okta.com", + "profile": { + "authScheme": "TOKEN" + }, + "status": "ENABLED" + } + }, + "ProvisioningConnectionTokenResponseWithProfileZscalerEx": { + "summary": "Provisioning connection with token for Zscaler 2.0 (zscalerbyz) app", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default" + } + }, + "authScheme": "TOKEN", + "baseUrl": "https://scim.zscalerbeta.net/1234567/890/scim", + "profile": { + "authScheme": "TOKEN" + }, + "status": "ENABLED" + } + }, + "PublicAppleAppSiteWellKnownURIResponse": { + "value": { + "authsrv": { + "apps": [ + "B7F62B65BN.com.okta.mobile", + "B7F62B65BN.com.okta.mobile.auth-service-extension", + "B7F62B65BN.com.okta.authenticator.beta", + "B7F62B65BN.com.okta.authenticator.beta.auth-service-extension", + "7WXXBW6Z2Y.com.okta.mobile.internalrelease", + "7WXXBW6Z2Y.com.okta.mobile.internalrelease.auth-service-extension" + ], + "key1": "value1", + "key2": "value2", + "key3": { + "key3.1": "value3.1" + } + } + } + }, + "PublicAssetLinksWellKnownURIResponse": { + "value": [ + { + "key1": "value1" + } + ] + }, + "PublicWebauthnWellKnownURIResponse": { + "value": { + "origins": [ + "https://example1.com" + ] + } + }, + "PushProviderAPNsRequest": { + "value": { + "configuration": { + "fileName": "fileName.p8", + "keyId": "KEY_ID", + "teamId": "TEAM_ID", + "tokenSigningKey": "-----BEGIN PRIVATE KEY-----\\nPRIVATE_KEY\\n-----END PRIVATE KEY-----\\n" + }, + "name": "APNs Example", + "providerType": "APNS" + } + }, + "PushProviderAPNsResponse": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/push-providers/ppctekcmngGaqeiBxB0g4" + } + }, + "configuration": { + "fileName": "fileName.p8", + "keyId": "KEY_ID", + "teamId": "TEAM_ID" + }, + "id": "ppctekcmngGaqeiBxB0g4", + "lastUpdatedDate": "2022-01-01T00:00:00.000Z", + "name": "APNs Example", + "providerType": "APNS" + } + }, + "PushProviderFCMRequest": { + "value": { + "configuration": { + "fileName": "fileName.json", + "serviceAccountJson": { + "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", + "auth_uri": "https://accounts.google.com/o/oauth2/auth", + "client_email": "SERVICE_ACCOUNT_EMAIL", + "client_id": "CLIENT_ID", + "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL", + "private_key": "-----BEGIN PRIVATE KEY-----\\nPRIVATE_KEY\\n-----END PRIVATE KEY-----\\n", + "private_key_id": "KEY_ID", + "project_id": "PROJECT_ID", + "token_uri": "https://accounts.google.com/o/oauth2/token", + "type": "service_account" + } + }, + "name": "FCM Example", + "providerType": "FCM" + } + }, + "PushProviderFCMResponse": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/push-providers/ppctekcmngGaqeiBxB0g4" + } + }, + "configuration": { + "fileName": "fileName.p8", + "projectId": "PROJECT_ID" + }, + "id": "ppctekcmngGaqeiBxB0g4", + "lastUpdatedDate": "2022-01-01T00:00:00.000Z", + "name": "FCM Example", + "providerType": "FCM" + } + }, + "RateLimitAdminNotificationsDisabled": { + "value": { + "notificationsEnabled": false + } + }, + "RateLimitAdminNotificationsEnabled": { + "value": { + "notificationsEnabled": true + } + }, + "RateLimitWarningThresholdValidExample": { + "value": { + "warningThreshold": 66 + } + }, + "RealmResponse": { + "value": { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/realms/guox9jQ16k9V8IFEL0g3", + "method": "GET", + "rel": "self" + } + }, + "created": "2022-04-04T15:56:05.000Z", + "id": "guox9jQ16k9V8IFEL0g3", + "isDefault": false, + "lastUpdated": "2022-05-05T18:15:44.000Z", + "profile": { + "domains": [ + "atko.com", + "user.com" + ], + "name": "Car Co" + } + } + }, + "RefreshCurrentSessionResponse": { + "summary": "Refresh current session", + "value": { + "_links": { + "refresh": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/sessions/me/lifecycle/refresh" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/sessions/me" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/me", + "name": "User Name" + } + }, + "amr": [ + "pwd" + ], + "createdAt": "2019-08-24T14:15:22Z", + "expiresAt": "2019-08-24T14:15:22Z", + "id": "l7FbDVqS8zHSy65uJD85", + "idp": { + "id": "01a2bcdef3GHIJKLMNOP", + "type": "ACTIVE_DIRECTORY" + }, + "lastFactorVerification": "2019-08-24T14:15:22Z", + "lastPasswordVerification": "2019-08-24T14:15:22Z", + "login": "user@example.com", + "status": "ACTIVE", + "userId": "00u0abcdefGHIJKLMNOP" + } + }, + "RefreshSessionResponse": { + "summary": "Refresh an existing session using the session ID", + "value": { + "_links": { + "href": "https://{yourOktaDomain}/api/v1/sessions/l7FbDVqS8zHSy65uJD85", + "self": { + "hints": { + "allow": [ + "DELETE" + ] + } + } + }, + "amr": [ + "pwd" + ], + "createdAt": "2019-08-25T14:17:22Z", + "expiresAt": "2019-08-25T14:17:22Z", + "id": "l7FbDVqS8zHSy65uJD85", + "idp": { + "id": "01a2bcdef3GHIJKLMNOP", + "type": "ACTIVE_DIRECTORY" + }, + "lastFactorVerification": "2019-08-24T14:15:22Z", + "lastPasswordVerification": "2019-08-24T14:15:22Z", + "login": "user@example.com", + "status": "ACTIVE", + "userId": "00u0abcdefGHIJKLMNOP" + } + }, + "RemoveMappingBody": { + "summary": "Update an existing profile mapping by removing one or more properties", + "value": { + "properties": { + "nickName": { + "expression": null, + "pushStatus": null + } + } + } + }, + "RemoveMappingResponse": { + "summary": "Update an existing profile mapping by removing one or more properties", + "value": { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/mappings/prm1k48weFSOnEUnw0g4" + } + }, + "id": "prm1k47ghydIQOTBW0g4", + "properties": { + "fullName": { + "expression": "user.firstName + user.lastName", + "pushStatus": "PUSH" + } + }, + "source": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscsbePhQ3yqt4cVv0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/types/user/otysbePhQ3yqt4cVv0g3" + } + }, + "id": "otysbePhQ3yqt4cVv0g3", + "name": "user", + "type": "user" + }, + "target": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/apps/0oa1qmn4LZQQEH0wZ0g4/default" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1qmn4LZQQEH0wZ0g4" + } + }, + "id": "0oa1qmn4LZQQEH0wZ0g4", + "name": "okta_org2org", + "type": "appuser" + } + } + }, + "ReplaceAnEventHookWithFilter": { + "summary": "Replace an event hook", + "value": { + "channel": { + "config": { + "authScheme": { + "key": "Authorization", + "type": "HEADER", + "value": "my-shared-secret" + }, + "uri": "https://example_external_service/userAdded" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "description": "An event hook using an Okta Expression Language filter", + "events": { + "filter": { + "eventFilterMap": [ + { + "condition": { + "expression": "event.target.?[type eq 'UserGroup'].size()>0 && event.target.?[displayName eq 'Sales'].size()>0" + }, + "event": "group.user_membership.add" + } + ], + "type": "EXPRESSION_LANGUAGE" + }, + "items": [ + "group.user_membership.add" + ], + "type": "EVENT_TYPE" + }, + "name": "Event Hook with Filter" + } + }, + "ReplaceAuthServerBody": { + "summary": "Replace a custom authorization server", + "value": { + "audiences": [ + "api://default" + ], + "credentials": { + "signing": { + "rotationMode": "AUTO", + "use": "sig" + } + }, + "description": "Authorization Server description", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "issuerMode": "ORG_URL", + "name": "New Authorization Server", + "status": "ACTIVE" + } + }, + "ReplaceAuthServerEnableTokenEncryptionBody": { + "summary": "Rotate the active encryption key for access token encryption", + "value": { + "accessTokenEncryptedResponseAlgorithm": "RSA-OAEP-256", + "audiences": [ + "api://default" + ], + "credentials": { + "signing": { + "rotationMode": "AUTO", + "use": "sig" + } + }, + "description": "Authorization server description", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "issuerMode": "ORG_URL", + "jwks": { + "keys": [ + { + "e": "AQAB", + "id": "apk2g3sd6bqV5YZxu0h8", + "kid": "encKey1", + "kty": "RSA", + "n": "iHYyA5KXL82veBfNP81D7Q1GMRWIixNTu5jY03Z19DN7qTg1xYPRyPEPuMJ5Xjdhrm3dJdW7p1woRa6CHfw8FS7aosXUZkplxPs0NICP32nCkwpX3U3CltgVWrpMEUrd-JljKm0AgrervZuLkgBEfwY3BXP_SCKjF0JtbQjcK9MOKFNUUUK3_xTrFcyZThlSOtiOmhjDHTfHzeG2Q0NG2Opom1kfKWLDUVy5qrzYJWgcCaPOyEE1xnk4u5syH_8APOi2tKwKBCgS_D-kXzZ_379VhVuEpo2CGBU20t9Ys_m8KLqMCOyJaoQ3R1r6cWHfnYSab31L1my3rLwuippXkQ", + "status": "ACTIVE", + "use": "enc" + }, + { + "e": "AQAB", + "id": "apk5f3fg7kkG4TUzv0h8", + "kid": "encKey2", + "kty": "RSA", + "n": "iHYyA5KXL82veBfNP81D7Q1GMRWIixNTu5jY03Z19DN7qTg1xYPRyPEPuMJ5Xjdhrm3dJdW7p1woRa6CHfw8FS7aosXUZkplxPs0NICP32nCkwpX3U3CltgVWrpMEUrd-JljKm0AgrervZuLkgBEfwY3BXP_SCKjF0JtbQjcK9MOKFNUUUK3_xTrFcyZThlSOtiOmhjDHTfHzeG2Q0NG2Opom1kfKWLDUVy5qrzYJWgcCaPOyEE1xnk4u5syH_8APOi2tKwKBCgS_D-kXzZ_379VhVuEpo2CGBU20t9Ys_m8KLqMCOyJaoQ3R1r6cWHfnYSab31L1my3rLwuippXkQ", + "status": "INACTIVE", + "use": "enc" + } + ] + }, + "name": "New Authorization Server", + "status": "ACTIVE" + } + }, + "ReplaceAuthServerEnableTokenEncryptionResponse": { + "summary": "Rotate the active encryption key for access token encryption", + "value": { + "_links": { + "claims": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate" + }, + "metadata": [ + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server", + "name": "oauth-authorization-server" + }, + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration", + "name": "openid-configuration" + } + ], + "policies": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies" + }, + "rotateKey": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate" + }, + "scopes": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}" + } + }, + "accessTokenEncryptedResponseAlgorithm": "RSA-OAEP-256", + "audiences": [ + "https://api.resource.com" + ], + "created": "2023-05-17T22:25:57.000Z", + "credentials": { + "signing": { + "kid": "WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4", + "lastRotated": "2023-05-17T22:25:57.000Z", + "nextRotation": "2023-08-15T22:25:57.000Z", + "rotationMode": "AUTO" + } + }, + "description": "Sample authorization server description", + "id": "{authorizationServerId}", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "issuerMode": "ORG_URL", + "jwks": { + "keys": [ + { + "e": "AQAB", + "id": "apk2g3sd6bqV5YZxu0h8", + "kid": "encKey1", + "kty": "RSA", + "n": "iHYyA5KXL82veBfNP81D7Q1GMRWIixNTu5jY03Z19DN7qTg1xYPRyPEPuMJ5Xjdhrm3dJdW7p1woRa6CHfw8FS7aosXUZkplxPs0NICP32nCkwpX3U3CltgVWrpMEUrd-JljKm0AgrervZuLkgBEfwY3BXP_SCKjF0JtbQjcK9MOKFNUUUK3_xTrFcyZThlSOtiOmhjDHTfHzeG2Q0NG2Opom1kfKWLDUVy5qrzYJWgcCaPOyEE1xnk4u5syH_8APOi2tKwKBCgS_D-kXzZ_379VhVuEpo2CGBU20t9Ys_m8KLqMCOyJaoQ3R1r6cWHfnYSab31L1my3rLwuippXkQ", + "status": "ACTIVE", + "use": "enc" + }, + { + "e": "AQAB", + "id": "apk5f3fg7kkG4TUzv0h8", + "kid": "encKey2", + "kty": "RSA", + "n": "iHYyA5KXL82veBfNP81D7Q1GMRWIixNTu5jY03Z19DN7qTg1xYPRyPEPuMJ5Xjdhrm3dJdW7p1woRa6CHfw8FS7aosXUZkplxPs0NICP32nCkwpX3U3CltgVWrpMEUrd-JljKm0AgrervZuLkgBEfwY3BXP_SCKjF0JtbQjcK9MOKFNUUUK3_xTrFcyZThlSOtiOmhjDHTfHzeG2Q0NG2Opom1kfKWLDUVy5qrzYJWgcCaPOyEE1xnk4u5syH_8APOi2tKwKBCgS_D-kXzZ_379VhVuEpo2CGBU20t9Ys_m8KLqMCOyJaoQ3R1r6cWHfnYSab31L1my3rLwuippXkQ", + "status": "INACTIVE", + "use": "enc" + } + ] + }, + "lastUpdated": "2023-05-17T22:25:57.000Z", + "name": "Sample Authorization Server", + "status": "ACTIVE" + } + }, + "ReplaceAuthServerResponse": { + "summary": "Replace a custom authorization server", + "value": { + "_links": { + "claims": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate" + }, + "metadata": [ + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server", + "name": "oauth-authorization-server" + }, + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration", + "name": "openid-configuration" + } + ], + "policies": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies" + }, + "rotateKey": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate" + }, + "scopes": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}" + } + }, + "audiences": [ + "https://api.resource.com" + ], + "created": "2023-05-17T22:25:57.000Z", + "credentials": { + "signing": { + "kid": "WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4", + "lastRotated": "2023-05-17T22:25:57.000Z", + "nextRotation": "2023-08-15T22:25:57.000Z", + "rotationMode": "AUTO" + } + }, + "description": "Sample Authorization Server description", + "id": "{authorizationServerId}", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "issuerMode": "ORG_URL", + "lastUpdated": "2023-05-17T22:25:57.000Z", + "name": "Sample Authorization Server", + "status": "ACTIVE" + } + }, + "ReplaceCustomTokenClaimBody": { + "summary": "Replace a custom token claim", + "value": [ + { + "alwaysIncludeInToken": true, + "claimType": "IDENTITY", + "conditions": { + "scopes": [ + "profile" + ] + }, + "group_filter_type": "CONTAINS", + "name": "Knowledge_Base", + "status": "ACTIVE", + "system": false, + "value": "Knowledge Base", + "valueType": "GROUPS" + } + ] + }, + "ReplaceCustomTokenClaimResponse": { + "summary": "Replace a custom token claim response", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims/{claimId}" + } + }, + "alwaysIncludeInToken": true, + "apiResourceId": null, + "claimType": "IDENTITY", + "conditions": { + "scopes": [ + "profile" + ] + }, + "group_filter_type": "CONTAINS", + "id": "{claimId}", + "name": "Knowledge_Base", + "status": "ACTIVE", + "system": false, + "value": "Knowledge Base", + "valueType": "GROUPS" + } + ] + }, + "ReplaceIdPRequestResponse": { + "summary": "Replace an IdP", + "value": { + "_links": { + "acs": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/sso/saml2/0oa62bc8wppPw0UGr0h7", + "type": "application/xml" + }, + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/lifecycle/activate" + }, + "metadata": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/metadata.xml", + "type": "application/xml" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/users" + } + }, + "created": null, + "id": "0oa62bc8wppPw0UGr0h7", + "lastUpdated": "2016-03-29T21:23:45.000Z", + "name": "Example SAML IdP", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 120000, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": null, + "matchType": "USERNAME", + "userNameTemplate": { + "template": "idpuser.subjectNameId" + } + }, + "trustClaims": false + }, + "protocol": { + "algorithms": { + "request": { + "signature": { + "algorithm": "SHA-256", + "scope": "REQUEST" + } + }, + "response": { + "signature": { + "algorithm": "SHA-256", + "scope": "ANY" + } + } + }, + "credentials": { + "trust": { + "additionalKids": [ + "additional-key-id" + ], + "audience": "https://www.okta.com/saml2/service-provider/spCQJRNaaxs7ANqKBO7M", + "issuer": "https://idp.example.com", + "kid": "your-key-id" + } + }, + "endpoints": { + "acs": { + "binding": "HTTP-POST", + "type": "INSTANCE" + }, + "slo": { + "binding": "HTTP-POST", + "url": "https://idp.example.com/slo" + }, + "sso": { + "binding": "HTTP-REDIRECT", + "destination": "https://idp.example.com/saml2/sso", + "url": "https://idp.example.com/saml2/sso" + } + }, + "settings": { + "nameFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "participateSlo": true + }, + "type": "SAML2" + }, + "status": "INACTIVE", + "type": "SAML2" + } + }, + "ReplaceKeyResponse": { + "summary": "Replace a key response example", + "value": { + "created": "2022-08-31T18:09:58.000Z", + "id": "HKY1p7jWLndGQV9M60g4", + "isUsed": "false", + "keyId": "7fbc27fd-e3df-4522-86bf-1930110256ad", + "lastUpdated": "2022-08-31T18:16:59.000Z", + "name": "My updated new key" + } + }, + "ReplaceNetworkZone": { + "summary": "Replace a network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzovw2rFz2YoqmvwZ0g9/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzovw2rFz2YoqmvwZ0g9" + } + }, + "gateways": [ + { + "type": "CIDR", + "value": "10.2.3.4/24" + }, + { + "type": "CIDR", + "value": "12.2.3.4/24" + }, + { + "type": "RANGE", + "value": "13.4.5.6-13.4.5.8" + }, + { + "type": "CIDR", + "value": "14.2.3.4/24" + } + ], + "id": "nzovw2rFz2YoqmvwZ0g9", + "name": "UpdatedNetZone", + "proxies": [ + { + "type": "CIDR", + "value": "12.2.3.4/24" + }, + { + "type": "CIDR", + "value": "13.3.4.5/24" + }, + { + "type": "RANGE", + "value": "14.4.5.6-14.4.5.8" + }, + { + "type": "RANGE", + "value": "15.5.6.7/24-15.5.6.9" + } + ], + "status": "ACTIVE", + "system": false, + "type": "IP", + "usage": "POLICY" + } + }, + "ReplaceNetworkZoneResponse": { + "summary": "Replace network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzovw2rFz2YoqmvwZ0g9/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzovw2rFz2YoqmvwZ0g9" + } + }, + "created": "2022-05-08T18:25:05.000Z", + "gateways": [ + { + "type": "CIDR", + "value": "10.2.3.4/24" + }, + { + "type": "CIDR", + "value": "12.2.3.4/24" + }, + { + "type": "RANGE", + "value": "13.4.5.6-13.4.5.8" + }, + { + "type": "CIDR", + "value": "14.2.3.4/24" + } + ], + "id": "nzovw2rFz2YoqmvwZ0g9", + "lastUpdated": "2022-05-10T13:15:22.000Z", + "name": "UpdatedNetZone", + "proxies": [ + { + "type": "CIDR", + "value": "12.2.3.4/24" + }, + { + "type": "CIDR", + "value": "13.3.4.5/24" + }, + { + "type": "RANGE", + "value": "14.4.5.6-14.4.5.8" + }, + { + "type": "RANGE", + "value": "15.5.6.7/24-15.5.6.9" + } + ], + "status": "ACTIVE", + "system": false, + "type": "IP", + "usage": "POLICY" + } + }, + "ReplaceResourceSetRequest": { + "value": { + "description": "People in the IT department of San Francisco", + "label": "SF-IT-People" + } + }, + "ReplaceRoleRequest": { + "value": { + "description": "Create users", + "label": "UserCreator" + } + }, + "ReplaceUserTypePutRequest": { + "summary": "Replace user type request", + "value": { + "description": "Replacement description", + "displayName": "Replacement Display Name", + "name": "newUserType" + } + }, + "ReplaceUserTypePutResponse": { + "summary": "Replace user type response", + "value": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + } + }, + "created": "2021-07-05T20:40:38.000Z", + "createdBy": "sprz9fj1ycBcsgopy1d6", + "default": false, + "description": "Replacement description", + "displayName": "Replacement Display Name", + "id": "otyfnly5cQjJT9PnR0g4", + "lastUpdated": "2021-07-05T20:40:38.000Z", + "lastUpdatedBy": "sprz9fj1ycBcsgopy1d6", + "name": "newUserType" + } + }, + "ResetPwdWithoutSendingEmailResponse": { + "value": { + "resetPasswordUrl": "https://{yourOktaDomain}/reset_password/XE6wE17zmphl3KqAPFxO", + "summary": "Reset password without sending email" + } + }, + "ResourceSetBindingAddMembersRequestExample": { + "value": { + "additions": [ + "https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3", + "https://{yourOktaDomain}/api/v1/users/00u67DU2qNCjNZYO0g3" + ] + } + }, + "ResourceSetBindingCreateRequestExample": { + "value": { + "members": [ + "https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3" + ], + "role": "cr0Yq6IJxGIr0ouum0g3" + } + }, + "ResourceSetBindingMemberResponse": { + "value": { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00uuk41Hjga5qGfQ30g3" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "id": "irb1qe6PGuMc7Oh8N0g4", + "lastUpdated": "2021-02-06T16:20:57.000Z" + } + }, + "ResourceSetBindingMembersResponse": { + "value": { + "_links": { + "binding": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3/members" + } + }, + "members": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00uuk41Hjga5qGfQ30g3" + } + }, + "created": "2024-12-19T00:00:00.000Z", + "id": "irb1qe6PGuMc7Oh8N0g4", + "lastUpdated": "2024-12-19T00:00:00.000Z" + }, + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3" + } + }, + "created": "2024-12-19T00:00:00.000Z", + "id": "irb1q92TFAHzySt3x0g4", + "lastUpdated": "2024-12-19T00:00:00.000Z" + } + ] + } + }, + "ResourceSetBindingResponseExample": { + "value": { + "_links": { + "bindings": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3" + } + } + } + }, + "ResourceSetBindingResponseWithIdExample": { + "value": { + "_links": { + "members": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3/members" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3" + } + }, + "id": "cr0Yq6IJxGIr0ouum0g3" + } + }, + "ResourceSetBindingsResponse": { + "value": { + "_links": { + "next": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings?after=cr0WxyzJxGIr0ouum0g4" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings" + } + }, + "roles": [ + { + "_links": { + "members": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0WxyzJxGIr0ouum0g4/members" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0WxyzJxGIr0ouum0g4" + } + }, + "id": "cr0WxyzJxGIr0ouum0g4" + } + ] + } + }, + "ResourceSetRequest": { + "value": { + "description": "People in the IT department of San Francisco", + "label": "SF-IT-People", + "resources": [ + "https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3", + "https://{yourOktaDomain}/api/v1/groups/00gu67DU2qNCjNZYO0g3/users", + "https://{yourOktaDomain}/api/v1/users", + "https://{yourOktaDomain}/api/v1/realms/00guaxWZ0AOa5NFAj0g3", + "https://{yourOktaDomain}/api/v1/realms" + ] + } + }, + "ResourceSetResourcePatchRequestExample": { + "value": { + "additions": [ + "https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3", + "https://{yourOktaDomain}/api/v1/groups/00gu67DU2qNCjNZYO0g3/users" + ] + } + }, + "ResourceSetResourcePostRequestExample": { + "summary": "Resource set with conditions request", + "value": { + "conditions": { + "Exclude": { + "okta:ORN": [ + "orn:okta:idp:00o5rb5mt2H3d1TJd0h7:apps:0oa1014FmyZ2H0oRY0g4", + "orn:okta:idp:00o5rb5mt2H3d1TJd0h7:apps:slack" + ] + } + }, + "resourceOrnOrUrl": "https://{yourOktaDomain}/api/v1/apps" + } + }, + "ResourceSetResourcePutRequestExample": { + "value": { + "conditions": { + "Exclude": { + "okta:ORN": [ + "orn:okta:idp:00o5rb5mt2H3d1TJd0h7:apps:0oa1014FmyZ2H0oRY0g4", + "orn:okta:idp:00o5rb5mt2H3d1TJd0h7:apps:slack" + ] + } + } + } + }, + "ResourceSetResourceResponse": { + "summary": "Resource set response", + "value": { + "_links": { + "resource": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources/ire2snv2xSY7a4iSe0g1" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps" + } + }, + "conditions": { + "Exclude": { + "okta:ORN": [ + "orn:okta:idp:00o5rb5mt2H3d1TJd0h7:apps:0oa1014FmyZ2H0oRY0g4", + "orn:okta:idp:00o5rb5mt2H3d1TJd0h7:apps:slack" + ] + } + }, + "created": "2021-02-06T16:20:57.000Z", + "id": "ire106sQKoHoXXsAe0g4", + "lastUpdated": "2021-02-06T16:20:57.000Z", + "orn": "orn:okta:idp:00o5rb5mt2H3d1TJd0h7:apps" + } + }, + "ResourceSetResourcesResponse": { + "value": { + "_links": { + "next": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources?after=irezvn1ZZxLSIBM2J0g3" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + } + }, + "resources": [ + { + "_links": { + "resource": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources/ire2snv2xSY7a4iSe0g1" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/groups/00guaxWZ0AOa5NFAj0g3" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "id": "ire106sQKoHoXXsAe0g4", + "lastUpdated": "2021-02-06T16:20:57.000Z", + "orn": "orn:{partition}:directory:{yourOrgId}:groups:00guaxWZ0AOa5NFAj0g3" + }, + { + "_links": { + "resource": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources/ire2snv2xSY7a4iSe0g2" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/groups/00gu67DU2qNCjNZYO0g3/users" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "id": "ire106riDrTYl4qA70g4", + "lastUpdated": "2021-02-06T16:20:57.000Z", + "orn": "orn:{partition}:directory:{yourOrgId}:groups:00gu67DU2qNCjNZYO0g3:contained_resources" + }, + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/users" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "id": "irezvo4AwE2ngpMw40g3", + "lastUpdated": "2021-02-06T16:20:57.000Z", + "orn": "orn:{partition}:directory:{yourOrgId}:users" + }, + { + "_links": { + "groups": { + "href": "https://{yourOktaDomain}/api/v1/groups" + }, + "resource": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources/ire2snv2xSY7a4iSe0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/groups" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "id": "ire2j4iDnxHhUFaZN0g4", + "lastUpdated": "2021-02-06T16:20:57.000Z", + "orn": "orn:{partition}:directory:{yourOrgId}:groups" + } + ] + } + }, + "ResourceSetResponse": { + "value": { + "_links": { + "bindings": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings" + }, + "resources": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "description": "People in the IT department of San Francisco", + "id": "iamoJDFKaJxGIr0oamd9g", + "label": "SF-IT-People", + "lastUpdated": "2021-02-06T16:20:57.000Z" + } + }, + "ResourceSetsResponse": { + "value": { + "_links": { + "next": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets?after=iamoJDFKaJxGIr0oamd0q" + } + }, + "resource-sets": [ + { + "_links": { + "bindings": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings" + }, + "resources": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/resources" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "description": "First San Francisco IT Resource Set", + "id": "iamoJDFKaJxGIr0oamd9g", + "label": "SF-IT-1", + "lastUpdated": "2021-02-06T16:20:57.000Z" + }, + { + "_links": { + "bindings": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd0q/bindings" + }, + "resources": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd0q/resources" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd0q" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "description": "Second San Francisco IT Resource Set", + "id": "iamoJDFKaJxGIr0oamd0q", + "label": "SF-IT-2", + "lastUpdated": "2021-02-06T16:20:57.000Z" + } + ] + } + }, + "RetrieveADeactivatedEventHook": { + "summary": "Deactivated event hook", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate" + }, + "self": { + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "authorization", + "type": "HEADER" + }, + "headers": [ + { + "key": "X-Other-Header", + "value": "my-header-value" + } + ], + "method": "POST", + "uri": "https://example_external_service/userAdded" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2023-07-07T13:41:56.000Z", + "createdBy": "00u7xut94qEWYx5ss1e5", + "description": null, + "events": { + "filter": null, + "items": [ + "group.user_membership.add" + ], + "type": "EVENT_TYPE" + }, + "id": "who8vt36qfNpCGz9H1e6", + "lastUpdated": "2023-07-07T13:43:03.000Z", + "name": "Event Hook Test", + "status": "INACTIVE", + "verificationStatus": "VERIFIED" + } + }, + "RetrieveAllEventHooks": { + "summary": "Retrieves all event hooks", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx135/lifecycle/deactivate" + }, + "self": { + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx135" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx135/lifecycle/verify" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "authorization", + "type": "HEADER" + }, + "headers": [], + "method": "POST", + "uri": "https://example_external_service/userDeactivate" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2023-07-07T17:41:56.000Z", + "createdBy": "00u7xut94qEWYx5ss1e5", + "description": null, + "events": { + "filter": null, + "items": [ + "user.lifecycle.deactivate", + "user.lifecycle.activate" + ], + "type": "EVENT_TYPE" + }, + "id": "who8tsqyrhCdmetzx135", + "lastUpdated": "2023-07-07T17:43:03.000Z", + "name": "Event Hook Test", + "status": "ACTIVE", + "verificationStatus": "VERIFIED" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate" + }, + "self": { + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "authorization", + "type": "HEADER" + }, + "headers": [], + "method": "POST", + "uri": "https://example_external_service/userAdded" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2023-07-07T13:41:56.000Z", + "createdBy": "00u7xut94qEWYx5ss1e5", + "description": "An event hook using an Okta Expression Language filter", + "events": { + "filter": { + "eventFilterMap": [ + { + "condition": { + "expression": "event.target.?[type eq 'UserGroup'].size()>0 && event.target.?[displayName eq 'Sales'].size()>0", + "version": null + }, + "event": "group.user_membership.add" + } + ], + "type": "EXPRESSION_LANGUAGE" + }, + "items": [ + "group.user_membership.add" + ], + "type": "EVENT_TYPE" + }, + "id": "who8vt36qfNpCGz9H1e6", + "lastUpdated": "2023-07-07T13:43:03.000Z", + "name": "Event Hook with Filter", + "status": "ACTIVE", + "verificationStatus": "VERIFIED" + } + ] + }, + "RetrieveAllZones": { + "summary": "Retrieves all network zones", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/zones/nzok0oz2xYHOZtIch0g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/zones/nzok0oz2xYHOZtIch0g4" + } + }, + "asns": { + "exclude": [], + "include": [] + }, + "create": "2024-05-13T16:33:44.000Z", + "id": "nzok0oz2xYHOZtIch0g4", + "ipServiceCategories": { + "exclude": [], + "include": [ + "ALL_ANONYMIZERS" + ] + }, + "lastUpdated": "2024-05-13T16:33:44.000Z", + "locations": { + "exclude": [], + "include": [] + }, + "name": "testZone106", + "status": "ACTIVE", + "system": false, + "type": "DYNAMIC_V2", + "usage": "BLOCKLIST" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzoy0ox5xADOZtKrh0g6/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzoy0ox5xADOZtKrh0g6" + } + }, + "asns": [ + "23457" + ], + "created": "2022-05-19T15:33:32.000Z", + "id": "nzoy0ox5xADOZtKrh0g6", + "lastUpdated": "2022-05-19T15:33:32.000Z", + "locations": [ + { + "country": "AF", + "region": "AF-BGL" + } + ], + "name": "test", + "proxyType": "ANY", + "status": "ACTIVE", + "system": false, + "type": "DYNAMIC", + "usage": "POLICY" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3" + } + }, + "created": "2021-06-24T20:37:32.000Z", + "gateways": [ + { + "type": "CIDR", + "value": "1.2.3.4/24" + } + ], + "id": "nzowc1U5Jh5xuAK0o0g3", + "lastUpdated": "2021-06-24T20:37:32.000Z", + "name": "MyIpZone", + "proxies": [ + { + "type": "RANGE", + "value": "3.3.4.5-3.3.4.15" + } + ], + "status": "ACTIVE", + "system": false, + "type": "IP", + "usage": "POLICY" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6" + } + }, + "created": "2021-06-09T21:32:46.000Z", + "gateways": null, + "id": "nzou3u0stMCmgOzXK1d6", + "lastUpdated": "2021-06-09T21:32:46.000Z", + "name": "BlockedIpZone", + "proxies": null, + "status": "ACTIVE", + "system": true, + "type": "IP", + "usage": "BLOCKLIST" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6" + } + }, + "asns": { + "exclude": [], + "include": [] + }, + "created": "2024-05-06T19:12:29.000Z", + "id": "nzohcnxFrSgsiwyHp0g4", + "ipServiceCategories": { + "exclue": [], + "include": [ + "ALL_ANONYMIZERS" + ] + }, + "lastUpdated": "2024-05-09T21:02:31.000Z", + "locations": { + "exclude": [], + "include": [] + }, + "name": "DefaultEnhancedDynamicZone", + "status": "ACTIVE", + "system": true, + "type": "DYNAMIC_V2", + "usage": "BLOCKLIST" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0ssJfZjYsWL1d6/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0ssJfZjYsWL1d6" + } + }, + "created": "2021-06-09T21:32:46.000Z", + "gateways": null, + "id": "nzou3u0ssJfZjYsWL1d6", + "lastUpdated": "2021-06-09T21:32:46.000Z", + "name": "LegacyIpZone", + "proxies": null, + "status": "ACTIVE", + "system": true, + "type": "IP", + "usage": "POLICY" + } + ] + }, + "RetrieveAllZonesWithFilter": { + "summary": "Retrieves network zones with filter", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3" + } + }, + "created": "2021-06-24T20:37:32.000Z", + "gateways": [ + { + "type": "CIDR", + "value": "1.2.3.4/24" + } + ], + "id": "nzowc1U5Jh5xuAK0o0g3", + "lastUpdated": "2021-06-24T20:37:32.000Z", + "name": "MyIpZone", + "proxies": [ + { + "type": "RANGE", + "value": "3.3.4.5-3.3.4.15" + } + ], + "status": "ACTIVE", + "system": false, + "type": "IP", + "usage": "POLICY" + } + ] + }, + "RetrieveAnEventHook": { + "summary": "Retrieve an event hook", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate" + }, + "self": { + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "authorization", + "type": "HEADER" + }, + "headers": [ + { + "key": "X-Other-Header", + "value": "my-header-value" + } + ], + "method": "POST", + "uri": "https://example_external_service/userAdded" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2023-07-07T13:41:56.000Z", + "createdBy": "00u7xut94qEWYx5ss1e5", + "description": null, + "events": { + "filter": null, + "items": [ + "group.user_membership.add" + ], + "type": "EVENT_TYPE" + }, + "id": "who8vt36qfNpCGz9H1e6", + "lastUpdated": "2023-07-07T13:43:03.000Z", + "name": "Event Hook Test", + "status": "ACTIVE", + "verificationStatus": "VERIFIED" + } + }, + "RetrieveAnEventHookWithFilter": { + "summary": "Retrieve an event hook", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/deactivate" + }, + "hints": { + "allow": [ + "POST" + ] + }, + "self": { + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6" + }, + "verify": { + "href": "https://example.com/api/v1/eventHooks/who8tsqyrhCdmetzx1e6/lifecycle/verify" + } + }, + "channel": { + "config": { + "authScheme": { + "key": "authorization", + "type": "HEADER" + }, + "method": "POST", + "uri": "https://example_external_service/userAdded" + }, + "type": "HTTP", + "version": "1.0.0" + }, + "created": "2023-07-07T13:41:56.000Z", + "createdBy": "00u7xut94qEWYx5ss1e5", + "description": "An event hook using an Okta Expression Language filter", + "events": { + "filter": { + "eventFilterMap": [ + { + "condition": { + "expression": "event.target.?[type eq 'UserGroup'].size()>0 && event.target.?[displayName eq 'Sales'].size()>0", + "version": null + }, + "event": "group.user_membership.add" + } + ], + "type": "EXPRESSION_LANGUAGE" + }, + "items": [ + "group.user_membership.add" + ], + "type": "EVENT_TYPE" + }, + "id": "who8vt36qfNpCGz9H1e6", + "lastUpdated": "2023-07-07T13:43:03.000Z", + "name": "Event Hook with Filter", + "status": "ACTIVE", + "verificationStatus": "VERIFIED" + } + }, + "RetrieveAuthServerResponse": { + "summary": "Retrieve a custom authorization server", + "value": { + "_links": { + "claims": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate" + }, + "metadata": [ + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server", + "name": "oauth-authorization-server" + }, + { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration", + "name": "openid-configuration" + } + ], + "policies": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies" + }, + "rotateKey": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate" + }, + "scopes": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}" + } + }, + "audiences": [ + "https://api.resource.com" + ], + "created": "2023-05-17T22:25:57.000Z", + "credentials": { + "signing": { + "kid": "WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4", + "lastRotated": "2023-05-17T22:25:57.000Z", + "nextRotation": "2023-08-15T22:25:57.000Z", + "rotationMode": "AUTO" + } + }, + "description": "Sample Authorization Server description", + "id": "{authorizationServerId}", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "issuerMode": "ORG_URL", + "lastUpdated": "2023-05-17T22:25:57.000Z", + "name": "Sample Authorization Server", + "status": "ACTIVE" + } + }, + "RetrieveCurrentSessionResponse": { + "summary": "Retrieve current session", + "value": { + "_links": { + "refresh": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/sessions/me/lifecycle/refresh" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/sessions/me" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/me", + "name": "User Name" + } + }, + "amr": [ + "pwd" + ], + "createdAt": "2019-08-24T14:15:22Z", + "expiresAt": "2019-08-24T14:15:22Z", + "id": "l7FbDVqS8zHSy65uJD85", + "idp": { + "id": "01a2bcdef3GHIJKLMNOP", + "type": "ACTIVE_DIRECTORY" + }, + "lastFactorVerification": "2019-08-24T14:15:22Z", + "lastPasswordVerification": "2019-08-24T14:15:22Z", + "login": "user@example.com", + "status": "ACTIVE", + "userId": "00u0abcdefGHIJKLMNOP" + } + }, + "RetrieveCustomTokenClaimResponse": { + "summary": "Retrieve a custom token claim response", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims/{claimId}" + } + }, + "alwaysIncludeInToken": true, + "apiResourceId": null, + "claimType": "IDENTITY", + "conditions": { + "scopes": [ + "profile" + ] + }, + "group_filter_type": "CONTAINS", + "id": "{claimId}", + "name": "Support", + "status": "ACTIVE", + "system": false, + "value": "Support", + "valueType": "GROUPS" + } + ] + }, + "RetrieveFeaturesResponse": { + "summary": "Retrieve a feature by ID", + "value": { + "_links": { + "dependencies": { + "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies" + }, + "dependents": { + "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents" + }, + "self": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7" + } + }, + "description": "Example feature description", + "id": "ftrZooGoT8b41iWRiQs7", + "name": "Example feature name", + "stage": { + "state": "CLOSED", + "value": "BETA" + }, + "status": "DISABLED", + "type": "self-service" + } + }, + "RetrieveGroupPushMappingResponse_Example": { + "value": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" + }, + "sourceGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000000" + }, + "targetGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000001" + } + }, + "created": "2025-01-01T00:00:00Z", + "errorSummary": "", + "id": "gPm00000000000000000", + "lastPush": "2025-01-01T00:00:00Z", + "lastUpdated": "2025-01-01T00:00:00Z", + "sourceGroupId": "00g00000000000000000", + "status": "ACTIVE", + "targetGroupId": "00g00000000000000001" + } + }, + "RetrieveGroupPushMappingResponse_Example_ActiveDirectory": { + "value": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" + }, + "sourceGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000000" + }, + "targetGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000001" + } + }, + "appConfig": { + "distinguishedName": "dc=example,dc=com", + "groupScope": "GLOBAL", + "groupType": "SECURITY", + "samAccountName": "AdGroup", + "type": "ACTIVE_DIRECTORY" + }, + "created": "2025-01-01T00:00:00Z", + "errorSummary": "", + "id": "gPm00000000000000000", + "lastPush": "2025-01-01T00:00:00Z", + "lastUpdated": "2025-01-01T00:00:00Z", + "sourceGroupId": "00g00000000000000000", + "status": "ACTIVE", + "targetGroupId": "00g00000000000000001" + } + }, + "RetrieveKeyResponse": { + "summary": "Retrieve a key by ID response example", + "value": { + "created": "2022-08-31T18:09:58.000Z", + "id": "HKY1p7jWLndGQV9M60g4", + "isUsed": "false", + "keyId": "7fbc27fd-e3df-4522-86bf-1930110256ad", + "lastUpdated": "2022-08-31T18:09:58.000Z", + "name": "My new key" + } + }, + "RetrieveMappingsResponse": { + "summary": "Retrieve a single profile mapping", + "value": { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/mappings/prm1k48weFSOnEUnw0g4" + } + }, + "id": "prm1k47ghydIQOTBW0g4", + "properties": { + "firstName": { + "expression": "user.firstName", + "pushStatus": "PUSH" + }, + "lastName": { + "expression": "user.lastName", + "pushStatus": "PUSH" + } + }, + "source": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscsbePhQ3yqt4cVv0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/types/user/otysbePhQ3yqt4cVv0g3" + } + }, + "id": "otysbePhQ3yqt4cVv0g3", + "name": "user", + "type": "user" + }, + "target": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/apps/0oa1qmn4LZQQEH0wZ0g4/default" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1qmn4LZQQEH0wZ0g4" + } + }, + "id": "0oa1qmn4LZQQEH0wZ0g4", + "name": "okta_org2org", + "type": "appuser" + } + } + }, + "RetrieveNetworkZoneDynamic": { + "summary": "Dynamic network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzoy0ox5xADOZtKrh0g6/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzoy0ox5xADOZtKrh0g6" + } + }, + "asns": [ + "23457" + ], + "created": "2022-05-19T15:33:32.000Z", + "id": "nzoy0ox5xADOZtKrh0g6", + "lastUpdated": "2022-05-19T15:33:32.000Z", + "locations": [ + { + "country": "AF", + "region": "AF-BGL" + } + ], + "name": "test", + "proxyType": "ANY", + "status": "ACTIVE", + "system": false, + "type": "DYNAMIC", + "usage": "POLICY" + } + }, + "RetrieveNetworkZoneIP": { + "summary": "IP network zone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3" + } + }, + "created": "2021-06-24T20:37:32.000Z", + "gateways": [ + { + "type": "CIDR", + "value": "1.2.3.4/24" + } + ], + "id": "nzowc1U5Jh5xuAK0o0g3", + "lastUpdated": "2021-06-24T20:37:32.000Z", + "name": "MyIpZone", + "proxies": [ + { + "type": "RANGE", + "value": "3.3.4.5-3.3.4.15" + } + ], + "status": "ACTIVE", + "system": false, + "type": "IP", + "usage": "POLICY" + } + }, + "RetrievePublicKeyResponse": { + "summary": "Retrieve public key response example", + "value": { + "_embedded": { + "alg": "RSA", + "e": "AQAB", + "kid": "7fbc27fd-e3df-4522-86bf-1930110256ad", + "kty": "RSA", + "n": "2naqCnv6r4xNQs7207lRtKQvdtnlVND-8k5iYBIiqoKGY3CqUmRm1jleoOniiQoMkFX8Wj2DmVqr002efF3vOQ7_gjtTatBTVUNbNIQLybun4dkVoUtfP7pRc5SLpcP3eGPRVar734ZrpQXzmCEdpqBt3jrVjwYjNE5DqOjbYXFJtMsy8CWE9LRJ3kyHEoHPzo22dG_vMrXH0_sAQoCk_4TgNCbvyzVmGVYXI_BkUnp0hv2pR4bQVRYzGB9dKJdctOh8zULqc_EJ8tiYsS05YnF7whrWEyARK0rH-e4d4W-OmBTga_zhY4kJ4NsoQ4PyvcatZkxjPO92QHQOFDnf3w`", + "use": null + } + } + }, + "RetrieveRefreshTokenClientResponse": { + "summary": "Retrieve a refresh token for a client", + "value": [ + { + "_embedded": { + "scopes": [ + { + "_links": { + "scope": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/{scopeId}", + "title": "Keep you signed in to the app" + } + }, + "description": "This keeps you signed in to the app, even when you aren't using it.", + "displayName": "Keep you signed in to the app", + "id": "{scopeID}", + "name": "offline_access" + }, + { + "_links": { + "scope": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/{scopeId}", + "title": "openid" + } + }, + "description": "Signals that a request is an OpenID request", + "displayName": "openid", + "id": "{scopeId}", + "name": "openid" + } + ] + }, + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}", + "title": "My Web App" + }, + "authorizationServer": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}", + "title": "Authorization Server name" + }, + "client": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/{clientId}", + "title": "My Web App" + }, + "revoke": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/clients/{clientId}/tokens/{tokenId}" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/clients/{clientId}/tokens/{tokenId}" + }, + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/{userId}", + "title": "Joe User" + } + }, + "client_id": "{clientId}", + "created": "2023-09-21T19:59:56.000Z", + "expiresAt": "2023-09-28T20:00:38.000Z", + "id": "{refreshTokenId}", + "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", + "lastUpdated": "2023-09-21T20:00:38.000Z", + "scopes": [ + "offline_access", + "openid" + ], + "status": "ACTIVE", + "userId": "{userId}" + } + ] + }, + "RetrieveSessionResponse": { + "summary": "Retrieve session information for a single session ID", + "value": { + "_links": { + "href": "https://{yourOktaDomain}/api/v1/sessions/l7FbDVqS8zHSy65uJD85", + "self": { + "hints": { + "allow": [ + "DELETE" + ] + } + } + }, + "amr": [ + "pwd" + ], + "createdAt": "2019-08-24T14:15:22Z", + "expiresAt": "2019-08-24T14:15:22Z", + "id": "l7FbDVqS8zHSy65uJD85", + "idp": { + "id": "01a2bcdef3GHIJKLMNOP", + "type": "ACTIVE_DIRECTORY" + }, + "lastFactorVerification": "2019-08-24T14:15:22Z", + "lastPasswordVerification": "2019-08-24T14:15:22Z", + "login": "user@example.com", + "status": "ACTIVE", + "userId": "00u0abcdefGHIJKLMNOP" + } + }, + "RetrieveUISchemaResponse": { + "summary": "Retrieves a UI schema response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://exmaple.com/api/v1/meta/uischemas/uis4a7liocgcRgcxZ0g7" + } + }, + "created": "2022-07-25T12:56:31.000Z", + "id": "uis4a7liocgcRgcxZ0g7", + "lastUpdated": "2022-07-26T11:53:59.000Z", + "uiSchema": { + "buttonLabel": "Submit", + "elements": [ + { + "label": "First name", + "options": { + "format": "text" + }, + "scope": "#/properties/firstName", + "type": "Control" + }, + { + "label": "Last name", + "options": { + "format": "text" + }, + "scope": "#/properties/lastName", + "type": "Control" + }, + { + "label": "Email", + "options": { + "format": "text" + }, + "scope": "#/properties/email", + "type": "Control" + }, + { + "label": "Country code", + "options": { + "format": "select" + }, + "scope": "#/properties/countryCode", + "type": "Control" + }, + { + "label": "bool2", + "options": { + "format": "checkbox" + }, + "scope": "#/properties/bool2", + "type": "Control" + }, + { + "label": "date", + "scope": "#/properties/date", + "type": "Control" + }, + { + "label": "enum", + "options": { + "format": "radio" + }, + "scope": "#/properties/enum", + "type": "Control" + } + ], + "label": "Sign in", + "type": "Group" + } + } + }, + "RevokeOktaSupportAccessStatus": { + "summary": "Revoke Okta Support access", + "value": { + "caseNumber": "1011001", + "impersonation": { + "expiration": null, + "status": "DISABLED" + } + } + }, + "RevokeOktaSupportAccessStatusRequest": { + "summary": "Revoke Okta Support access", + "value": { + "impersonation": { + "status": "DISABLED" + } + } + }, + "RiskEventsRequestExample": { + "summary": "Risk events payload example", + "value": [ + { + "subjects": [ + { + "ip": "6.7.6.7", + "riskLevel": "MEDIUM" + }, + { + "ip": "1.1.1.1", + "message": "Detected Attack tooling and suspicious activity", + "riskLevel": "HIGH" + } + ], + "timestamp": "2021-01-20T00:00:00.001Z" + }, + { + "subjects": [ + { + "ip": "6.7.6.7", + "riskLevel": "LOW" + }, + { + "ip": "2.2.2.2", + "riskLevel": "HIGH" + } + ], + "timestamp": "2021-01-20T01:00:00.001Z" + } + ] + }, + "RiskProviderPutRequest": { + "summary": "Replace risk provider request example", + "value": { + "action": "enforce_and_log", + "clientId": "00ckjsfgjkdkjdkkljjsd", + "name": "Risk-Partner-Y" + } + }, + "RiskProviderPutResponse": { + "summary": "Replace risk provider response example", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/risk/providers/00rp12r4skkjkjgsn" + } + }, + "action": "enforce_and_log", + "clientId": "00ckjsfgjkdkjdkkljjsd", + "created": "2021-01-05 22:18:30", + "id": "00rp12r4skkjkjgsn", + "lastUpdated": "2021-01-05 23:18:30", + "name": "Risk-Partner-Y" + } + }, + "RiskProviderRequest": { + "summary": "Risk provider payload example", + "value": { + "action": "log_only", + "clientId": "00ckjsfgjkdkjdkkljjsd", + "name": "Risk-Partner-X" + } + }, + "RiskProviderResponse": { + "summary": "Risk provider response example", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/risk/providers/00rp12r4skkjkjgsn" + } + }, + "action": "log_only", + "clientId": "00ckjsfgjkdkjdkkljjsd", + "created": "2021-01-05 22:18:30", + "id": "00rp12r4skkjkjgsn", + "lastUpdated": "2021-01-05 22:18:30", + "name": "Risk-Partner-X" + } + }, + "RoleAssignedUsersResponseExample": { + "value": { + "_links": { + "next": { + "href": "http://your-subdomain.okta.com/api/v1/iam/assignees/users?after=00u118oQYT4TBGuay0g4&limit=1" + } + }, + "value": [ + { + "_links": { + "roles": { + "href": "http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4/roles" + }, + "self": { + "href": "http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4" + } + }, + "id": "00u118oQYT4TBGuay0g4", + "orn": "orn:okta:00o5rb5mt2H3d1TJd0h7:users:00u118oQYT4TBGuay0g4" + } + ] + } + }, + "RoleRequest": { + "value": { + "description": "Create users", + "label": "UserCreator", + "permissions": [ + "okta.users.create", + "okta.users.read", + "okta.groups.read", + "okta.users.userprofile.manage" + ] + } + }, + "RoleResponse": { + "value": { + "_links": { + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "description": "Create users", + "id": "cr0Yq6IJxGIr0ouum0g3", + "label": "UserCreator", + "lastUpdated": "2021-02-06T16:20:57.000Z" + } + }, + "RoleTargetAppInstanceResponse": { + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa5yriAxuR12wfQ30g4" + } + }, + "assignmentType": "USER", + "expiration": "2025-05-10T20:21:11.000Z", + "orn": "orn:okta:idp:00o5yd9J0satsK2Rp0g4:apps:myownapp:0oa5yriAxuR12wfQ30g4" + } + ] + }, + "RoleTargetAppResponse": { + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps%3Ffilter%3Dname%2Beq%2B%22gooddata%22" + } + }, + "assignmentType": "GROUP", + "expiration": "2025-05-10T20:21:11.000Z", + "orn": "orn:okta:idp:00ozjqqlt6mmHQonQ0g3:apps:gooddata" + } + ] + }, + "RoleTargetGroupResponse": { + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g5vhi3rEJMOog1S0g4" + } + }, + "assignmentType": "USER", + "expiration": "2025-05-10T20:21:11.000Z", + "orn": "orn:okta:directory:00o5v1t2W4OSF9r4N0g4:groups:00g5vhi3rEJMOog1S0g4" + } + ] + }, + "RolesResponse": { + "value": { + "_links": { + "next": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles?after=cr0Fw7HKcWIroo88m3r1" + } + }, + "roles": [ + { + "_links": { + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "description": "Create users", + "id": "cr0Yq6IJxGIr0ouum0g3", + "label": "UserCreator", + "lastUpdated": "2021-02-06T16:20:57.000Z" + }, + { + "_links": { + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Fw7HKcWIroo88m3r1/permissions" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Fw7HKcWIroo88m3r1" + } + }, + "created": "2021-02-06T16:20:57.000Z", + "description": "Manage group membership", + "id": "cr0Fw7HKcWIroo88m3r1", + "label": "GroupMembershipManager", + "lastUpdated": "2021-02-06T16:20:57.000Z" + } + ] + } + }, + "SAMLHookResponseExample": { + "summary": "An example SAML assertion inline hook response", + "value": { + "commands": [ + { + "type": "com.okta.assertion.patch", + "value": [ + { + "op": "replace", + "path": "/claims/array/attributeValues/1/value", + "value": "replacementValue" + }, + { + "op": "replace", + "path": "/authentication/authnContext", + "value": { + "authnContextClassRef": "replacementValue" + } + }, + { + "op": "add", + "path": "/claims/extPatientId", + "value": { + "attributeValues": [ + { + "attributes": { + "xsi:type": "xs:string" + }, + "value": "4321" + } + ], + "attributes": { + "NameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:basic" + } + } + }, + { + "op": "add", + "path": "/authentication/sessionLifetime", + "value": 300 + } + ] + }, + { + "type": "com.okta.assertion.patch", + "value": [ + { + "op": "replace", + "path": "/authentication/sessionIndex", + "value": "exampleSession" + } + ] + } + ] + } + }, + "SAMLHookResponseWithURIFormat": { + "summary": "An example with `replace` and `add` operations with the URI formatted claim encoded", + "value": { + "commands": [ + { + "type": "com.okta.assertion.patch", + "value": [ + { + "op": "replace", + "path": "/claims/http:~1~1schemas.xmlsoap.org~1ws~12005~105~1identity~1claims~1foo/attributeValues/0/value", + "value": "replacementValue" + }, + { + "op": "replace", + "path": "/claims/http:~1~1schemas.xmlsoap.org~1ws~12005~105~1identity~1claims~1foo/attributes", + "value": { + "attributes": { + "NameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:basic" + } + } + }, + { + "op": "add", + "path": "/claims/http:~1~1schemas.xmlsoap.org~1ws~12005~105~1identity~1claims~1bar", + "value": { + "attributeValues": [ + { + "attributes": { + "xsi:type": "xs:string" + }, + "value": "bearer" + } + ], + "attributes": { + "NameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:basic" + } + } + } + ] + } + ] + } + }, + "SAMLPayLoadExample": { + "summary": "An example SAML assertion inline hook request body", + "value": { + "cloudEventVersion": "0.1", + "contentType": "application/json", + "data": { + "assertion": { + "authentication": { + "authnContext": { + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport" + }, + "sessionIndex": "id1553800523546.312669168" + }, + "claims": { + "array": { + "attributeValues": [ + { + "attributes": { + "xsi:type": "xs:string" + }, + "value": "Array 1" + }, + { + "attributes": { + "xsi:type": "xs:string" + }, + "value": "Array2" + }, + { + "attributes": { + "xsi:type": "xs:string" + }, + "value": "Array3" + } + ], + "attributes": { + "NameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified" + } + }, + "extPatientId": { + "attributeValues": [ + { + "attributes": { + "xsi:type": "xs:integer" + }, + "value": "4321" + } + ], + "attributes": { + "NameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified" + } + }, + "firstAndLast": { + "attributeValues": [ + { + "attributes": { + "xsi:type": "xs:string" + }, + "value": "7d6a50c8-4d7e-4058-9c5b-2cc98cecd294" + } + ], + "attributes": { + "NameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified" + } + }, + "middle": { + "attributeValues": [ + { + "attributes": { + "xsi:type": "xs:string" + }, + "value": "admin" + } + ], + "attributes": { + "NameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified" + } + } + }, + "conditions": { + "audienceRestriction": [ + "urn:example:sp" + ] + }, + "lifetime": { + "expiration": 300 + }, + "subject": { + "confirmation": { + "data": { + "recipient": "http://www.example.com:7070/saml/sso" + }, + "method": "urn:oasis:names:tc:SAML:2.0:cm:bearer" + }, + "nameFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "nameId": "user@example.com" + } + }, + "context": { + "protocol": { + "issuer": { + "id": "0oath92zlO60urQOP0g3", + "name": "SAML 2.0 App", + "uri": "http://www.okta.com/exkth8lMzFm0HZOTU0g3" + }, + "type": "SAML2.0" + }, + "request": { + "id": "reqqXypjzYJRSu2j1G1imUovA", + "ipAddress": "127.0.0.1", + "method": "GET", + "url": { + "value": "https://${yourOktaDomain}/app/saml20app_1/exkth8lMzFm0HZOTU0g3/sso/saml" + } + }, + "session": { + "amr": [ + "PASSWORD" + ], + "createdAt": "2019-03-28T16:45:55.000Z", + "expiresAt": "2019-03-28T21:15:23.000Z", + "id": "102LN9Bnuc4S_ewfc9BYwageA", + "idp": { + "id": "00oq6kcVwvrDY2YsS0g3", + "type": "OKTA" + }, + "lastPasswordVerification": "2019-03-28T16:45:55.000Z", + "login": "user@example.com", + "mfaActive": false, + "status": "ACTIVE", + "userId": "00uq8tMo3zV0OfJON0g3" + }, + "user": { + "_links": { + "factors": { + "href": "https://${yourOktaDomain}/api/v1/users/00uq8tMo3zV0OfJON0g3/factors" + }, + "groups": { + "href": "https://${yourOktaDomain}/00uq8tMo3zV0OfJON0g3/groups" + } + }, + "id": "00uq8tMo3zV0OfJON0g3", + "passwordChanged": "2018-09-11T23:19:12.000Z", + "profile": { + "firstName": "Admin", + "lastName": "Last", + "locale": "en", + "login": "user@example.com", + "timeZone": "America/Los_Angeles" + } + } + } + }, + "eventId": "XMFoHCM1S4Wi_SGWzL8T9A", + "eventTime": "2019-03-28T19:15:23.000Z", + "eventType": "com.okta.saml.tokens.transform", + "eventTypeVersion": "1.0", + "source": "https://${yourOktaDomain}/app/saml20app_1/exkth8lMzFm0HZOTU0g3/sso/saml" + } + }, + "SMSTemplateEditablePropertyValues": { + "value": { + "name": "Custom", + "template": "${org.name}: your verification code is ${code}", + "translations": { + "es": "${org.name}: el c\u00f3digo de verificaci\u00f3n es ${code}", + "fr": "${org.name}: votre code de v\u00e9rification est ${code}", + "it": "${org.name}: il codice di verifica \u00e8 ${code}" + }, + "type": "SMS_VERIFY_CODE" + } + }, + "SMSTemplateListResponse": { + "value": [ + { + "created": "2024-04-25T17:35:02.000Z", + "id": "6NQUJ5yR3bpgEiYmq8IC", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Custom", + "template": "${org.name}: your verification code is ${code}", + "translations": { + "es": "${org.name}: el c\u00f3digo de verificaci\u00f3n es ${code}", + "fr": "${org.name}: votre code de v\u00e9rification est ${code}", + "it": "${org.name}: il codice di verifica \u00e8 ${code}" + }, + "type": "SMS_VERIFY_CODE" + } + ] + }, + "SMSTemplateResponseValues": { + "value": { + "created": "2024-04-25T17:35:02.000Z", + "id": "6NQUJ5yR3bpgEiYmq8IC", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Custom", + "template": "${org.name}: your verification code is ${code}", + "translations": { + "es": "${org.name}: el c\u00f3digo de verificaci\u00f3n es ${code}", + "fr": "${org.name}: votre code de v\u00e9rification est ${code}", + "it": "${org.name}: il codice di verifica \u00e8 ${code}" + }, + "type": "SMS_VERIFY_CODE" + } + }, + "Saml2.0Ex": { + "summary": "SAML_2_0", + "value": { + "label": "Example Custom SAML 2.0 App", + "settings": { + "signOn": { + "acsEndpoints": [ + { + "index": 0, + "url": "http://testorgone.okta" + }, + { + "index": 1, + "url": "http://testorgone.okta/1" + } + ], + "allowMultipleAcsEndpoints": true, + "assertionEncryption": { + "enabled": true, + "encryptionAlgorithm": "AES256_GCM", + "keyTransportAlgorithm": "RSA_15", + "x5c": [ + "MIIC6jCCAdKgAwIBAgIGAZKbFN7JMA0GCSqGSIb3DQEBCwUAMDYxNDAyBgNVBAMM\r\n" + ] + }, + "assertionSigned": true, + "attributeStatements": [ + { + "name": "Attribute", + "namespace": "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified", + "type": "EXPRESSION", + "values": [ + "Value" + ] + } + ], + "audience": "asdqwe123", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "defaultRelayState": "", + "destination": "http://testorgone.okta", + "digestAlgorithm": "SHA256", + "honorForceAuthn": true, + "idpIssuer": "http://www.okta.com/${org.externalKey}", + "participateSlo": { + "bindingType": "REDIRECT", + "enabled": true, + "logoutRequestUrl": "https://testorgone.okta.com/logout/participate", + "sessionIndexRequired": true + }, + "recipient": "http://testorgone.okta", + "requestCompressed": false, + "responseSigned": true, + "samlAssertionLifetimeSeconds": 3600, + "signatureAlgorithm": "RSA_SHA256", + "slo": { + "enabled": true, + "issuer": "https://testorgone.okta.com", + "logoutUrl": "https://testorgone.okta.com/logout" + }, + "spCertificate": { + "x5c": [ + "MIIFnDCCA4QCCQDBSLbiON2T1zANBgkqhkiG9w0BAQsFADCBjzELMAkGA1UEBhMCVVMxDjAMBgNV\r\n" + ] + }, + "ssoAcsUrl": "http://testorgone.okta", + "subjectNameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "subjectNameIdTemplate": "${user.userName}" + } + }, + "signOnMode": "SAML_2_0", + "visibility": { + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "Saml2.0PutEx": { + "summary": "SAML_2_0", + "value": { + "label": "Example Custom SAML 2.0 App updated", + "settings": { + "signOn": { + "acsEndpoints": [ + { + "index": 0, + "url": "http://testorgone.okta" + }, + { + "index": 1, + "url": "http://testorgone.okta/1" + } + ], + "allowMultipleAcsEndpoints": true, + "assertionEncryption": { + "enabled": true, + "encryptionAlgorithm": "AES256_GCM", + "keyTransportAlgorithm": "RSA_15", + "x5c": [ + "MIIC6jCCAdKgAwIBAgIGAZKbFN7JMA0GCSqGSIb3DQEBCwUAMDYxNDAyBgNVBAMM\r\n" + ] + }, + "assertionSigned": true, + "attributeStatements": [ + { + "name": "Attribute", + "namespace": "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified", + "type": "EXPRESSION", + "values": [ + "Value" + ] + } + ], + "audience": "asdqwe123", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "defaultRelayState": "", + "destination": "http://testorgone.okta", + "digestAlgorithm": "SHA256", + "honorForceAuthn": true, + "idpIssuer": "http://www.okta.com/${org.externalKey}", + "participateSlo": { + "bindingType": "REDIRECT", + "enabled": true, + "logoutRequestUrl": "https://testorgone.okta.com/logout/participate", + "sessionIndexRequired": true + }, + "recipient": "http://testorgone.okta", + "requestCompressed": false, + "responseSigned": true, + "samlAssertionLifetimeSeconds": 3600, + "signatureAlgorithm": "RSA_SHA256", + "slo": { + "enabled": true, + "issuer": "https://testorgone.okta.com", + "logoutUrl": "https://testorgone.okta.com/logout" + }, + "spCertificate": { + "x5c": [ + "MIIFnDCCA4QCCQDBSLbiON2T1zANBgkqhkiG9w0BAQsFADCBjzELMAkGA1UEBhMCVVMxDjAMBgNV\r\n..." + ] + }, + "ssoAcsUrl": "http://testorgone.okta", + "subjectNameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "subjectNameIdTemplate": "${user.userName}" + } + }, + "signOnMode": "SAML_2_0", + "visibility": { + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "Saml2.0PutResponseEx": { + "summary": "SAML_2_0", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "signing": { + "kid": "mh_16Cc8sIfHMFDMlHnp194cxKvJ6yXqs_mNn_6ZC0Q" + }, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Example Custom SAML 2.0 App updated", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "testorgone_examplecustomsaml20app_1", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_examplecustomsaml20app_1:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": {}, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "acsEndpoints": [], + "allowMultipleAcsEndpoints": false, + "assertionSigned": true, + "attributeStatements": [ + { + "name": "Attribute", + "namespace": "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified", + "type": "EXPRESSION", + "values": [ + "Value" + ] + } + ], + "audience": "asdqwe123", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "defaultRelayState": null, + "destination": "http://testorgone.okta", + "digestAlgorithm": "SHA256", + "honorForceAuthn": true, + "idpIssuer": "http://www.okta.com/${org.externalKey}", + "inlineHooks": [], + "recipient": "http://testorgone.okta", + "requestCompressed": false, + "responseSigned": true, + "samlAssertionLifetimeSeconds": 3600, + "samlSignedRequestEnabled": false, + "signatureAlgorithm": "RSA_SHA256", + "slo": { + "enabled": true, + "issuer": "https://testorgone.okta.com", + "logoutUrl": "https://testorgone.okta.com/logout" + }, + "spIssuer": "https://testorgone.okta.com", + "ssoAcsUrl": "http://testorgone.okta", + "subjectNameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "subjectNameIdTemplate": "${user.userName}" + } + }, + "signOnMode": "SAML_2_0", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "testorgone_examplecustomsaml20app_1_link": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "Saml2.0ResponseEx": { + "summary": "SAML_2_0", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "signing": { + "kid": "mh_16Cc8sIfHMFDMlHnp194cxKvJ6yXqs_mNn_6ZC0Q" + }, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Example Custom SAML 2.0 App", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "testorgone_examplecustomsaml20app_1", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_examplecustomsaml20app_1:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": {}, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + }, + "signOn": { + "acsEndpoints": [], + "allowMultipleAcsEndpoints": false, + "assertionSigned": true, + "attributeStatements": [ + { + "name": "Attribute", + "namespace": "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified", + "type": "EXPRESSION", + "values": [ + "Value" + ] + } + ], + "audience": "asdqwe123", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "defaultRelayState": null, + "destination": "http://testorgone.okta", + "digestAlgorithm": "SHA256", + "honorForceAuthn": true, + "idpIssuer": "http://www.okta.com/${org.externalKey}", + "inlineHooks": [], + "recipient": "http://testorgone.okta", + "requestCompressed": false, + "responseSigned": true, + "samlAssertionLifetimeSeconds": 3600, + "samlSignedRequestEnabled": false, + "signatureAlgorithm": "RSA_SHA256", + "slo": { + "enabled": true, + "issuer": "https://testorgone.okta.com", + "logoutUrl": "https://testorgone.okta.com/logout" + }, + "spIssuer": "https://testorgone.okta.com", + "ssoAcsUrl": "http://testorgone.okta", + "subjectNameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "subjectNameIdTemplate": "${user.userName}" + } + }, + "signOnMode": "SAML_2_0", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "testorgone_examplecustomsaml20app_1_link": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "SamlIdPResponse": { + "summary": "SAML 2.0 IdP", + "value": { + "_links": { + "acs": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/sso/saml2/0oa62bc8wppPw0UGr0h7", + "type": "application/xml" + }, + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/lifecycle/deactivate" + }, + "metadata": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/metadata.xml", + "type": "application/xml" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/users" + } + }, + "created": "2016-03-24T23:14:54.000Z", + "id": "0oa62bc8wppPw0UGr0h7", + "lastUpdated": "2016-03-24T23:14:54.000Z", + "name": "Example SAML IdP", + "policy": { + "accountLink": { + "action": "AUTO", + "filter": null + }, + "mapAMRClaims": false, + "maxClockSkew": 0, + "provisioning": { + "action": "AUTO", + "conditions": { + "deprovisioned": { + "action": "NONE" + }, + "suspended": { + "action": "NONE" + } + }, + "groups": { + "action": "NONE" + }, + "profileMaster": true + }, + "subject": { + "filter": "(\\S+@example\\.com)", + "matchType": "USERNAME", + "userNameTemplate": { + "template": "saml.subjectNameId" + } + }, + "trustClaims": false + }, + "protocol": { + "algorithms": { + "request": { + "signature": { + "algorithm": "SHA-256", + "scope": "REQUEST" + } + }, + "response": { + "signature": { + "algorithm": "SHA-256", + "scope": "ANY" + } + } + }, + "credentials": { + "trust": { + "additionalKids": [ + "additional-key-id" + ], + "audience": "http://www.okta.com/123", + "issuer": "https://idp.example.com", + "kid": "your-key-id" + } + }, + "endpoints": { + "acs": { + "binding": "HTTP-POST", + "type": "INSTANCE" + }, + "slo": { + "binding": "HTTP-POST", + "url": "https://idp.example.com/slo" + }, + "sso": { + "binding": "HTTP-POST", + "destination": "https://idp.example.com", + "url": "https://idp.example.com" + } + }, + "settings": { + "nameFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "participateSlo": true + }, + "type": "SAML2" + }, + "status": "ACTIVE", + "type": "SAML2" + } + }, + "ScimBearerAuthSettings": { + "summary": "SCIM bearer auth settings example", + "value": { + "authType": "SCIM_BEARER" + } + }, + "ScimHeaderAuthSettings": { + "summary": "SCIM header auth settings example", + "value": { + "authType": "SCIM_HEADER" + } + }, + "SecurePasswordStoreEx": { + "summary": "SECURE_PASSWORD_STORE", + "value": { + "label": "Example SWA App", + "name": "template_sps", + "settings": { + "app": { + "optionalField1": "param1", + "optionalField1Value": "somevalue", + "optionalField2": "param2", + "optionalField2Value": "yetanothervalue", + "optionalField3": "param3", + "optionalField3Value": "finalvalue", + "passwordField": "#txtbox-password", + "url": "https://example.com/login.html", + "usernameField": "#txtbox-username" + } + }, + "signOnMode": "SECURE_PASSWORD_STORE" + } + }, + "SecurePasswordStorePutEx": { + "summary": "SECURE_PASSWORD_STORE", + "value": { + "label": "Example SWA App updated", + "name": "template_sps", + "settings": { + "app": { + "optionalField1": "param1", + "optionalField1Value": "somevalue_updated", + "optionalField2": "param2", + "optionalField2Value": "yetanothervalue", + "optionalField3": "param3", + "optionalField3Value": "finalvalue_updated", + "passwordField": "#txtbox-password", + "url": "https://example.com/login.html", + "usernameField": "#txtbox-username" + } + }, + "signOnMode": "SECURE_PASSWORD_STORE" + } + }, + "SecurePasswordStorePutResponseEx": { + "summary": "SECURE_PASSWORD_STORE", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "revealPassword": false, + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Example SWA App updated", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "template_sps", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_sps:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "optionalField1": "param1", + "optionalField1Value": "somevalue_updated", + "optionalField2": "param2", + "optionalField2Value": "yetanothervalue", + "optionalField3": "param3", + "optionalField3Value": "finalvalue_updated", + "passwordField": "#txtbox-password", + "url": "https://example.com/login.html", + "usernameField": "#txtbox-username" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "SECURE_PASSWORD_STORE", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "SecurePasswordStoreResponseEx": { + "summary": "SECURE_PASSWORD_STORE", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "revealPassword": false, + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "signing": {}, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Example SWA App", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "template_sps", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_sps:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "optionalField1": "param1", + "optionalField1Value": "somevalue", + "optionalField2": "param2", + "optionalField2Value": "yetanothervalue", + "optionalField3": "param3", + "optionalField3Value": "finalvalue", + "passwordField": "#txtbox-password", + "url": "https://example.com/login.html", + "usernameField": "#txtbox-username" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "SECURE_PASSWORD_STORE", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "SecurityEventTokenJwtHeaderExample": { + "summary": "Example JWT header", + "value": { + "alg": "RS256", + "kid": "kid", + "typ": "secevent+jwt" + } + }, + "SecurityEventsProviderRequestIssuerAndJwksUrl": { + "summary": "Provider with issuer and JWKS", + "value": { + "name": "Security events provider with an issuer and a JWKS URL", + "settings": { + "issuer": "Issuer", + "jwks_url": "https://example.okta.com/jwks/path" + }, + "type": "okta" + } + }, + "SecurityEventsProviderRequestWellKnownUrl": { + "summary": "Provider with well-known URL", + "value": { + "name": "Security events provider with well-known URL", + "settings": { + "well_known_url": "https://example.okta.com/.well-known/ssf-configuration" + }, + "type": "okta" + } + }, + "SecurityEventsProviderResponseIssuerAndJwksUrl": { + "summary": "Provider with issuer and JWKS", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.okta.com/api/v1/security-events-providers/sse1qu4fUtsoD12iF0g5/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://example.okta.com/api/v1/security-events-providers/sse1qu4fUtsoD12iF0g5" + } + }, + "id": "sse1qu4fUtsoD12iF0g5", + "name": "Security events provider with an issuer and a JWKS URL", + "settings": { + "issuer": "Issuer", + "jwks_url": "https://example.okta.com/jwks/path" + }, + "status": "ACTIVE", + "type": "okta" + } + }, + "SecurityEventsProviderResponseWellKnownUrl": { + "summary": "Provider with well-known URL", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://example.okta.com/api/v1/security-events-providers/sse1qg25RpusjUP6m0g5/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://example.okta.com/api/v1/security-events-providers/sse1qg25RpusjUP6m0g5" + } + }, + "id": "sse1qg25RpusjUP6m0g5", + "name": "Security events provider with well-known URL", + "settings": { + "issuer": "Issuer", + "jwks_url": "https://example.okta.com/jwks/path", + "well_known_url": "https://example.okta.com/.well-known/ssf-configuration" + }, + "status": "ACTIVE", + "type": "okta" + } + }, + "SendPinRequestExample": { + "summary": "Send PIN request", + "value": { + "authenticatorEnrollmentId": "fwf5ajzJEWqknX6lk0g4", + "fulfillmentProvider": "yubico", + "userId": "00us2hPODQncCkxef0g3" + } + }, + "Set-User-Classification-Example": { + "value": { + "type": "LITE" + } + }, + "SimulatePolicyBody": { + "summary": "Simulate policy request body", + "value": { + "appInstance": "0oa4eroj3nYCIJIW70g7", + "policyContext": { + "device": { + "managed": true, + "platform": "IOS", + "registered": true + }, + "groups": { + "ids": [ + "00g4eralvekR5RLuS0g7", + "00g4eralvekR5RLuS0g8" + ] + }, + "risk": { + "level": "LOW" + }, + "zones": { + "ids": [ + "nzo4eralxcRnbIHYJ0g7" + ] + } + }, + "policyType": [ + "OKTA_SIGN_ON", + "MFA_ENROLL" + ] + } + }, + "SimulatePolicyElExpressionBody": { + "summary": "Simulate policy request body with EL context", + "value": { + "appInstance": "0oa4fdudGhhB5FNKR0g4", + "policyContext": { + "user": { + "created": "2024-04-29T18:05:24.000Z", + "id": "00u10wvS3zms2JVaO0g4", + "lastLogin": "2024-04-29T18:05:24.000Z", + "lastUpdated": "2024-04-29T18:05:24.000Z", + "passwordChanged": "2024-04-29T18:05:24.000Z", + "profile": { + "city": "string", + "costCenter": "string", + "countryCode": "st", + "department": "string", + "displayName": "string", + "division": "string", + "email": "user@example.com", + "employeeNumber": "string", + "firstName": "string", + "honorificPrefix": "string", + "honorificSuffix": "string", + "lastName": "string", + "locale": "string", + "login": "string", + "manager": "string", + "managerId": "string", + "middleName": "string", + "mobilePhone": "string", + "nickName": "string", + "organization": "string", + "postalAddress": "string", + "preferredLanguage": "string", + "primaryPhone": "string", + "profileUrl": "string", + "secondEmail": "user@example.com", + "state": "string", + "streetAddress": "string", + "timezone": "string", + "title": "string", + "userType": "string", + "zipCode": "string" + }, + "status": "ACTIVE" + } + } + } + }, + "SimulatePolicyElExpressionResponse": { + "summary": "Simulate policy response body with EL context", + "value": { + "evaluation": [ + { + "evaluated": { + "policies": [] + }, + "policyType": "OKTA_SIGN_ON", + "result": { + "policies": [ + { + "conditions": [], + "id": "00p4eromwukk6qUku0g7", + "name": "test policy", + "rules": [ + { + "conditions": [ + { + "status": "MATCH", + "type": "people.groups.include" + } + ], + "id": "0pr4erof85nGcyC7Y0g7", + "name": "test rule", + "status": "MATCH" + } + ], + "status": "MATCH" + } + ] + }, + "status": null, + "undefined": { + "policies": [] + } + }, + { + "evaluated": { + "policies": [] + }, + "policyType": "MFA_ENROLL", + "result": { + "policies": [ + { + "conditions": [], + "id": "00p4eram2kw1aLcrx0g7", + "name": "Default Policy", + "rules": [ + { + "conditions": [], + "id": "0pr4eram2lMQT5FZF0g7", + "name": null, + "status": "MATCH" + } + ], + "status": "MATCH" + } + ] + }, + "status": null, + "undefined": { + "policies": [] + } + }, + { + "evaluated": { + "policies": [] + }, + "policyType": "ACCESS_POLICY", + "result": { + "policies": [ + { + "conditions": [], + "id": "rst4eram06ZKZewEe0g7", + "name": "Any two factors", + "rules": [ + { + "conditions": [], + "id": "rul4eram07VsWgybo0g7", + "name": "Catch-all rule", + "status": "MATCH" + } + ], + "status": "MATCH" + } + ] + }, + "status": null, + "undefined": { + "policies": [] + } + }, + { + "evaluated": { + "policies": [] + }, + "policyType": "PROFILE_ENROLLMENT", + "result": { + "policies": [ + { + "conditions": [], + "id": "rst4eram08ZSjPTOl0g7", + "name": "Default Policy", + "rules": [ + { + "conditions": [], + "id": "rul4eram094PrQ2BX0g7", + "name": "Catch-all rule", + "status": "MATCH" + } + ], + "status": "MATCH" + } + ] + }, + "status": null, + "undefined": { + "policies": [] + } + } + ] + } + }, + "SimulatePolicyResponse": { + "summary": "Simulate policy response body", + "value": { + "evaluation": [ + { + "evaluated": { + "policies": [] + }, + "policyType": "OKTA_SIGN_ON", + "result": { + "policies": [ + { + "conditions": [], + "id": "00p4eromwukk6qUku0g7", + "name": "test policy", + "rules": [ + { + "conditions": [ + { + "status": "MATCH", + "type": "people.groups.include" + } + ], + "id": "0pr4erof85nGcyC7Y0g7", + "name": "test rule", + "status": "MATCH" + } + ], + "status": "MATCH" + } + ] + }, + "status": null, + "undefined": { + "policies": [] + } + }, + { + "evaluated": { + "policies": [] + }, + "policyType": "MFA_ENROLL", + "result": { + "policies": [ + { + "conditions": [], + "id": "00p4eram2kw1aLcrx0g7", + "name": "Default Policy", + "rules": [ + { + "conditions": [], + "id": "0pr4eram2lMQT5FZF0g7", + "name": null, + "status": "MATCH" + } + ], + "status": "MATCH" + } + ] + }, + "status": null, + "undefined": { + "policies": [] + } + }, + { + "evaluated": { + "policies": [] + }, + "policyType": "ACCESS_POLICY", + "result": { + "policies": [ + { + "conditions": [], + "id": "rst4eram06ZKZewEe0g7", + "name": "Any two factors", + "rules": [ + { + "conditions": [], + "id": "rul4eram07VsWgybo0g7", + "name": "Catch-all rule", + "status": "MATCH" + } + ], + "status": "MATCH" + } + ] + }, + "status": null, + "undefined": { + "policies": [] + } + }, + { + "evaluated": { + "policies": [] + }, + "policyType": "PROFILE_ENROLLMENT", + "result": { + "policies": [ + { + "conditions": [], + "id": "rst4eram08ZSjPTOl0g7", + "name": "Default Policy", + "rules": [ + { + "conditions": [], + "id": "rul4eram094PrQ2BX0g7", + "name": "Catch-all rule", + "status": "MATCH" + } + ], + "status": "MATCH" + } + ] + }, + "status": null, + "undefined": { + "policies": [] + } + } + ] + } + }, + "SmartCardIdPResponse": { + "summary": "SmartCard IdP", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}.okta.com/api/v1/idps/0oa6jxasyhwM2ZHJh0g4/lifecycle/deactivate" + }, + "keys": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}.okta.com/api/v1/idps/credentials/keys/45dec5ff-8cdc-48c0-85fe-a4869f1753dc" + }, + "users": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}.okta.com/api/v1/idps/0oa6jxasyhwM2ZHJh0g4/users" + } + }, + "created": "2020-01-07T00:19:27.000Z", + "id": "0oa6jxasyhwM2ZHJh0g4", + "lastUpdated": "2020-01-07T00:19:27.000Z", + "name": "Smart Card IDP Name", + "policy": { + "mapAMRClaims": false, + "maxClockSkew": 120000, + "provisioning": { + "action": "DISABLED", + "groups": null, + "profileMaster": false + }, + "subject": { + "filter": null, + "matchAttribute": null, + "matchType": "EMAIL", + "userNameTemplate": { + "template": "idpuser.subjectAltNameEmail" + } + }, + "trustClaims": false + }, + "properties": { + "additionalAmr": [ + "sc", + "hwk", + "pin", + "mfa" + ] + }, + "protocol": { + "credentials": { + "trust": { + "audience": null, + "issuer": "CN=Test Smart Card, OU=Test OU, O=Test O, C=US", + "kid": "45dec5ff-8cdc-48c0-85fe-a4869f1753dc", + "revocation": "CRL", + "revocationCacheLifetime": 2880 + } + }, + "endpoints": { + "sso": { + "url": "https://{yourOktaDomain}.okta.com/login/cert" + } + }, + "type": "MTLS" + }, + "status": "ACTIVE", + "type": "X509" + } + }, + "SocialAuthTokensResponse": { + "summary": "Social authentication tokens", + "value": [ + { + "expiresAt": "2014-08-06T16:56:31.000Z", + "id": "", + "scopes": [ + "openid", + "foo" + ], + "token": "JBTWGV22G4ZGKV3N", + "tokenAuthScheme": "Bearer", + "tokenType": "urn:ietf:params:oauth:token-type:access_token" + }, + { + "id": "", + "token": "JBTWGV22G4ZJBRXJ", + "tokenAuthScheme": null, + "tokenType": "urn:ietf:params:oauth:token-type:id_token" + } + ] + }, + "StandardAndCustomRolesListResponse": { + "value": [ + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00ur32Vg0fvpyHZeQ0g3" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:17:40.000Z", + "id": "IFIFAX2BIRGUSTQ", + "label": "Application administrator", + "lastUpdated": "2019-02-06T16:17:40.000Z", + "status": "ACTIVE", + "type": "APP_ADMIN" + }, + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00ur32Vg0fvpyHZeQ0g3" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:17:40.000Z", + "id": "JBCUYUC7IRCVGS27IFCE2SKO", + "label": "Help Desk administrator", + "lastUpdated": "2019-02-06T16:17:40.000Z", + "status": "ACTIVE", + "type": "HELP_DESK_ADMIN" + }, + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00ur32Vg0fvpyHZeQ0g3" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:17:40.000Z", + "id": "ra125eqBFpETrMwu80g4", + "label": "Organization administrator", + "lastUpdated": "2019-02-06T16:17:40.000Z", + "status": "ACTIVE", + "type": "ORG_ADMIN" + }, + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1ousb3XCr9Dkr20g4" + } + }, + "assignmentType": "GROUP", + "created": "2019-02-06T16:20:57.000Z", + "id": "gra25fapn1prGTBKV0g4", + "label": "API Access Management administrator", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "status": "ACTIVE", + "type": "API_ACCESS_MANAGEMENT_ADMIN" + }, + { + "_links": { + "assignee": { + "href\"": "https://{yourOktaDomain}/api/v1/users/00u1gytb3XCr9Dkr18r2" + }, + "member": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3/members/irb1qe6PGuMc7Oh8N0g4" + }, + "permissions": { + "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/cr0Yq6IJxGIr0ouum0g3/permissions" + }, + "resource-set": { + "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" + }, + "role": { + "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb1q92TFAHzySt3x0g4", + "label": "UserCreatorRole", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "iamoJDFKaJxGIr0oamd9g", + "role": "cr0Yq6IJxGIr0ouum0g3", + "status": "ACTIVE", + "type": "CUSTOM" + }, + { + "_links": { + "assignee": { + "href": "https://{ yourOktaDomain }/api/v1/groups/00g1ousb3XCr9Dkr20g4" + }, + "member": { + "href": "https://{ yourOktaDomain }/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3/members/irb1qe6PGuMc7Oh8N0g4" + }, + "permissions": { + "href": "https://{ yourOktaDomain }/api/v1/iam/permission-sets/cr0Yq6IJxGIr0ouum0g3/permissions" + }, + "resource-set": { + "href": "https://{ yourOktaDomain }/api/v1/iam/resource-sets/iamoakjsdQaJxGIr03int1o" + }, + "role": { + "href": "https://{ yourOktaDomain }/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" + } + }, + "assignmentType": "GROUP", + "created": "2019-02-06T16:20:57.000Z", + "id": "irb5e92YgBazyyQ3x1q5", + "label": "UserCreatorRole", + "lastUpdated": "2019-02-06T16:20:57.000Z", + "resource-set": "iamoakjsdQaJxGIr03int1o", + "role": "cr0Yq6IJxGIr0ouum0g3", + "status": "ACTIVE", + "type": "CUSTOM" + } + ] + }, + "StandardRoleAssignmentRequest": { + "value": { + "type": "HELP_DESK_ADMIN" + } + }, + "StandardRoleResponseClient": { + "value": { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0jrabyQWm4B9zVJPbotY/roles" + } + }, + "assignmentType": "CLIENT", + "created": "2023-05-01T14:24:54.000Z", + "id": "JBCUYUC7IRCVGS27IFCE2SKO", + "label": "Help Desk Administrator", + "lastUpdated": "2023-05-01T14:24:54.000Z", + "status": "ACTIVE", + "type": "HELP_DESK_ADMIN" + } + }, + "StandardRoleResponseUser": { + "value": { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + } + }, + "assignmentType": "USER", + "created": "2015-09-06T15:28:47.000Z", + "id": "ra1b8anIk7rx7em7L0g4", + "label": "Super Organization administrator", + "lastUpdated": "2015-09-06T15:28:47.000Z", + "status": "ACTIVE", + "type": "SUPER_ADMIN" + } + }, + "StandardRolesListResponse": { + "value": [ + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00ur32Vg0fvpyHZeQ0g3" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:17:40.000Z", + "id": "IFIFAX2BIRGUSTQ", + "label": "Application administrator", + "lastUpdated": "2019-02-06T16:17:40.000Z", + "status": "ACTIVE", + "type": "APP_ADMIN" + }, + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00ur32Vg0fvpyHZeQ0g3" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:17:40.000Z", + "id": "JBCUYUC7IRCVGS27IFCE2SKO", + "label": "Help Desk administrator", + "lastUpdated": "2019-02-06T16:17:40.000Z", + "status": "ACTIVE", + "type": "HELP_DESK_ADMIN" + }, + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00ur32Vg0fvpyHZeQ0g3" + } + }, + "assignmentType": "USER", + "created": "2019-02-06T16:17:40.000Z", + "id": "ra125eqBFpETrMwu80g4", + "label": "Organization administrator", + "lastUpdated": "2019-02-06T16:17:40.000Z", + "status": "ACTIVE", + "type": "ORG_ADMIN" + }, + { + "_links\"": { + "assignee\"": { + "href\"": "https://{yourOktaDomain}/api/v1/groups/00g1ousb3XCr9Dkr20g4" + } + }, + "assignmentType\"": "GROUP", + "created\"": "2019-02-06T16:20:57.000Z", + "id": "gra25fapn1prGTBKV0g4", + "label": "API Access Management administrator", + "lastUpdated\"": "2019-02-06T16:20:57.000Z", + "status": "ACTIVE", + "type": "API_ACCESS_MANAGEMENT_ADMIN" + } + ] + }, + "StandardRolesListResponseClient": { + "value": [ + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0jrabyQWm4B9zVJPbotY/roles" + } + }, + "assignmentType": "CLIENT", + "created": "2023-05-01T14:24:54.000Z", + "id": "JBCUYUC7IRCVGS27IFCE2SKO", + "label": "Help Desk Administrator", + "lastUpdated": "2023-05-01T14:24:54.000Z", + "status": "ACTIVE", + "type": "HELP_DESK_ADMIN" + } + ] + }, + "StandardRolesListResponseGroup": { + "value": [ + { + "_links": { + "assignee": { + "href": "https://{yourOktaDomain}/api/v1/users/00ur32Vg0fvpyHZeQ0g3" + } + }, + "assignmentType": "GROUP", + "created": "2019-02-06T16:17:40.000Z", + "id": "IFIFAX2BIRGUSTQ", + "label": "Application Administrator", + "lastUpdated": "2019-02-06T16:17:40.000Z", + "status": "ACTIVE", + "type": "APP_ADMIN" + } + ] + }, + "SubmissionAPIServiceResponse": { + "summary": "Example of submission API Service response", + "value": { + "apiService": { + "authenticationMethod": "client_secret_basic", + "scopes": [ + "okta.users.manage", + "okta.groups.read" + ], + "setupInstructionsUri": "https://doc.example.com/api-service-setup" + }, + "capabilities": [ + { + "capability": "API_SERVICE", + "supportedProtocols": [ + "OAUTH2" + ] + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals", + "id": "acme_strawberrycentral_api_1", + "isNonFunctionalOnlySubmission": false, + "lastPublished": "2023-09-01T13:23:45.000Z", + "lastUpdated": "2023-08-24T14:15:22.000Z", + "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "status": "Complete", + "useCases": [ + "API Service" + ] + } + }, + "SubmissionActions": { + "summary": "Submission actions example", + "value": { + "actions": [ + { + "id": "okta:action1", + "provider": { + "externalId": "JKL490DQNV", + "type": "WORKFLOWS" + } + } + ] + } + }, + "SubmissionCapabilities": { + "summary": "Example of submission capabilities", + "value": { + "capabilities": [ + { + "capability": "SSO", + "supportedProtocols": [ + "SAML", + "OIDC" + ] + }, + { + "capability": "PROVISIONING", + "supportedProtocols": [ + "ACTIONS" + ] + } + ] + } + }, + "SubmissionEMRequest": { + "summary": "Submission SCIM with entitlements request example", + "value": { + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "description": "Your one source for in-season strawberry deals", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "provisioning": { + "features": [ + "CREATE_USER", + "READ_USER", + "UPDATE_USER", + "DEACTIVATE_USER", + "IMPORT_USER_SCHEMA", + "CREATE_GROUP", + "READ_GROUP", + "UPDATE_GROUP", + "DEACTIVATE_GROUP" + ], + "scim": { + "authMode": "header", + "baseUri": "'https://' + app.subdomain + '.example.com/scim/v2'", + "entitlementTypes": [ + { + "attributes": { + "multivalued": false, + "required": true + }, + "description": "Roles", + "endpoint": "/Roles", + "mappings": { + "description": "description", + "displayName": "roleName", + "id": "roleId" + }, + "name": "Role" + } + ], + "scimServerConfig": { + "changePassword": { + "supported": true + }, + "patch": { + "supported": true + } + }, + "setupInstructionsUri": "https://doc.example.com/scim-provisioning" + } + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "SubmissionEMResponse": { + "summary": "Submission SCIM with entitlements response example", + "value": { + "capabilities": [ + { + "capability": "PROVISIONING", + "supportedProtocols": [ + "SCIM" + ] + } + ], + "caseLastUpdated": "2024-01-15T10:30:45.000Z", + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "id": "acme_strawberrycentral_1", + "isNonFunctionalOnlySubmission": false, + "lastPublished": null, + "lastUpdated": "2023-08-24T14:15:22.000Z", + "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "oinFeatures": "SCIM", + "provisioning": { + "features": [ + "CREATE_USER", + "READ_USER", + "UPDATE_USER", + "DEACTIVATE_USER", + "IMPORT_USER_SCHEMA", + "CREATE_GROUP", + "READ_GROUP", + "UPDATE_GROUP", + "DEACTIVATE_GROUP" + ], + "scim": { + "authMode": "header", + "baseUri": "'https://' + app.subdomain + '.example.com/scim/v2'", + "entitlementTypes": [ + { + "attributes": { + "multivalued": false, + "required": true + }, + "description": "Roles", + "endpoint": "/Roles", + "mappings": { + "description": "description", + "displayName": "roleName", + "id": "roleId" + }, + "name": "Role" + } + ], + "scimServerConfig": { + "changePassword": { + "supported": true + }, + "patch": { + "supported": true + } + }, + "setupInstructionsUri": "https://doc.example.com/scim-provisioning" + } + }, + "status": "To be reviewed by Okta", + "useCases": [ + "Provisioning" + ] + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "SubmissionIdvResponse": { + "summary": "Example of submission IDV response", + "value": { + "capabilities": [ + { + "capability": "IDV", + "supportedProtocols": [ + "ID_PROOFING" + ] + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals with identity verification", + "id": "acme_strawberryidv_1", + "idv": { + "authorizeUrl": "https://auth.example.com/oauth/authorize", + "configUrl": "https://example.com/config/url", + "issuerUrl": "https://auth.example.com/", + "jwksUrl": "https://auth.example.com/.well-known/jwks.json", + "parUrl": "https://auth.example.com/oauth/par", + "privacyPolicyUrl": "https://example.com/legal/privacy", + "termsOfUseUrl": "https://example.com/legal/eula", + "tokenUrl": "https://auth.example.com/oauth/token" + }, + "lastUpdated": "2026-04-23T14:23:58.000Z", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "updatedBy": "00ub0oNGTSWTBKOLGLNR", + "useCases": [ + "IDENTITY_VERIFICATION" + ] + } + }, + "SubmissionItemResponse": { + "summary": "Submission item example", + "value": [ + { + "caseLastUpdated": "2024-01-15T10:30:45.000Z", + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "id": "acme_strawberrycentral_1", + "isNonFunctionalOnlySubmission": false, + "lastPublished": "2023-09-01T13:23:45.000Z", + "lastUpdated": "2023-08-24T14:15:22.000Z", + "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "oinFeatures": "SCIM", + "provisioning": { + "features": [ + "CREATE_USER", + "READ_USER", + "UPDATE_USER", + "DEACTIVATE_USER", + "IMPORT_USER_SCHEMA", + "CREATE_GROUP", + "READ_GROUP", + "UPDATE_GROUP", + "DEACTIVATE_GROUP" + ], + "scim": { + "authMode": "header", + "baseUri": "'https://' + app.subdomain + '.example.com/scim/v2'", + "scimServerConfig": { + "changePassword": { + "supported": true + }, + "patch": { + "supported": true + } + }, + "setupInstructionsUri": "https://doc.example.com/scim-provisioning" + } + }, + "sso": { + "saml": { + "acs": [ + { + "url": "https://${org.subdomain}.example.com/saml/login" + } + ], + "claims": [ + { + "name": "manager", + "values": [ + "${user.manager}" + ] + } + ], + "doc": "https://example.com/strawberry/help/samlSetup", + "entityId": "https://${org.subdomain}.example.com", + "groups": [ + { + "name": "groups" + } + ] + } + }, + "status": "Complete", + "useCases": [ + "SSO", + "Provisioning" + ] + } + ] + }, + "SubmissionOidcRequest": { + "summary": "Submission OIDC request example", + "value": { + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "description": "Your one source for in-season strawberry deals", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "sso": { + "oidc": { + "doc": "https://example.com/strawberry/help/oidcSetup", + "initiateLoginUri": "https://{app.subdomain}.example.com/strawberry/oidc/sp-init", + "postLogoutUris": [ + "https://{app.subdomain}.example.com/strawberry/oidc/logged-out" + ], + "redirectUris": [ + "https://{app.subdomain}.example.com/strawberry/oidc/login" + ] + } + } + } + }, + "SubmissionOidcResponse": { + "summary": "Example of submission OIDC response", + "value": { + "capabilities": [ + { + "capability": "SSO", + "supportedProtocols": [ + "OIDC" + ] + } + ], + "caseLastUpdated": "2024-01-15T10:30:45.000Z", + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "id": "acme_strawberrycentral_1", + "isNonFunctionalOnlySubmission": false, + "lastPublished": "2023-09-01T13:23:45.000Z", + "lastUpdated": "2023-08-24T14:15:22.000Z", + "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "oinFeatures": "OIDC", + "sso": { + "oidc": { + "doc": "https://example.com/strawberry/help/oidcSetup", + "initiateLoginUri": "https://{app.subdomain}.example.com/strawberry/oidc/sp-init", + "postLogoutUris": [ + "https://{app.subdomain}.example.com/strawberry/oidc/logged-out" + ], + "redirectUris": [ + "https://{app.subdomain}.example.com/strawberry/oidc/login" + ] + } + }, + "status": "New", + "useCases": [ + "SSO" + ] + } + }, + "SubmissionSamlRequest": { + "summary": "Submission SAML request example", + "value": { + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "description": "Your one source for in-season strawberry deals", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "sso": { + "saml": { + "acs": [ + { + "url": "https://${org.subdomain}.example.com/saml/login" + } + ], + "claims": [ + { + "name": "manager", + "values": [ + "${user.manager}" + ] + } + ], + "doc": "https://example.com/strawberry/help/samlSetup", + "entityId": "https://${org.subdomain}.example.com", + "groups": [ + { + "name": "groups" + } + ] + } + } + } + }, + "SubmissionSamlResponse": { + "summary": "Submission SAML response example", + "value": { + "capabilities": [ + { + "capability": "SSO", + "supportedProtocols": [ + "SAML" + ] + } + ], + "caseLastUpdated": "2024-01-15T10:30:45.000Z", + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "id": "acme_strawberrycentral_1", + "isNonFunctionalOnlySubmission": false, + "lastPublished": null, + "lastUpdated": "2023-08-24T14:15:22.000Z", + "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "oinFeatures": "SAML", + "sso": { + "saml": { + "acs": [ + { + "url": "https://${org.subdomain}.example.com/saml/login" + } + ], + "claims": [ + { + "name": "manager", + "values": [ + "${user.manager}" + ] + } + ], + "doc": "https://example.com/strawberry/help/samlSetup", + "entityId": "https://${org.subdomain}.example.com", + "groups": [ + { + "name": "groups" + } + ] + } + }, + "status": "To be reviewed by Okta", + "useCases": [ + "SSO" + ] + } + }, + "SubmissionScimRequest": { + "summary": "Submission SCIM request example", + "value": { + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "description": "Your one source for in-season strawberry deals", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "provisioning": { + "features": [ + "CREATE_USER", + "READ_USER", + "UPDATE_USER", + "DEACTIVATE_USER", + "IMPORT_USER_SCHEMA", + "CREATE_GROUP", + "READ_GROUP", + "UPDATE_GROUP", + "DEACTIVATE_GROUP" + ], + "scim": { + "authMode": "header", + "baseUri": "'https://' + app.subdomain + '.example.com/scim/v2'", + "scimServerConfig": { + "changePassword": { + "supported": true + }, + "patch": { + "supported": true + } + }, + "setupInstructionsUri": "https://doc.example.com/scim-provisioning" + } + } + }, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "SubmissionScimResponse": { + "summary": "Submission SCIM response example", + "value": { + "capabilities": [ + { + "capability": "PROVISIONING", + "supportedProtocols": [ + "SCIM" + ] + } + ], + "caseLastUpdated": "2024-01-15T10:30:45.000Z", + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "id": "acme_strawberrycentral_1", + "isNonFunctionalOnlySubmission": false, + "lastPublished": null, + "lastUpdated": "2023-08-24T14:15:22.000Z", + "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "oinFeatures": "SCIM", + "provisioning": { + "features": [ + "CREATE_USER", + "READ_USER", + "UPDATE_USER", + "DEACTIVATE_USER", + "IMPORT_USER_SCHEMA", + "CREATE_GROUP", + "READ_GROUP", + "UPDATE_GROUP", + "DEACTIVATE_GROUP" + ], + "scim": { + "authMode": "header", + "baseUri": "'https://' + app.subdomain + '.example.com/scim/v2'", + "scimServerConfig": { + "changePassword": { + "supported": true + }, + "patch": { + "supported": true + } + }, + "setupInstructionsUri": "https://doc.example.com/scim-provisioning" + } + }, + "status": "To be reviewed by Okta", + "useCases": [ + "Provisioning" + ] + }, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "SubmissionUniversalLogoutResponse": { + "summary": "Submission with Universal Logout and Actions example", + "value": { + "capabilities": [ + { + "capability": "SSO", + "supportedProtocols": [ + "SAML" + ] + }, + { + "actions": [ + { + "id": "okta:universal_logout", + "provider": { + "externalId": "WF003LOGOUT", + "type": "WORKFLOWS" + } + }, + { + "id": "okta:session_cleanup", + "provider": { + "externalId": "WF004CLEANUP", + "type": "WORKFLOWS" + } + } + ], + "capability": "UNIVERSAL_LOGOUT", + "supportedProtocols": [ + "ACTIONS" + ] + } + ], + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals with advanced logout", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "id": "acme_strawberrycentral_2", + "isNonFunctionalOnlySubmission": false, + "lastPublished": null, + "lastUpdated": "2023-08-24T14:15:22.000Z", + "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central Plus", + "sso": { + "saml": { + "acs": [ + { + "url": "https://${org.subdomain}.example.com/saml/login" + } + ], + "claims": [ + { + "name": "email", + "values": [ + "${user.email}" + ] + } + ], + "doc": "https://example.com/strawberry/help/samlSetup", + "entityId": "https://${org.subdomain}.example.com", + "groups": [ + { + "name": "groups" + } + ] + } + }, + "status": "To be reviewed by Okta", + "useCases": [ + "SSO" + ] + } + }, + "SubmissionsResponse": { + "summary": "Submission list example", + "value": [ + { + "caseLastUpdated": "2024-01-15T10:30:45.000Z", + "config": [ + { + "label": "Subdomain", + "name": "subdomain" + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals", + "globalTokenRevocation": { + "authMethod": "SIGNED_JWT", + "endpoint": "'https://' + app.subdomain + '.example.org/gtr'", + "partialLogout": false, + "subjectFormat": "EMAIL" + }, + "id": "acme_strawberrycentral_1", + "isNonFunctionalOnlySubmission": false, + "lastPublished": "2023-09-01T13:23:45.000Z", + "lastUpdated": "2023-08-24T14:15:22.000Z", + "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "oinFeatures": "SCIM", + "provisioning": { + "features": [ + "CREATE_USER", + "READ_USER", + "UPDATE_USER", + "DEACTIVATE_USER", + "IMPORT_USER_SCHEMA", + "CREATE_GROUP", + "READ_GROUP", + "UPDATE_GROUP", + "DEACTIVATE_GROUP" + ], + "scim": { + "authMode": "header", + "baseUri": "'https://' + app.subdomain + '.example.com/scim/v2'", + "scimServerConfig": { + "changePassword": { + "supported": true + }, + "patch": { + "supported": true + } + }, + "setupInstructionsUri": "https://doc.example.com/scim-provisioning" + } + }, + "sso": { + "saml": { + "acs": [ + { + "url": "https://${org.subdomain}.example.com/saml/login" + } + ], + "claims": [ + { + "name": "manager", + "values": [ + "${user.manager}" + ] + } + ], + "doc": "https://example.com/strawberry/help/samlSetup", + "entityId": "https://${org.subdomain}.example.com", + "groups": [ + { + "name": "groups" + } + ] + } + }, + "status": "Complete", + "useCases": [ + "SSO", + "Provisioning" + ] + }, + { + "apiService": { + "authenticationMethod": "client_secret_basic", + "scopes": [ + "okta.users.manage", + "okta.groups.read" + ], + "setupInstructionsUri": "https://doc.example.com/api-service-setup" + }, + "capabilities": [ + { + "capability": "API_SERVICE", + "supportedProtocols": [ + "OAUTH2" + ] + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals", + "id": "acme_strawberrycentral_api_1", + "isNonFunctionalOnlySubmission": false, + "lastPublished": "2023-09-01T13:23:45.000Z", + "lastUpdated": "2023-08-24T14:15:22.000Z", + "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "status": "Complete", + "useCases": [ + "API Service" + ] + }, + { + "capabilities": [ + { + "capability": "IDV", + "supportedProtocols": [ + "ID_PROOFING" + ] + } + ], + "defaultLogo": false, + "description": "Your one source for in-season strawberry deals with identity verification", + "id": "acme_strawberryidv_1", + "idv": { + "authorizeUrl": "https://auth.example.com/oauth/authorize", + "configUrl": "https://example.com/config/url", + "issuerUrl": "https://auth.example.com/", + "jwksUrl": "https://auth.example.com/.well-known/jwks.json", + "parUrl": "https://auth.example.com/oauth/par", + "privacyPolicyUrl": "https://example.com/legal/privacy", + "termsOfUseUrl": "https://example.com/legal/eula", + "tokenUrl": "https://auth.example.com/oauth/token" + }, + "lastUpdated": "2026-04-23T14:23:58.000Z", + "logo": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "name": "Strawberry Central", + "updatedBy": "00ub0oNGTSWTBKOLGLNR", + "useCases": [ + "IDENTITY_VERIFICATION" + ] + } + ] + }, + "SupportedFactorResults": { + "value": [ + { + "_links": { + "enroll": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors" + }, + "questions": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/questions" + } + }, + "factorType": "question", + "provider": "OKTA", + "vendorName": "OKTA" + }, + { + "_links": { + "enroll": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors" + } + }, + "factorType": "token:software:totp", + "provider": "OKTA" + }, + { + "_links": { + "enroll": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors" + } + }, + "factorType": "token:software:totp", + "provider": "GOOGLE" + }, + { + "_embedded": { + "phones": [ + { + "id": "mblldntFJevYKbyQQ0g3", + "profile": { + "phoneNumber": "+14081234567" + }, + "status": "ACTIVE" + } + ] + }, + "_links": { + "enroll": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors" + } + }, + "factorType": "sms", + "provider": "OKTA", + "vendorName": "OKTA" + }, + { + "_links": { + "enroll": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors" + } + }, + "factorType": "call", + "provider": "OKTA" + }, + { + "_links": { + "enroll": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors" + } + }, + "factorType": "token", + "provider": "RSA" + }, + { + "_links": { + "enroll": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors" + } + }, + "factorType": "token", + "provider": "SYMANTEC" + } + ] + }, + "TelephonyFailureResponse": { + "summary": "An example telephony hook response for an external web service returning failure", + "value": { + "error": [ + { + "errorSummary": "Failed to deliver SMS OTP to test.user@okta.com" + }, + { + "errorCauses": { + "errorSummary": "Provider could not deliver OTP", + "location": "South Africa", + "reason": "The content of the message is not supported" + } + } + ] + } + }, + "TelephonyPayloadExample": { + "summary": "An example telephony inline hook request body", + "value": { + "cloudEventVersion": "0.1", + "contentType": "application/json", + "data": { + "context": { + "request": { + "id": "reqRgSk8IBBRhuo0YdlEDTmUw", + "ipAddress": "127.0.0.1", + "method": "POST", + "url": { + "value": "/api/internal/v1/inlineHooks/com.okta.telephony.provider/generatePreview" + } + } + }, + "messageProfile": { + "deliveryChannel": "SMS", + "locale": "EN-US", + "msgTemplate": "(HOOK)Your code is 11111", + "otpCode": 11111, + "otpExpires": "2022-01-28T21:48:34.321Z", + "phoneNumber": 9876543210 + }, + "userProfile": { + "firstName": "test", + "lastName": "user", + "login": "test.user@okta.com", + "userId": "00uyxxSknGtK8022w0g3" + } + }, + "eventId": "uS5871kJThSsU8qlA1LTcg", + "eventTime": "2020-01-17T21:23:56.000Z", + "eventType": "com.okta.telephony.provider", + "eventTypeVersion": "1.0", + "source": "https://${yourOktaDomain}/api/v1/inlineHooks/cbl2ad6phv9fsPLcF0g7" + } + }, + "TelephonySuccessResponse": { + "summary": "An example telephony hook response for an external web service returning success", + "value": { + "commands": [ + { + "type": "com.okta.telephony.action", + "value": [ + { + "provider": "VONAGE", + "status": "SUCCESSFUL", + "transactionId": "SM49a8ece2822d44e4adaccd7ed268f954", + "transactionMetadata": "Duration=300ms" + } + ] + } + ] + } + }, + "TenantSettings": { + "summary": "Tenant settings example", + "value": { + "appInstanceProperties": [ + { + "label": "Subdomain", + "name": "subdomain" + }, + { + "label": "Region", + "name": "region" + } + ] + } + }, + "TestInfoApiServiceRequest": { + "summary": "Request for the testing details to validate API service submission", + "value": { + "apiServiceTestConfiguration": { + "scopeExplanation": "The okta.users.write scope enables the application to update user information, allowing users to manage their profiles directly from the app interface.\n" + } + } + }, + "TestInfoApiServiceResponse": { + "summary": "API Service submission testing information response", + "value": { + "apiServiceTestConfiguration": { + "scopeExplanation": "The okta.users.write scope enables the application to update user information, allowing users to manage their profiles directly from the app interface.\n" + }, + "escalationSupportContact": "strawberry.support@example.com", + "testAccount": { + "instructions": "Go to your app URL from a browser and enter your credentials", + "password": "sUperP@ssw0rd", + "url": "https://example.com/strawberry/login", + "username": "test@example.com" + } + } + }, + "TestInfoEMRequest": { + "summary": "SCIM submission with entitlements testing information request", + "value": { + "escalationSupportContact": "strawberry.support@example.com", + "scimTestConfiguration": { + "crudTestResults": "https://www.runscope.com/radar/radfebnsefbd/msdfsvx2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-cdgj455hw45u", + "entitlementsTestResults": "https://www.runscope.com/radar/fgdffghfghfg/m01nopq2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-r434565g5451", + "specTestResults": "https://www.runscope.com/radar/abcdefghijkl/m01nopq2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-3m4n5o678901" + }, + "testAccount": { + "instructions": "Go to your app URL from a browser and enter your credentials", + "password": "sUperP@ssw0rd", + "url": "https://example.com/strawberry/login", + "username": "test@example.com" + } + } + }, + "TestInfoEMResponse": { + "summary": "SCIM submission with entitlements testing information response", + "value": { + "escalationSupportContact": "strawberry.support@example.com", + "scimTestConfiguration": { + "crudTestResults": "https://www.runscope.com/radar/radfebnsefbd/msdfsvx2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-cdgj455hw45u", + "entitlementsTestResults": "https://www.runscope.com/radar/fgdffghfghfg/m01nopq2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-r434565g5451", + "specTestResults": "https://www.runscope.com/radar/abcdefghijkl/m01nopq2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-3m4n5o678901" + }, + "testAccount": { + "instructions": "Go to your app URL from a browser and enter your credentials", + "password": "sUperP@ssw0rd", + "url": "https://example.com/strawberry/login", + "username": "test@example.com" + } + } + }, + "TestInfoOidcRequest": { + "summary": "OIDC SSO submission testing information request", + "value": { + "escalationSupportContact": "strawberry.support@example.com", + "oidcTestConfiguration": { + "jit": false, + "spInitiateUrl": "https://test.example.com/strawberry/oidc/sp-init" + }, + "testAccount": { + "instructions": "Go to your app URL from a browser and enter your credentials", + "password": "sUperP@ssw0rd", + "url": "https://example.com/strawberry/login", + "username": "test@example.com" + } + } + }, + "TestInfoOidcResponse": { + "summary": "OIDC SSO submission testing information response", + "value": { + "escalationSupportContact": "strawberry.support@example.com", + "oidcTestConfiguration": { + "idp": true, + "jit": false, + "sp": true, + "spInitiateUrl": "https://test.example.com/strawberry/oidc/sp-init" + }, + "testAccount": { + "instructions": "Go to your app URL from a browser and enter your credentials", + "password": "sUperP@ssw0rd", + "url": "https://example.com/strawberry/login", + "username": "test@example.com" + } + } + }, + "TestInfoSamlRequest": { + "summary": "SAML SSO submission testing information request", + "value": { + "escalationSupportContact": "strawberry.support@example.com", + "samlTestConfiguration": { + "idp": true, + "jit": false, + "sp": true, + "spInitiateDescription": "Go to the app URL from a browser and enter your username", + "spInitiateUrl": "https://test.example.com/strawberry/saml/sp-init" + }, + "testAccount": { + "instructions": "Go to your app URL from a browser and enter your credentials", + "password": "sUperP@ssw0rd", + "url": "https://example.com/strawberry/login", + "username": "test@example.com" + } + } + }, + "TestInfoSamlResponse": { + "summary": "SAML SSO submission testing information response", + "value": { + "escalationSupportContact": "strawberry.support@example.com", + "samlTestConfiguration": { + "idp": true, + "jit": false, + "sp": true, + "spInitiateDescription": "Go to the app URL from a browser and enter your username", + "spInitiateUrl": "https://test.example.com/strawberry/saml/sp-init" + }, + "testAccount": { + "instructions": "Go to your app URL from a browser and enter your credentials", + "password": "sUperP@ssw0rd", + "url": "https://example.com/strawberry/login", + "username": "test@example.com" + } + } + }, + "TestInfoScimRequest": { + "summary": "SCIM submission testing information request", + "value": { + "escalationSupportContact": "strawberry.support@example.com", + "scimTestConfiguration": { + "crudTestResults": "https://www.runscope.com/radar/radfebnsefbd/msdfsvx2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-cdgj455hw45u", + "specTestResults": "https://www.runscope.com/radar/abcdefghijkl/m01nopq2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-3m4n5o678901" + }, + "testAccount": { + "instructions": "Go to your app URL from a browser and enter your credentials", + "password": "sUperP@ssw0rd", + "url": "https://example.com/strawberry/login", + "username": "test@example.com" + } + } + }, + "TestInfoScimResponse": { + "summary": "SCIM submission testing information response", + "value": { + "escalationSupportContact": "strawberry.support@example.com", + "scimTestConfiguration": { + "crudTestResults": "https://www.runscope.com/radar/radfebnsefbd/msdfsvx2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-cdgj455hw45u", + "specTestResults": "https://www.runscope.com/radar/abcdefghijkl/m01nopq2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-3m4n5o678901" + }, + "testAccount": { + "instructions": "Go to your app URL from a browser and enter your credentials", + "password": "sUperP@ssw0rd", + "url": "https://example.com/strawberry/login", + "username": "test@example.com" + } + } + }, + "ThreatInsightResponseExample": { + "summary": "ThreatInsight response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/threats/configuration" + } + }, + "action": "none", + "created": "2020-08-05T22:18:30.629Z", + "excludeZones": [], + "lastUpdated": "2020-08-05T22:18:30.629Z" + } + }, + "ThreatInsightUpdateRequestExample": { + "summary": "ThreatInsight update request", + "value": { + "action": "audit", + "excludeZones": [ + "nzo1q7jEOsoCnoKcj0g4", + "nzouagptWUz5DlLfM0g3" + ] + } + }, + "ThreatInsightUpdateResponseExample": { + "summary": "ThreatInsight update response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/threats/configuration" + } + }, + "action": "audit", + "created": "2020-08-05T22:18:30.629Z", + "excludeZones": [ + "nzo1q7jEOsoCnoKcj0g4", + "nzouagptWUz5DlLfM0g3" + ], + "lastUpdated": "2020-10-13T21:23:10.178Z" + } + }, + "TokenHookErrorExample": { + "summary": "Error response", + "value": { + "error": { + "errorSummary": "Human-readable summary of the error" + } + } + }, + "TokenHookModifyLifetime": { + "summary": "Modify token lifetime", + "value": { + "commands": [ + { + "type": "com.okta.identity.patch", + "value": [ + { + "op": "replace", + "path": "/token/lifetime/expiration", + "value": 36000 + } + ] + }, + { + "type": "com.okta.access.patch", + "value": [ + { + "op": "replace", + "path": "/token/lifetime/expiration", + "value": 36000 + } + ] + } + ] + } + }, + "TokenHookRemoveClaim": { + "summary": "Remove claim", + "value": { + "commands": [ + { + "type": "com.okta.identity.patch", + "value": [ + { + "op": "remove", + "path": "/claims/birthdate", + "value": null + } + ] + }, + { + "type": "com.okta.access.patch", + "value": [ + { + "op": "remove", + "path": "/claims/external_guid" + } + ] + } + ] + } + }, + "TokenHookRemoveFromArray": { + "summary": "Remove from array", + "value": { + "commands": [ + { + "type": "com.okta.identity.patch", + "value": [ + { + "op": "remove", + "path": "/claims/preferred_airports/1" + } + ] + } + ] + } + }, + "TokenHookRemoveFromObject": { + "summary": "Remove from JSON object", + "value": { + "commands": [ + { + "type": "com.okta.identity.patch", + "value": [ + { + "op": "remove", + "path": "/claims/employee_profile/email" + } + ] + } + ] + } + }, + "TokenHookReplaceExisting": { + "summary": "Replace an existing claim", + "value": { + "commands": [ + { + "type": "com.okta.identity.patch", + "value": [ + { + "op": "replace", + "path": "/claims/extPatientId", + "value": "1234" + }, + { + "op": "replace", + "path": "/claims/external_guid", + "value": "F0384685-F87D-474B-848D-2058AC5655A7" + } + ] + } + ] + } + }, + "TokenHookReplaceInPath": { + "summary": "Replace within JSON object", + "value": { + "commands": [ + { + "type": "com.okta.identity.patch", + "value": [ + { + "op": "replace", + "path": "/claims/employee_profile/email", + "value": "anna@company.com" + } + ] + } + ] + } + }, + "TokenHookResponse": { + "summary": "An example token inline hook response that adds a claim", + "value": { + "commands": [ + { + "type": "com.okta.identity.patch", + "value": [ + { + "op": "add", + "path": "/claims/extPatientId", + "value": "1234" + } + ] + }, + { + "type": "com.okta.access.patch", + "value": [ + { + "op": "add", + "path": "/claims/external_guid", + "value": "F0384685-F87D-474B-848D-2058AC5655A7" + } + ] + } + ] + } + }, + "TokenHookResponseAppendArray": { + "summary": "Append to array", + "value": { + "commands": [ + { + "type": "com.okta.identity.patch", + "value": [ + { + "op": "add", + "path": "/claims/preferred_airports/3", + "value": "lax" + } + ] + } + ] + } + }, + "TokenHookResponseWithURIFormat": { + "summary": "Add new members to existing JSON objects", + "value": { + "commands": [ + { + "type": "com.okta.identity.patch", + "value": [ + { + "op": "add", + "path": "/claims/employee_profile/department_id", + "value": "4947" + } + ] + } + ] + } + }, + "TokenPayLoadExample": { + "description": "An example token inline hook request body", + "summary": "An example token inline hook request body", + "value": { + "cloudEventVersion": "0.1", + "contentType": "application/json", + "data": { + "access": { + "claims": { + "aud": "api://default", + "cid": "customClientIdNative", + "firstName": "Add-Min", + "iss": "https://{yourOktaDomain}/oauth2/default", + "jti": "AT.W-rrB-z-kkZQmHW0e6VS3Or...QfEN_YvoWJa46A7HAA", + "preferred_username": "administrator1@clouditude.net", + "sub": "administrator1@clouditude.net", + "uid": "00uq8tMo3zV0OfJON0g3", + "ver": 1 + }, + "scopes": { + "email": { + "action": "GRANT", + "id": "scpq7dxsoz6LQlRj00g3" + }, + "openid": { + "action": "GRANT", + "id": "scpq7bW1cp6dcvrz80g3" + }, + "profile": { + "action": "GRANT", + "id": "scpq7cWJ81CIP5Qkr0g3" + } + }, + "token": { + "lifetime": { + "expiration": 3600 + } + } + }, + "context": { + "policy": { + "id": "00pq8lGaLlI8APuqY0g3", + "rule": { + "id": "0prq8mLKuKAmavOvq0g3" + } + }, + "protocol": { + "client": { + "id": "customClientIdNative", + "name": "Native client", + "type": "PUBLIC" + }, + "issuer": { + "uri": "https://{yourOktaDomain}/oauth2/default" + }, + "request": { + "client_id": "customClientIdNative", + "redirect_uri": "https://httpbin.org/get", + "response_mode": "fragment", + "response_type": "token id_token", + "scope": "openid profile email", + "state": "state" + }, + "type": "OAUTH2.0" + }, + "request": { + "id": "reqv66CbCaCStGEFc8AdfS0ng", + "ipAddress": "127.0.0.1", + "method": "GET", + "url": { + "value": "https://{yourOktaDomain}/oauth2/default/v1/authorize?scope=openid+profile+email&response_type=token+id_token&redirect_uri=https%3A%2F%2Fhttpbin.org%2Fget&state=state&nonce=asf&client_id=customClientIdNative" + } + }, + "session": { + "amr": [ + "PASSWORD" + ], + "createdAt": "2019-01-15T23:17:09.000Z", + "expiresAt": "2019-01-16T01:20:46.000Z", + "id": "102Qoe7t5PcRnSxr8j3I8I6pA", + "idp": { + "id": "00oq6kcVwvrDY2YsS0g3", + "type": "OKTA" + }, + "lastPasswordVerification": "2019-01-15T23:17:09.000Z", + "login": "administrator1@clouditude.net", + "mfaActive": false, + "status": "ACTIVE", + "userId": "00uq8tMo3zV0OfJON0g3" + }, + "user": { + "_links": { + "factors": { + "href": "https://{yourOktaDomain}/api/v1/users/00uq8tMo3zV0OfJON0g3/factors" + }, + "groups": { + "href": "https://{yourOktaDomain}/00uq8tMo3zV0OfJON0g3/groups" + } + }, + "id": "00uq8tMo3zV0OfJON0g3", + "passwordChanged": "2018-09-11T23:19:12.000Z", + "profile": { + "firstName": "Add-Min", + "lastName": "O'Cloudy Tud", + "locale": "en", + "login": "administrator1@clouditude.net", + "timeZone": "America/Los_Angeles" + } + } + }, + "identity": { + "claims": { + "amr": [ + "pwd" + ], + "aud": "customClientIdNative", + "auth_time": 1547594229, + "email": "administrator1@clouditude.net", + "idp": "00oq6kcVwvrDY2YsS0g3", + "iss": "https://{yourOktaDomain}/oauth2/default", + "jti": "ID.YxF2whJfB3Eu4ktG_7aClqtCgjDq6ab_hgpiV7-ZZn0", + "name": "Add-Min O'Cloudy Tud", + "nonce": "asf", + "preferred_username": "administrator1@clouditude.net", + "sub": "00uq8tMo3zV0OfJON0g3", + "ver": 1 + }, + "token": { + "lifetime": { + "expiration": 3600 + } + } + }, + "refresh_token": { + "jti": "oarob4a0tckCkGcyo1d6" + } + }, + "eventId": "3OWo4oo-QQ-rBWfRyTmQYw", + "eventTime": "2019-01-15T23:20:47.000Z", + "eventType": "com.okta.oauth2.tokens.transform", + "eventTypeVersion": "1.0", + "source": "https://{yourOktaDomain}/oauth2/default/v1/authorize" + } + }, + "TriggerSessionResponse": { + "value": [ + { + "created": "2022-04-04T15:56:05.000Z", + "id": "aps1qqonvr2SZv6o70h8", + "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", + "importType": "INCREMENTAL", + "lastUpdated": "2022-05-05T18:15:44.000Z", + "status": "TRIGGERED" + } + ] + }, + "TrustedOriginBody": { + "summary": "Trusted origin request body", + "value": { + "name": "New trusted origin", + "origin": "http://example.com", + "scopes": [ + { + "type": "CORS" + }, + { + "type": "REDIRECT" + } + ] + } + }, + "TrustedOriginBodyWithIframeEmbedding": { + "description": "Creates a new trusted origin for iFrame embedding of an Okta resource within that origin. In this example, the type of Okta resource is both the Okta End-User Dashboard and the Okta sign-in page.\n", + "summary": "Trusted origin request body with iFrame embedding (Okta End-User Dashboard and Okta sign-in page)", + "value": { + "name": "New trusted origin", + "origin": "http://example.com", + "scopes": [ + { + "allowedOktaApps": [ + "OKTA_ENDUSER" + ], + "type": "IFRAME_EMBED" + } + ] + } + }, + "TrustedOriginBodyWithIframeEmbeddingSignIn": { + "description": "Creates a new trusted origin for iFrame embedding of an Okta resource within that origin. In this example, the Okta resource is the Okta sign-in page.\n", + "summary": "Trusted origin request body with iFrame embedding (Okta sign-in page)", + "value": { + "name": "New trusted origin", + "origin": "http://example.com", + "scopes": [ + { + "allowedOktaApps": [], + "type": "IFRAME_EMBED" + } + ] + } + }, + "TrustedOriginInactiveResponse": { + "summary": "Trusted origin response", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/trustedOrigins/tos10hu7rkbtrFt1M0g4/lifecycle/activate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/trustedOrigins/tos10hu7rkbtrFt1M0g4" + } + }, + "created": "2018-01-13T01:11:44.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tos10hu7rkbtrFt1M0g4", + "lastedUpdated": "2018-01-13T01:11:44.000Z", + "lastedUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "New trusted origin", + "origin": "http://example.com", + "scopes": [ + { + "type": "CORS" + }, + { + "type": "REDIRECT" + } + ], + "status": "INACTIVE" + } + }, + "TrustedOriginPut": { + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3" + } + }, + "created": "2017-12-16T05:01:12.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tosue7JvguwJ7U6kz0g3", + "lastUpdated": "2017-12-16T05:01:12.000Z", + "lastUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "Updated Example trusted origin", + "origin": "http://updated.example.com", + "scopes": [ + { + "type": "CORS" + }, + { + "type": "REDIRECT" + } + ], + "status": "ACTIVE" + } + }, + "TrustedOriginPutBody": { + "summary": "Trusted origin request body", + "value": { + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3" + } + }, + "created": "2017-12-16T05:01:12.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tosue7JvguwJ7U6kz0g3", + "lastUpdated": "2017-12-16T05:01:12.000Z", + "lastUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "Updated Example trusted origin", + "origin": "http://updated.example.com", + "scopes": [ + { + "type": "CORS" + }, + { + "type": "REDIRECT" + } + ], + "status": "ACTIVE" + } + } + }, + "TrustedOriginPutBodyWithIframeEmbedding": { + "summary": "Trusted origin request body with iFrame embedding", + "value": { + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3" + } + }, + "created": "2017-12-16T05:01:12.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tosue7JvguwJ7U6kz0g3", + "lastUpdated": "2017-12-16T05:01:12.000Z", + "lastUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "Updated trusted origin example", + "origin": "http://updated.example.com", + "scopes": [ + { + "allowedOktaApps": [ + "OKTA_ENDUSER" + ], + "type": "IFRAME_EMBED" + } + ], + "status": "ACTIVE" + } + } + }, + "TrustedOriginPutResponse": { + "summary": "Trusted origin response body", + "value": { + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3" + } + }, + "created": "2017-12-16T05:01:12.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tosue7JvguwJ7U6kz0g3", + "lastUpdated": "2017-12-16T05:01:12.000Z", + "lastUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "Updated Example trusted origin", + "origin": "http://updated.example.com", + "scopes": [ + { + "type": "CORS" + }, + { + "type": "REDIRECT" + } + ], + "status": "ACTIVE" + } + } + }, + "TrustedOriginPutResponseWithIframeEmbedding": { + "summary": "Trusted origin response body with iFrame embedding", + "value": { + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3" + } + }, + "created": "2017-12-16T05:01:12.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tosue7JvguwJ7U6kz0g3", + "lastUpdated": "2017-12-16T05:01:12.000Z", + "lastUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "Updated trusted origin example", + "origin": "http://updated.example.com", + "scopes": [ + { + "allowedOktaApps": [ + "OKTA_ENDUSER" + ], + "type": "IFRAME_EMBED" + } + ], + "status": "ACTIVE" + } + } + }, + "TrustedOriginPutWithIframeEmbedding": { + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://${yourOktaDomain}/api/v1/trustedOrigins/tosue7JvguwJ7U6kz0g3" + } + }, + "created": "2017-12-16T05:01:12.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tosue7JvguwJ7U6kz0g3", + "lastUpdated": "2017-12-16T05:01:12.000Z", + "lastUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "Updated trusted origin example", + "origin": "http://updated.example.com", + "scopes": [ + { + "allowedOktaApps": [ + "OKTA_ENDUSER" + ], + "type": "IFRAME_EMBED" + } + ], + "status": "ACTIVE" + } + }, + "TrustedOriginResponse": { + "summary": "Trusted origin response", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/trustedOrigins/tos10hu7rkbtrFt1M0g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/trustedOrigins/tos10hu7rkbtrFt1M0g4" + } + }, + "created": "2018-01-13T01:11:44.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tos10hu7rkbtrFt1M0g4", + "lastedUpdated": "2018-01-13T01:11:44.000Z", + "lastedUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "New trusted origin", + "origin": "http://example.com", + "scopes": [ + { + "type": "CORS" + }, + { + "type": "REDIRECT" + } + ], + "status": "ACTIVE" + } + }, + "TrustedOriginResponseWithIframeEmbedding": { + "summary": "Trusted origin response with iFrame embedding (End-User Dashboard and Okta sign-in page)", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/trustedOrigins/tos10hu7rkbtrFt1M0g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/trustedOrigins/tos10hu7rkbtrFt1M0g4" + } + }, + "created": "2018-01-13T01:11:44.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tos10hu7rkbtrFt1M0g4", + "lastedUpdated": "2018-01-13T01:11:44.000Z", + "lastedUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "New trusted origin", + "origin": "http://example.com", + "scopes": [ + { + "allowedOktaApps": [ + "OKTA_ENDUSER" + ], + "type": "IFRAME_EMBED" + } + ], + "status": "ACTIVE" + } + }, + "TrustedOriginResponseWithIframeEmbeddingSignIn": { + "summary": "Trusted origin response with iFrame embedding (Okta sign-in page)", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/trustedOrigins/tos10hu7rkbtrFt1M0g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/trustedOrigins/tos10hu7rkbtrFt1M0g4" + } + }, + "created": "2018-01-13T01:11:44.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tos10hu7rkbtrFt1M0g4", + "lastedUpdated": "2018-01-13T01:11:44.000Z", + "lastedUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "New trusted origin", + "origin": "http://example.com", + "scopes": [ + { + "allowedOktaApps": [], + "type": "IFRAME_EMBED" + } + ], + "status": "ACTIVE" + } + }, + "TrustedOriginsResponse": { + "summary": "Trusted origins response", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/trustedOrigins/tos10hu7rkbtrFt1M0g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/trustedOrigins/tos10hu7rkbtrFt1M0g4" + } + }, + "created": "2018-01-13T01:11:44.000Z", + "createdBy": "00ut5t92p6IEOi4bu0g3", + "id": "tos10hu7rkbtrFt1M0g4", + "lastedUpdated": "2018-01-13T01:11:44.000Z", + "lastedUpdatedBy": "00ut5t92p6IEOi4bu0g3", + "name": "New trusted origin", + "origin": "http://example.com", + "scopes": [ + { + "type": "CORS" + }, + { + "type": "REDIRECT" + } + ], + "status": "ACTIVE" + } + ] + }, + "UnconfirmedUserResponse": { + "summary": "Example response for unconfirmed users", + "value": { + "users": [ + { + "credentials": { + "username": "isaac.i.brock@example.com" + }, + "externalId": "externalId-user-123", + "profile": { + "email": "isaac.i.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock" + } + }, + { + "credentials": { + "username": "jenny.i.balm@example.com" + }, + "externalId": "externalId-user-456", + "profile": { + "email": "jenny.i.balm@example.com", + "firstName": "Jenny", + "lastName": "Balm" + } + } + ] + } + }, + "UpdateAppFeatureRequestEx": { + "summary": "Update USER_PROVISIONING request", + "value": { + "create": { + "lifecycleCreate": { + "status": "ENABLED" + } + }, + "update": { + "lifecycleDeactivate": { + "status": "ENABLED" + }, + "password": { + "change": "CHANGE", + "seed": "RANDOM", + "status": "ENABLED" + }, + "profile": { + "status": "ENABLED" + } + } + } + }, + "UpdateAppFeatureResponseEx": { + "summary": "Update USER_PROVISIONING response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/features/USER_PROVISIONING" + } + }, + "capabilities": { + "create": { + "lifecycleCreate": { + "status": "ENABLED" + } + }, + "update": { + "lifecycleDeactivate": { + "status": "ENABLED" + }, + "password": { + "change": "CHANGE", + "seed": "RANDOM", + "status": "ENABLED" + }, + "profile": { + "status": "ENABLED" + } + } + }, + "description": "User provisioning settings from Okta to a downstream application", + "name": "USER_PROVISIONING", + "status": "ENABLED" + } + }, + "UpdateAuthorizationServerPolicyRequest": { + "summary": "Update an authorization server policy", + "value": { + "conditions": { + "clients\"": { + "include\"": [ + "ALL_CLIENTS" + ] + } + }, + "description": "Default policy description", + "id": "00p5m9xrrBffPd9ah0g4", + "name": "Default Policy", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "OAUTH_AUTHORIZATION_POLICY" + } + }, + "UpdateAuthorizationServerPolicyRuleRequest": { + "summary": "Update authorization server policy rule", + "value": { + "actions": { + "token": { + "accessTokenLifetimeMinutes": 60, + "inlineHook": { + "id": "cal4egvp1mbMldrYN0g7" + }, + "refreshTokenLifetimeMinutes": 0, + "refreshTokenWindowMinutes": 10080 + } + }, + "conditions": { + "grantTypes": { + "include": [ + "implicit", + "client_credentials", + "authorization_code", + "password" + ] + }, + "people": { + "groups": { + "include": [ + "EVERYONE" + ] + } + }, + "scopes": { + "include": [ + "*" + ] + } + }, + "name": "Default Policy Rule", + "priority": 1, + "status": "ACTIVE", + "type": "RESOURCE_ACCESS" + } + }, + "UpdateBrandRequest": { + "value": { + "agreeToCustomPrivacyPolicy": true, + "customPrivacyPolicyUrl": "https://www.someHost.com/privacy-policy", + "defaultApp": { + "appInstanceId": "0oa114iNkrcN6aR680g4", + "appLinkName": null, + "classicApplicationUri": null + }, + "emailDomainId": "OeD114iNkrcN6aR680g4", + "locale": "en", + "name": "New Name For Brand", + "removePoweredByOkta": true + } + }, + "UpdateBrandResponse": { + "value": { + "_links": { + "emailDomain": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/email-domains/OeD114iNkrcN6aR680g4" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4" + }, + "themes": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/themes" + } + }, + "agreeToCustomPrivacyPolicy": true, + "customPrivacyPolicyUrl": "https://www.someHost.com/privacy-policy", + "defaultApp": { + "appInstanceId": "0oa114iNkrcN6aR680g4", + "appLinkName": null, + "classicApplicationUri": null + }, + "emailDomainId": "OeD114iNkrcN6aR680g4", + "id": "bnd114iNkrcN6aR680g4", + "isDefault": true, + "locale": "en", + "name": "New Name For Brand", + "removePoweredByOkta": true + } + }, + "UpdateDefaultExemptIpZone": { + "summary": "Update the DefaultExemptIpZone", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzodufauoBZYt5fIB0w6/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzodufauoBZYt5fIB0w6" + } + }, + "gateways": [ + { + "type": "RANGE", + "value": "1.1.1.16-1.1.1.16" + } + ], + "id": "nzodufauoBZYt5fIB0w6", + "name": "DefaultExemptIpZone", + "proxies": null, + "status": "ACTIVE", + "system": true, + "type": "IP", + "usage": "POLICY", + "useAsExemptList": true + } + }, + "UpdateDefaultExemptIpZoneResponse": { + "summary": "Update the DefaultExemptIpZone response", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzodufauoBZYt5fIB0w6/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/zones/nzodufauoBZYt5fIB0w6" + } + }, + "created": "2024-10-08T16:35:21.000Z", + "gateways": [ + { + "type": "RANGE", + "value": "1.1.1.16-1.1.1.16" + } + ], + "id": "nzodufauoBZYt5fIB0w6", + "lastUpdated": "2024-10-08T16:36:31.000Z", + "name": "DefaultExemptIpZone", + "proxies": null, + "status": "ACTIVE", + "system": true, + "type": "IP", + "usage": "POLICY", + "useAsBlackList": false, + "useAsExemptList": true + } + }, + "UpdateEmailDomainRequest": { + "value": { + "displayName": "IT Admin", + "userName": "noreply" + } + }, + "UpdateFeatureLifecycleResponse": { + "summary": "Update the feature lifecycle status", + "value": { + "_links": { + "dependencies": { + "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies" + }, + "dependents": { + "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents" + }, + "self": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7" + } + }, + "description": "Example feature description", + "id": "ftrZooGoT8b41iWRiQs7", + "name": "Example feature name", + "stage": { + "state": "OPEN", + "value": "BETA" + }, + "status": "DISABLED", + "type": "self-service" + } + }, + "UpdateGroupPushMappingRequest_Example": { + "value": { + "status": "INACTIVE" + } + }, + "UpdateGroupPushMappingResponse_Example": { + "value": { + "_links": { + "app": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" + }, + "sourceGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000000" + }, + "targetGroup": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000001" + } + }, + "created": "2025-01-01T00:00:00Z", + "errorSummary": "", + "id": "gPm00000000000000000", + "lastPush": "2025-01-01T00:00:00Z", + "lastUpdated": "2025-01-01T00:00:00Z", + "sourceGroupId": "00g00000000000000000", + "status": "INACTIVE", + "targetGroupId": "00g00000000000000001" + } + }, + "UpdateInboundProvisioningFeatureRequestEx": { + "summary": "Update INBOUND_PROVISIONING request", + "value": { + "importRules": { + "userCreateAndMatch": { + "allowPartialMatch": false, + "autoActivateNewUsers": false, + "autoConfirmExactMatch": false, + "autoConfirmNewUsers": false, + "autoConfirmPartialMatch": false, + "exactMatchCriteria": "EMAIL" + } + }, + "importSettings": { + "schedule": { + "fullImport": null, + "incrementalImport": null, + "status": "DISABLED" + }, + "username": { + "userNameFormat": "EMAIL" + } + } + }, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "UpdateInboundProvisioningFeatureResponseEx": { + "summary": "Update INBOUND_PROVISIONING response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/${appId}/features/INBOUND_PROVISIONING" + } + }, + "capabilities": { + "importRules": { + "userCreateAndMatch": { + "allowPartialMatch": false, + "autoActivateNewUsers": false, + "autoConfirmExactMatch": false, + "autoConfirmNewUsers": false, + "autoConfirmPartialMatch": false, + "exactMatchCriteria": "EMAIL" + } + }, + "importSettings": { + "schedule": { + "fullImport": { + "expression": "0 0 * * 0", + "timezone": "America/New_York" + }, + "incrementalImport": { + "expression": "0 */3 * * *", + "timezone": "America/New_York" + }, + "status": "ENABLED" + }, + "username": { + "userNameFormat": "EMAIL" + } + } + }, + "description": "In-bound provisioning settings from an application to Okta", + "name": "INBOUND_PROVISIONING", + "status": "ENABLED" + }, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "UpdateMappingBody": { + "summary": "Update an existing profile mapping by updating one or more properties", + "value": { + "properties": { + "nickName": { + "expression": "user.honorificPrefix + user.displayName", + "pushStatus": "DONT_PUSH" + } + } + } + }, + "UpdateMappingResponse": { + "summary": "Update an existing profile mapping by updating one or more properties", + "value": { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/mappings/prm1k48weFSOnEUnw0g4" + } + }, + "id": "prm1k47ghydIQOTBW0g4", + "properties": { + "fullName": { + "expression": "user.firstName + user.lastName", + "pushStatus": "PUSH" + }, + "nickName": { + "expression": "user.honorificPrefix + user.displayName", + "pushStatus": "DONT_PUSH" + } + }, + "source": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscsbePhQ3yqt4cVv0g3" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/types/user/otysbePhQ3yqt4cVv0g3" + } + }, + "id": "otysbePhQ3yqt4cVv0g3", + "name": "user", + "type": "user" + }, + "target": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/apps/0oa1qmn4LZQQEH0wZ0g4/default" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1qmn4LZQQEH0wZ0g4" + } + }, + "id": "0oa1qmn4LZQQEH0wZ0g4", + "name": "okta_org2org", + "type": "appuser" + } + } + }, + "UpdateOAuth2ScopeRequest": { + "summary": "Example scope", + "value": { + "description": "Order car", + "metadataPublish": "ALL_CLIENTS", + "name": "car:order" + } + }, + "UpdateOktaManagedUserAccountRequest": { + "summary": "Update an Okta managed user account", + "value": { + "description": "Updated description for production AD integration admin account", + "name": "AD Integrations Admin - Production", + "ownerGroupIds": [ + "00g57qp78yZT2XBA40g7" + ], + "ownerUserIds": [ + "00u22t59Q0aHbNEXi1h8", + "00u44v71S2cJdPGZk3j0" + ] + } + }, + "UpdateOrgSettingEx": { + "summary": "Org setting request", + "value": { + "address1": "100 1st St", + "address2": "6th floor", + "city": "San Fransico", + "companyName": "okta", + "country": "United States", + "endUserSupportHelpURL": "support.okta.com", + "phoneNumber": "+18887227871", + "postalCode": "94105", + "state": "California", + "supportPhoneNumber": "+18887227871", + "website": "www.okta.com" + } + }, + "UpdateRecQuestionRequest": { + "value": { + "password": { + "value": "tlpWENT2m" + }, + "recovery_question": { + "answer": "forty two", + "question": "How many roads must a man walk down?" + } + } + }, + "UpdateRecQuestionResponse": { + "value": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + }, + "recovery_question": { + "question": "How many roads must a man walk down?" + } + } + }, + "UpdateSMSTemplateRequest": { + "value": { + "translations": { + "de": "${org.name}: ihre best\u00e4tigungscode ist ${code}." + } + } + }, + "UpdateSMSTemplateResponse": { + "value": { + "created": "2024-04-25T17:35:02.000Z", + "id": "6NQUJ5yR3bpgEiYmq8IC", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Custom", + "template": "${org.name}: your verification code is ${code}", + "translations": { + "de": "${org.name}: ihre best\u00e4tigungscode ist ${code}.", + "es": "${org.name}: el c\u00f3digo de verificaci\u00f3n es ${code}", + "fr": "${org.name}: votre code de v\u00e9rification est ${code}", + "it": "${org.name}: il codice di verifica \u00e8 ${code}" + }, + "type": "SMS_VERIFY_CODE" + } + }, + "UpdateThemeRequest": { + "value": { + "emailTemplateTouchPointVariant": "OKTA_DEFAULT", + "endUserDashboardTouchPointVariant": "OKTA_DEFAULT", + "errorPageTouchPointVariant": "OKTA_DEFAULT", + "loadingPageTouchPointVariant": "OKTA_DEFAULT", + "primaryColorContrastHex": "#000000", + "primaryColorHex": "#1662dd", + "secondaryColorContrastHex": "#000000", + "secondaryColorHex": "#ebebed", + "signInPageTouchPointVariant": "OKTA_DEFAULT" + } + }, + "UpdateThemeResponse": { + "value": { + "backgroundImage": null, + "emailTemplateTouchPointVariant": "OKTA_DEFAULT", + "endUserDashboardTouchPointVariant": "OKTA_DEFAULT", + "errorPageTouchPointVariant": "OKTA_DEFAULT", + "favicon": "https://{yourOktaDomain}/favicon.ico", + "id": "thdul904tTZ6kWVhP0g3", + "loadingPageTouchPointVariant": "OKTA_DEFAULT", + "logo": "https://{yourOktaDomain}/assets/img/logos/okta-logo.47066819ac7db5c13f4c431b2687cef6.png", + "primaryColorContrastHex": "#000000", + "primaryColorHex": "#1662dd", + "secondaryColorContrastHex": "#000000", + "secondaryColorHex": "#ebebed", + "signInPageTouchPointVariant": "OKTA_DEFAULT" + } + }, + "UpdateUserTypePostRequest": { + "summary": "Update user type request", + "value": { + "displayName": "Updated Display Name" + } + }, + "UpdateUserTypePostResponse": { + "summary": "Update user type response", + "value": { + "_links": { + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" + } + }, + "created": "2021-07-05T20:40:38.000Z", + "createdBy": "sprz9fj1ycBcsgopy1d6", + "default": false, + "description": "A new custom user type", + "displayName": "Updated Display Name", + "id": "otyfnly5cQjJT9PnR0g4", + "lastUpdated": "2021-07-05T20:40:38.000Z", + "lastUpdatedBy": "sprz9fj1ycBcsgopy1d6", + "name": "newUserType" + } + }, + "UpdateWellKnownURIRequest": { + "value": { + "representation": { + "key1": "value1", + "key2": "value2", + "key3": { + "key3.1": "value3.1" + } + } + } + }, + "UpdatedEmailDomainResponse": { + "value": { + "displayName": "IT Admin", + "dnsValidationRecords": [ + { + "fqdn": "_oktaverification.example.com", + "recordType": "TXT", + "verificationValue": "759080212bda43e3bc825a7d73b4bb64" + }, + { + "fqdn": "mail.example.com", + "recordType": "CNAME", + "verificationValue": "u22224444.wl024.sendgrid.net" + }, + { + "fqdn": "t02._domainkey.example.com", + "recordType": "CNAME", + "verificationValue": "t02.domainkey.u22224444.wl024.sendgrid.net" + }, + { + "fqdn": "t022._domainkey.example.com", + "recordType": "CNAME", + "verificationValue": "t02.domainkey.u22224444.wl024.sendgrid.net" + } + ], + "domain": "example.com", + "id": "OeD114iNkrcN6aR680g4", + "userName": "noreply", + "validationStatus": "NOT_STARTED", + "validationSubdomain": "mail" + } + }, + "UpdatedOAuth2ScopeResponse": { + "summary": "Updated scope", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/scp5yu8kLOnDzo7lh0g4" + } + }, + "consent": "REQUIRED", + "default": false, + "description": "Order car", + "displayName": "Saml Jackson", + "id": "scp5yu8kLOnDzo7lh0g4", + "metadataPublish": "ALL_CLIENTS", + "name": "car:order", + "optional": false, + "system": false + } + }, + "UploadYubikeyTokenSeedRequest": { + "summary": "YubiKey OTP seed", + "value": { + "aesKey": "1fcc6d8ce39bf1604e0b17f3e0a11067", + "privateId": "b74be6169486", + "publicId": "ccccccijgibu", + "serialNumber": "7886622" + } + }, + "UploadYubikeyTokenSeedResponse": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/factors/yubikey_token/tokens/ykkut4G6ti62DD8Dy0g3" + } + }, + "created": "2020-01-10T23:04:10.000Z", + "id": "ykkut4G6ti62DD8Dy0g3", + "lastUpdated": "2020-01-10T23:04:10.000Z", + "lastVerified": "2020-01-10T23:04:10.000Z", + "profile": { + "serial": "000007886622" + }, + "status": "UNASSIGNED" + } + }, + "UserFactorChallengeCallResponse": { + "summary": "call challenge", + "value": { + "_links": { + "factor": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/clff17zuKEUMYQAQGCOV" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/clff17zuKEUMYQAQGCOV/verify" + } + }, + "factorResult": "CHALLENGE", + "profile": { + "phoneExtension": "1234", + "phoneNumber": "+12532236986" + } + } + }, + "UserFactorChallengeEmailResponse": { + "summary": "email challenge", + "value": { + "_links": { + "factor": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/emfnf3gSScB8xXoXK0g3" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/emfnf3gSScB8xXoXK0g3/verify" + } + }, + "factorResult": "CHALLENGE" + } + }, + "UserFactorChallengePushResponse": { + "summary": "push challenge", + "value": { + "_links": { + "cancel": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/transactions/mst1eiHghhPxf0yhp0g" + }, + "poll": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/transactions/mst1eiHghhPxf0yhp0g" + } + }, + "expiresAt": "2015-04-01T15:57:32.000Z", + "factorResult": "WAITING" + } + }, + "UserFactorChallengePushResponseWithNumberMatchingChallenge": { + "summary": "Push challenge with number matching", + "value": { + "_embedded": { + "challenge": { + "correctAnswer": 72 + } + }, + "_links": { + "cancel": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/transactions/mst1eiHghhPxf0yhp0g" + }, + "poll": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/transactions/mst1eiHghhPxf0yhp0g" + } + }, + "expiresAt": "2015-04-01T15:57:32.000Z", + "factorResult": "WAITING" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "UserFactorChallengeSmsResponse": { + "summary": "sms challenge", + "value": { + "_links": { + "factor": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/smsszf1YNUtGWTx4j0g3" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/smsszf1YNUtGWTx4j0g3/verify" + } + }, + "factorResult": "CHALLENGE", + "profile": { + "phoneNumber": "+12532236986" + } + } + }, + "UserFactorChallengeU2fResponse": { + "summary": "u2f challenge", + "value": { + "_embedded": { + "challenge": { + "nonce": "vQFwTt6zKzMV7HFPzjS2", + "timeoutSeconds": 20 + } + }, + "_links": { + "factor": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fuf2rovRxogXJ0nDy0g4" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fuf2rovRxogXJ0nDy0g4/verify" + } + }, + "factorResult": "CHALLENGE", + "profile": { + "credentialId": "GAiiLsVab2m3-zL1Fi3bVtNrM9G6_MntUITHKjxkV24ktGKjLSCRnz72wCEdHCe18IvC69Aia0sE4UpsO0HpFQ", + "version": "U2F_V2" + } + } + }, + "UserFactorChallengeWebauthnResponse": { + "summary": "webAuthn challenge", + "value": { + "_embedded": { + "challenge": { + "challenge": "vQFwTt6zKzMV7HFPzjS2", + "extensions": {} + } + }, + "_links": { + "factor": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fwf2rovRxogXJ0nDy0g4" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fwf2rovRxogXJ0nDy0g4/verify" + } + }, + "factorResult": "CHALLENGE", + "profile": { + "authenticatorName": "MacBook Touch ID", + "credentialId": "l3Br0n-7H3g047NqESqJynFtIgf3Ix9OfaRoNwLoloso99Xl2zS_O7EXUkmPeAIzTVtEL4dYjicJWBz7NpqhGA" + } + } + }, + "UserFactorVerifyCallSuccessResponse": { + "summary": "call verify", + "value": { + "factorResult": "SUCCESS" + } + }, + "UserFactorVerifyEmailSuccessResponse": { + "summary": "email verify", + "value": { + "factorResult": "SUCCESS" + } + }, + "UserFactorVerifyPushRejectedResponse": { + "summary": "push verification rejected", + "value": { + "_links": { + "factor": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/verify" + } + }, + "factorResult": "REJECTED", + "profile": { + "credentialId": "jane.doe@example.com" + } + } + }, + "UserFactorVerifyPushTransactionApproved": { + "summary": "SUCCESS", + "value": { + "factorResult": "SUCCESS" + } + }, + "UserFactorVerifyPushTransactionRejected": { + "summary": "REJECTED", + "value": { + "_links": { + "factor": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/verify" + } + }, + "factorResult": "REJECTED", + "profile": { + "credentialId": "jane.doe@example.com" + } + } + }, + "UserFactorVerifyPushTransactionTimeout": { + "summary": "TIMEOUT", + "value": { + "_links": { + "factor": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3" + }, + "verify": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/verify" + } + }, + "factorResult": "TIMEOUT", + "profile": { + "credentialId": "jane.doe@example.com" + } + } + }, + "UserFactorVerifyPushTransactionWaiting": { + "summary": "WAITING", + "value": { + "_links": { + "cancel": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/transactions/v2mst.GldKV5VxTrifyeZmWSQguA" + }, + "poll": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/transactions/v2mst.GldKV5VxTrifyeZmWSQguA" + } + }, + "expiresAt": "2015-04-01T15:57:32.000Z", + "factorResult": "WAITING", + "profile": { + "credentialId": "jane.doe@example.com" + } + } + }, + "UserFactorVerifyPushTransactionWaitingNMC": { + "summary": "WAITING (with number matching challenge)", + "value": { + "_embedded": { + "challenge": { + "correctAnswer": 72 + } + }, + "_links": { + "cancel": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/transactions/v2mst.GldKV5VxTrifyeZmWSQguA" + }, + "poll": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfh52xcuft3J4uZc0g3/transactions/v2mst.GldKV5VxTrifyeZmWSQguA" + } + }, + "expiresAt": "2015-04-01T15:57:32.000Z", + "factorResult": "WAITING", + "profile": { + "credentialId": "jane.doe@example.com" + } + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "UserFactorVerifySecurityQuestionRequest": { + "summary": "security question verify", + "value": { + "answer": "mayonnaise" + } + }, + "UserFactorVerifySuccessSmsResponse": { + "summary": "sms verify", + "value": { + "factorResult": "SUCCESS" + } + }, + "UserFactorVerifySuccessSqResponse": { + "summary": "security question verify", + "value": { + "factorResult": "SUCCESS" + } + }, + "UserFactorVerifySuccessTokenResponse": { + "summary": "token verify", + "value": { + "factorResult": "SUCCESS" + } + }, + "UserFactorVerifySuccessTotpResponse": { + "summary": "totp verify", + "value": { + "factorResult": "SUCCESS" + } + }, + "UserFactorVerifySuccessYubikeyResponse": { + "summary": "yubikey verify", + "value": { + "factorResult": "SUCCESS" + } + }, + "UserFactorVerifyU2fRequest": { + "summary": "u2f verify", + "value": { + "clientData": "eyJ0eXAiOiJuYXZpZ2F0b3IuaWQuZ2V0QXNzZXJ0aW9uIiwiY2hhbGxlbmdlIjoiS2NCLXRqUFU0NDY0ZThuVFBudXIiLCJvcmlnaW4iOiJodHRwczovL2xvY2FsaG9zdDozMDAwIiwiY2lkX3B1YmtleSI6InVudXNlZCJ9", + "signatureData": "AQAAACYwRgIhAKPktdpH0T5mlPSm_9uGW5w-VaUy-LhI9tIacexpgItkAiEAncRVZURVPOq7zDwIw-OM5LtSkdAxOkfv0ZDVUx3UFHc" + } + }, + "UserFactorVerifyU2fResponse": { + "summary": "u2f verify response", + "value": { + "factorResult": "SUCCESS", + "profile": { + "credentialId": "h1bFwJFU9wnelYkexJuQfoUHZ5lX3CgQMTZk4H3I8kM9Nn6XALiQ-BIab4P5EE0GQrA7VD-kAwgnG950aXkhBw", + "version": "U2F_V2" + } + } + }, + "UserFactorVerifyWebauthnRequest": { + "summary": "WebAuthn verify challenge", + "value": { + "authenticatorData": "SBv04caJ+NLZ0bTeotGq9esMhHJ8YC5z4bMXXPbT95UFXbDsOg==", + "clientData": "eyJ0eXAiOiJuYXZpZ2F0b3IuaWQuZ2V0QXNzZXJ0aW9uIiwiY2hhbGxlbmdlIjoiS2NCLXRqUFU0NDY0ZThuVFBudXIiLCJvcmlnaW4iOiJodHRwczovL2xvY2FsaG9zdDozMDAwIiwiY2lkX3B1YmtleSI6InVudXNlZCJ9", + "signatureData": "AQAAACYwRgIhAKPktdpH0T5mlPSm_9uGW5w-VaUy-LhI9tIacexpgItkAiEAncRVZURVPOq7zDwIw-OM5LtSkdAxOkfv0ZDVUx3UFHc" + } + }, + "UserFactorVerifyWebauthnResponse": { + "summary": "WebAuthn verify", + "value": { + "factorResult": "SUCCESS", + "profile": { + "authenticatorName": "MacBook Touch ID", + "credentialId": "l3Br0n-7H3g047NqESqJynFtIgf3Ix9OfaRoNwLoloso99Xl2zS_O7EXUkmPeAIzTVtEL4dYjicJWBz7NpqhGA" + } + } + }, + "UserImportChangeAppUserProfileExample": { + "summary": "An example user import inline hook response that updates an app user's profile", + "value": { + "commands": [ + { + "type": "com.okta.appUser.profile.update", + "value": { + "firstName": "Stan" + } + } + ] + } + }, + "UserImportChangeUserProfileExample": { + "summary": "Update an Okta user's profile response", + "value": { + "commands": [ + { + "type": "com.okta.user.profile.update", + "value": { + "firstName": "Stan" + } + } + ] + } + }, + "UserImportCreateANewUserExample": { + "summary": "Create a new Okta user profile response", + "value": { + "commands": [ + { + "type": "com.okta.action.update", + "value": { + "result": "CREATE_USER" + } + } + ] + } + }, + "UserImportErrorExample": { + "summary": "Return an error object", + "value": { + "error": { + "errorSummary": "Error at third-party service. Please contact your admin." + } + } + }, + "UserImportMatchExample": { + "summary": "Match an existing Okta user response", + "value": { + "commands": [ + { + "type": "com.okta.action.update", + "value": { + "result": "LINK_USER" + } + }, + { + "type": "com.okta.user.update", + "value": { + "id": "00garwpuyxHaWOkdV0g3" + } + } + ] + } + }, + "UserImportPayloadExample": { + "summary": "An example user import request body", + "value": { + "cloudEventVersion": "0.1", + "contentType": "application/json", + "data": { + "action": { + "result": "CREATE_USER" + }, + "appUser": { + "profile": { + "accountType": "PRO", + "email": "sally.admin@example.net", + "externalId": "user221", + "failDeprovisioning": null, + "failProvisioning": null, + "firstName": "Sally2", + "groups": [ + "everyone@examplee.net", + "tech@example.net" + ], + "lastName": "Admin2", + "mobilePhone": null, + "secondEmail": null, + "userName": "administrator2" + } + }, + "context": { + "application": { + "id": "0oa7ey7aLRuBvcYUD0g4", + "label": "Test App", + "name": "test_app", + "status": "ACTIVE" + }, + "conflicts": [ + "login" + ], + "job": { + "id": "ij17ez2AWtMZRfCZ60g4", + "type": "import:users" + }, + "matches": [], + "policy": [ + "EMAIL", + "FIRST_AND_LAST_NAME" + ] + }, + "user": { + "profile": { + "city": null, + "countryCode": null, + "email": "sally.admin@example.net", + "firstName": "Sally2", + "lastName": "Admin2", + "login": "sally.admin@example.net", + "mobilePhone": null, + "postAddress": null, + "primaryPhone": null, + "secondEmail": null, + "state": null, + "streetAddress": null, + "typeId": null, + "zipCode": null + } + } + }, + "eventId": "JUGOUiYZTaKPmH6db0nDag", + "eventTime": "2019-02-27T20:59:04.000Z", + "eventType": "com.okta.import.transform", + "eventTypeVersion": "1.0", + "source": "cal7eyxOsnb20oWbZ0g4" + } + }, + "UserPayload": { + "value": { + "externalId": "EXT987654321Z9Y7X", + "profile": { + "email": "emily.jones@example.com", + "firstName": "Emily", + "homeAddress": "10800 NE 8th St #600, Bellevue, WA 98004", + "lastName": "Jones", + "mobilePhone": "987-654-3210", + "secondEmail": "emily.secondary@example.com", + "userName": "emily.jones@example.com" + } + } + }, + "UserProvisioningJsonWebKeysResponse": { + "summary": "JSON Web Key list response example", + "value": { + "jwks": { + "keys": [ + { + "alg": "RSA", + "e": "AQAB", + "kid": "-rZYtf4RZWc_tVTlmrvLPcDwvO4SwbWeztzB7AjHyLA", + "kty": "RSA", + "n": "AJncrKuine49_CEVR4GPn.....zOrouIUCSMlRL0HU=", + "use": "sig" + } + ] + } + } + }, + "UserReplacePayload": { + "value": { + "profile": { + "email": "brockly@email.com", + "firstName": "Emily", + "lastName": "Brock", + "userName": "brockly@email.com" + } + } + }, + "UserReplaceResponse": { + "value": { + "profile": { + "email": "brockly@email.com", + "firstName": "Emily", + "homeAddress": null, + "lastName": "Brock", + "mobilePhone": null, + "secondEmail": null, + "userName": "brockly@email.com" + } + } + }, + "UserResponse": { + "value": { + "created": "2025-07-24T12:06:05.000Z", + "externalId": "EXT987654321Z9Y7X", + "id": "00u7m9p9ZT8k2S2EX1f7", + "lastUpdated": "2025-08-05T16:15:44.000Z", + "profile": { + "email": "emily.jones@example.com", + "firstName": "Emily", + "homeAddress": "10800 NE 8th St #600, Bellevue, WA 98004", + "lastName": "Jones", + "mobilePhone": "987-654-3210", + "secondEmail": "emily.secondary@example.com", + "userName": "emily.jones@example.com" + } + } + }, + "UserRiskMediumResponse": { + "summary": "Example user risk with MEDIUM level response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/{userId}/risk" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/{userId}" + } + }, + "reason": "override.by.admin", + "riskLevel": "MEDIUM" + } + }, + "UserRiskMediumResponseWithReason": { + "summary": "Example user risk with MEDIUM level and custom reason response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/{userId}/risk" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/{userId}" + } + }, + "reason": "Elevated risk detected from recent authentication patterns", + "riskLevel": "MEDIUM" + } + }, + "UserRiskNoneResponse": { + "summary": "Example user risk with NONE risk level response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/{userId}/risk" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/{userId}" + } + }, + "riskLevel": "NONE" + } + }, + "UserRiskRequest": { + "summary": "Example upsert the risk for a user request", + "value": { + "riskLevel": "HIGH" + } + }, + "UserRiskRequestMediumExample": { + "summary": "Example upsert with MEDIUM risk level", + "value": { + "riskLevel": "MEDIUM" + } + }, + "UserRiskRequestMediumWithReasonExample": { + "summary": "Example upsert with MEDIUM risk level and custom reason", + "value": { + "riskLevel": "MEDIUM", + "riskReason": "Elevated risk detected from recent authentication patterns" + } + }, + "UserRiskRequestWithReason": { + "summary": "Example upsert the risk for a user request with a custom risk reason", + "value": { + "riskLevel": "HIGH", + "riskReason": "Risk level changed due to external risk signal" + } + }, + "UserRiskResponse": { + "summary": "Example user risk response", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/{userId}/risk" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/{userId}" + } + }, + "reason": "override.by.admin", + "riskLevel": "HIGH" + } + }, + "UserRiskResponseWithReason": { + "summary": "Example user risk response with custom reason", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/{userId}/risk" + }, + "user": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/users/{userId}" + } + }, + "reason": "Risk level changed due to external risk signal", + "riskLevel": "HIGH" + } + }, + "UserSchemaAddRequest": { + "value": { + "definitions": { + "custom": { + "id": "#custom", + "properties": { + "salesforceUserName": { + "description": "User's username for Salesforce", + "maxLength": 20, + "minLength": 1, + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": false, + "title": "Salesforce username", + "type": "string" + } + }, + "required": [], + "type": "object" + } + } + } + }, + "UserSchemaDefaultResponse": { + "value": { + "$schema": "http://json-schema.org/draft-04/schema#", + "created": "2025-05-20T20:04:26.000Z", + "definitions": { + "base": { + "id": "#base", + "properties": { + "email": { + "format": "email", + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": true, + "title": "Primary email", + "type": "string" + }, + "firstName": { + "maxLength": 50, + "minLength": 1, + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": true, + "title": "First name", + "type": "string" + }, + "lastName": { + "maxLength": 50, + "minLength": 1, + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": true, + "title": "Last name", + "type": "string" + }, + "login": { + "maxLength": 100, + "minLength": 5, + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": true, + "title": "Username", + "type": "string" + } + }, + "required": [ + "login", + "firstName", + "lastName", + "email" + ], + "type": "object" + }, + "custom": { + "id": "#custom", + "properties": {}, + "required": [], + "type": "object" + } + }, + "descripton": "Okta user profile template with default permission settings", + "id": "https://{yourOktaDomain}/meta/schemas/user/default", + "lastUpdated": "2025-05-20T20:04:26.000Z", + "name": "user", + "properties": { + "profile": { + "allOf": [ + { + "$ref": "#/definitions/base" + }, + { + "$ref": "#/definitions/custom" + } + ] + } + }, + "title": "Default Okta user", + "type": "object" + } + }, + "UserSchemaResponse": { + "value": { + "$schema": "http://json-schema.org/draft-04/schema#", + "created": "2015-02-02T10:27:36.000Z", + "definitions": { + "base": { + "id": "#base", + "properties": { + "email": { + "format": "email", + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": true, + "title": "Primary email", + "type": "string" + }, + "firstName": { + "maxLength": 50, + "minLength": 1, + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": true, + "title": "First name", + "type": "string" + }, + "lastName": { + "maxLength": 50, + "minLength": 1, + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": true, + "title": "Last name", + "type": "string" + }, + "login": { + "maxLength": 100, + "minLength": 5, + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": true, + "title": "Username", + "type": "string" + } + }, + "required": [ + "login", + "firstName", + "lastName", + "email" + ], + "type": "object" + }, + "custom": { + "id": "#custom", + "properties": { + "salesforceUserName": { + "default": "salesforce-username", + "description": "User's username for Salesforce", + "maxLength": 20, + "minLength": 1, + "permissions": [ + { + "action": "READ_WRITE", + "principal": "SELF" + } + ], + "required": false, + "title": "Salesforce username", + "type": "string" + } + }, + "required": [], + "type": "object" + } + }, + "id": "https://{yourOktaDomain}/meta/schemas/user/oscmlha7lcRyMn82P1d7", + "lastUpdated": "2015-09-05T10:40:45.000Z", + "name": "user", + "properties": { + "profile": { + "allOf": [ + { + "$ref": "#/definitions/base" + }, + { + "$ref": "#/definitions/custom" + } + ] + } + }, + "title": "An Okta user", + "type": "object" + } + }, + "UserUpdatePayload": { + "value": { + "profile": { + "email": "emily.brock@update.com", + "firstName": "Emily", + "lastName": "Brock", + "userName": "emily.brock@update.com" + } + } + }, + "UserUpdateResponse": { + "value": { + "profile": { + "email": "emily.brock@update.com", + "firstName": "Emily", + "homeAddress": "10800 NE 8th St #600, Bellevue, WA 98004", + "lastName": "Brock", + "mobilePhone": "987-654-3210", + "secondEmail": "emily.secondary@example.com", + "userName": "emily.brock@update.com" + } + } + }, + "ValidationDetailsResult": { + "summary": "Validation details example", + "value": { + "valid": false, + "validationDetails": [ + { + "id": "okta:action1", + "provider": { + "code": "CBDE000001H", + "externalId": "JKL490DQNV", + "flowName": "Create User Flow", + "link": "https://some-org.workflows.okta.com/app/integration-builder/IU392MNQ8/flows/JKL490DQNV", + "message": "Names of two or more active flows are duplicates.", + "type": "WORKFLOWS" + } + } + ] + } + }, + "VerifiedEmailDomainResponse": { + "value": { + "displayName": "IT Admin", + "dnsValidationRecords": [ + { + "fqdn": "_oktaverification.example.com", + "recordType": "TXT", + "verificationValue": "759080212bda43e3bc825a7d73b4bb64" + }, + { + "fqdn": "mail.example.com", + "recordType": "CNAME", + "verificationValue": "u22224444.wl024.sendgrid.net" + }, + { + "fqdn": "t02._domainkey.example.com", + "recordType": "CNAME", + "verificationValue": "t02.domainkey.u22224444.wl024.sendgrid.net" + }, + { + "fqdn": "t022._domainkey.example.com", + "recordType": "CNAME", + "verificationValue": "t02.domainkey.u22224444.wl024.sendgrid.net" + } + ], + "domain": "example.com", + "id": "OeD114iNkrcN6aR680g4", + "userName": "noreply", + "validationStatus": "VERIFIED", + "validationSubdomain": "mail" + } + }, + "WSFederationEx": { + "summary": "WS_FEDERATION", + "value": { + "label": "Sample WS-Fed App", + "name": "template_wsfed", + "settings": { + "app": { + "audienceRestriction": "urn:example:app", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "groupValueFormat": "windowsDomainQualifiedName", + "nameIDFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "siteURL": "https://example.com", + "usernameAttribute": "username", + "wReplyURL": "https://example.com/" + } + }, + "signOnMode": "WS_FEDERATION" + } + }, + "WSFederationPutEx": { + "summary": "WS_FEDERATION", + "value": { + "label": "Sample WS-Fed App updated", + "name": "template_wsfed", + "settings": { + "app": { + "audienceRestriction": "urn:exampleupdated:app", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "groupValueFormat": "windowsDomainQualifiedName", + "nameIDFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "siteURL": "https://example.com", + "usernameAttribute": "username", + "wReplyURL": "https://example.com/" + } + }, + "signOnMode": "WS_FEDERATION" + } + }, + "WSFederationPutResponseEx": { + "summary": "WS_FEDERATION", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "signing": { + "kid": "FzJvvXtBHvs_-n70T4C2Rb2d64AyN4fqOme6piHOUKU" + }, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample WS-Fed App updated", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "template_wsfed", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_wsfed:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "attributeStatements": null, + "audienceRestriction": "urn:exampleupdated:app", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "digestAlgorithm": "SHA1", + "groupFilter": null, + "groupName": "http://schemas.microsoft.com/ws/2008/06/identity/claims/role", + "groupValueFormat": "windowsDomainQualifiedName", + "nameIDFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "realm": "urn:okta:app:exkarjfNMKUjTmzTZ0g4", + "signatureAlgorithm": "RSA_SHA1", + "siteURL": "https://example.com", + "usernameAttribute": "username", + "wReplyOverride": false, + "wReplyURL": "https://example.com/" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "WS_FEDERATION", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "WSFederationResponseEx": { + "summary": "WS_FEDERATION", + "value": { + "_links": { + "appLinks": [ + { + "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", + "name": "customswaapp_link", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" + }, + "logo": [ + { + "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", + "name": "medium", + "type": "image/png" + } + ], + "uploadLogo": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "loginRedirectUrl": null, + "selfService": false + }, + "created": "2023-01-21T14:11:24.000Z", + "credentials": { + "signing": { + "kid": "FzJvvXtBHvs_-n70T4C2Rb2d64AyN4fqOme6piHOUKU" + }, + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafxqCAJWWGELFTYASJ", + "label": "Sample WS-Fed App", + "lastUpdated": "2023-01-21T14:11:24.000Z", + "name": "template_wsfed", + "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_wsfed:0oafxqCAJWWGELFTYASJ", + "settings": { + "app": { + "attributeStatements": null, + "audienceRestriction": "urn:example:app", + "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "digestAlgorithm": "SHA1", + "groupFilter": null, + "groupName": "http://schemas.microsoft.com/ws/2008/06/identity/claims/role", + "groupValueFormat": "windowsDomainQualifiedName", + "nameIDFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "realm": "urn:okta:app:exkarjfNMKUjTmzTZ0g4", + "signatureAlgorithm": "RSA_SHA1", + "siteURL": "https://example.com", + "usernameAttribute": "username", + "wReplyOverride": false, + "wReplyURL": "https://example.com/" + }, + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + }, + "signOnMode": "WS_FEDERATION", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoLaunch": false, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + }, + "WellKnownAppAuthenticatorConfigurationCustomApp": { + "summary": "Retrieve app authenticator configuration", + "value": [ + { + "appAuthenticatorEnrollEndpoint": "https://{yourOktaDomain}/idp/myaccount/app-authenticators", + "authenticatorId": "aut22f6xzargnJZYE3l7", + "createdDate": "2022-10-11T08:56:45.000Z", + "key": "custom_app", + "lastUpdated": "2023-09-07T11:31:35.000Z", + "name": "Custom authenticator", + "orgId": "00o1vhf34q20MfCFC3l7", + "settings": { + "userVerification": "PREFERRED" + }, + "supportedMethods": [ + { + "settings": { + "algorithms": [ + "RS256", + "ES256" + ], + "keyProtection": "ANY" + }, + "status": "ACTIVE", + "type": "push" + } + ], + "type": "app" + } + ] + }, + "WellKnownOrgMetadataResponseClassic": { + "value": { + "_links": { + "organization": { + "href": "https://{{yourOktaDomain}}" + } + }, + "id": "00o5rb5mt2H3d1TJd0h7", + "pipeline": "v1" + } + }, + "WellKnownOrgMetadataResponseCustomUrlOie": { + "value": { + "_links": { + "alternate": { + "href": "https://{yourCustomDomain}" + }, + "organization": { + "href": "https://{yourSubdomain}.okta.com" + } + }, + "id": "00o47wwoytgsDqEtz0g7", + "pipeline": "idx" + } + }, + "WellKnownRepresentationSizeLimitExceededError": { + "summary": "Size limit exceeded", + "value": { + "errorCauses": [ + { + "errorSummary": "Content must be less than 100KB." + } + ], + "errorCode": "E0000001", + "errorId": "sampleiCF-8D5rLW6myqiPItW", + "errorLink": "E0000001", + "errorSummary": "Api validation failed: request" + } + }, + "WellKnownURIResponse": { + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/well-known-uris/apple-app-site-association/customized" + } + }, + "representation": { + "key1": "value1", + "key2": "value2", + "key3": { + "key3.1": "value3.1" + } + } + } + }, + "WellKnownURIRootResponse": { + "value": { + "_links": { + "customized": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/well-known-uris/apple-app-site-association/customized" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/well-known-uris/apple-app-site-association" + } + } + } + }, + "WellKnownURIsRootResponse": { + "value": { + "_embedded": { + "apple-app-site-association": { + "customized": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/well-known-uris/apple-app-site-association/customized" + } + }, + "representation": { + "authsrv": { + "apps": [ + "B7F62B65BN.com.okta.mobile", + "B7F62B65BN.com.okta.mobile.auth-service-extension", + "B7F62B65BN.com.okta.authenticator.beta", + "B7F62B65BN.com.okta.authenticator.beta.auth-service-extension", + "7WXXBW6Z2Y.com.okta.mobile.internalrelease", + "7WXXBW6Z2Y.com.okta.mobile.internalrelease.auth-service-extension" + ], + "key1": "value1", + "key2": "value2", + "key3": { + "key3.1": "value3.1" + } + } + } + } + }, + "assetlinks.json": { + "customized": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/well-known-uris/assetlinks.json/customized" + } + }, + "representation": [ + { + "key1": "value1", + "key2": "value2", + "key3": { + "key3.1": "value3.1" + } + } + ] + } + }, + "webauthn": { + "customized": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/well-known-uris/webauthn/customized" + } + }, + "representation": { + "origins": [ + "https://example1.com" + ] + } + } + } + }, + "_links": { + "apple-app-site-association": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/well-known-uris/apple-app-site-association" + }, + "assetlinks.json": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/well-known-uris/assetlinks.json" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/well-known-uris" + }, + "webauthn": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/well-known-uris/webauthn" + } + } + } + }, + "WindowsOSAccountListResponse": { + "summary": "List of Windows OS accounts", + "value": [ + { + "_embedded": { + "accountLinkedEnrollments": [ + { + "_embedded": { + "lastAuthenticatedOn": "2026-04-09T17:22:56.000Z" + }, + "created": "2026-01-19T17:22:30.000Z", + "id": "ukp1fxtdiJkUQiX220g5", + "lastUpdated": "2026-01-19T17:22:30.000Z", + "profile": { + "authenticationMethod": "PASSWORD" + }, + "status": "ACTIVE", + "type": "platform_sso" + } + ], + "users": [ + { + "id": "00u1fxs5JcdX9jsfc0g5", + "profile": { + "email": "carmel.sonne@okta.com", + "firstName": "Carmel", + "lastName": "Sonne", + "login": "carmel.sonne@okta.com" + }, + "status": "ACTIVE" + } + ] + }, + "_links": { + "device": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4/os-accounts/dao3qgkIEKjhNZudR0g4" + } + }, + "created": "2026-01-19T17:22:30.000Z", + "deviceId": "guo4a5u7JHHhjXrMK0g4", + "id": "dao3qgkIEKjhNZudR0g4", + "lastSeenAt": "2026-04-09T17:22:56.000Z", + "lastUpdated": "2026-01-19T17:22:30.000Z", + "platform": "WINDOWS", + "profile": { + "GUID": "4ac29c85-d847-4492-96cb-46e337170c33", + "directoryJoinStatus": "AD", + "downLevelUsername": "okta\\carmel.sonne", + "fullName": "Carmel Sonne", + "qualifiedUsername": "okta\\carmel.sonne", + "securityId": "S-1-5-21-1004336348-1177238915-682003330-512", + "type": "WINDOWS", + "upn": "carmel.sonne@okta.com" + }, + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "Carmel Sonne" + }, + "resourceId": "dao3qgkIEKjhNZudR0g4", + "resourceType": "DOSAccount", + "status": "ACTIVE" + } + ] + }, + "WindowsOSAccountResponse": { + "summary": "Windows OS account", + "value": { + "_embedded": { + "accountLinkedEnrollments": [ + { + "_embedded": { + "lastAuthenticatedOn": "2026-04-09T17:22:56.000Z" + }, + "created": "2026-01-19T17:22:30.000Z", + "id": "ukp1fxtdiJkUQiX220g5", + "lastUpdated": "2026-01-19T17:22:30.000Z", + "profile": { + "authenticationMethod": "PASSWORD" + }, + "status": "ACTIVE", + "type": "platform_sso" + } + ], + "users": [ + { + "id": "00u1fxs5JcdX9jsfc0g5", + "profile": { + "email": "carmel.sonne@okta.com", + "firstName": "Carmel", + "lastName": "Sonne", + "login": "carmel.sonne@okta.com" + }, + "status": "ACTIVE" + } + ] + }, + "_links": { + "device": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4" + }, + "self": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4/os-accounts/dao3qgkIEKjhNZudR0g4" + } + }, + "created": "2026-01-19T17:22:30.000Z", + "deviceId": "guo4a5u7JHHhjXrMK0g4", + "id": "dao3qgkIEKjhNZudR0g4", + "lastSeenAt": "2026-04-09T17:22:56.000Z", + "lastUpdated": "2026-01-19T17:22:30.000Z", + "platform": "WINDOWS", + "profile": { + "GUID": "4ac29c85-d847-4492-96cb-46e337170c33", + "directoryJoinStatus": "AD", + "downLevelUsername": "okta\\carmel.sonne", + "fullName": "Carmel Sonne", + "qualifiedUsername": "okta\\carmel.sonne", + "securityId": "S-1-5-21-1004336348-1177238915-682003330-512", + "type": "WINDOWS", + "upn": "carmel.sonne@okta.com" + }, + "resourceAlternateId": null, + "resourceDisplayName": { + "sensitive": false, + "value": "Carmel Sonne" + }, + "resourceId": "dao3qgkIEKjhNZudR0g4", + "resourceType": "DOSAccount", + "status": "ACTIVE" + } + }, + "activateOAuth2ClientSecretResponse": { + "summary": "Activate secret response example", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate" + } + }, + "client_secret": "DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B", + "created": "2023-04-06T21:32:33.000Z", + "id": "ocs2f50kZB0cITmYU0g4", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "secret_hash": "0WOOvBSzV9clc4Nr7Rbaug", + "status": "ACTIVE" + } + }, + "activeAPIServiceIntegrationInstanceSecretResponse": { + "summary": "Activate secret response example", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate" + } + }, + "client_secret": "***MQGQ", + "created": "2023-04-06T21:32:33.000Z", + "id": "ocs2f50kZB0cITmYU0g4", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "secret_hash": "0WOOvBSzV9clc4Nr7Rbaug", + "status": "ACTIVE" + } + }, + "add-ldap-user-request": { + "summary": "Add LDAP user to group", + "value": { + "id": "00g1xucgTZFrziXg10g4", + "parameters": { + "action": "ADD", + "attribute": "uniqueMember", + "values": [ + "00u1bh5efGKMsSiLv0g4" + ] + } + } + }, + "add-user-request": { + "summary": "Add AD user to group", + "value": { + "id": "00g1xucgTZFrziXg10g4", + "parameters": { + "action": "ADD", + "attribute": "member", + "values": [ + "00u1bh5efGKMsSiLv0g4" + ] + } + } + }, + "amc-two-chain": { + "summary": "App sign-in policy - Allow two authentication method chains", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul7yut96gmsOzKAA1d6" + } + }, + "actions": { + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "chains": [ + { + "authenticationMethods": [ + { + "key": "okta_password", + "method": "password" + } + ], + "next": [ + { + "authenticationMethods": [ + { + "key": "phone_number", + "method": "sms" + } + ] + } + ] + }, + { + "authenticationMethods": [ + { + "key": "okta_verify", + "method": "signed_nonce", + "userVerification": "REQUIRED" + } + ] + } + ], + "type": "AUTH_METHOD_CHAIN" + } + } + }, + "name": "Allow two authentication method chains", + "type": "ACCESS_POLICY" + } + }, + "bulkDeletePayload": { + "value": { + "entityType": "USERS", + "profiles": [ + { + "externalId": "EXT123456784C2IF" + }, + { + "externalId": "EXT123456784C3IF" + }, + { + "externalId": "EXT123456784C4IF" + } + ] + } + }, + "bulkGroupDeletePayload": { + "value": { + "externalIds": [ + "GROUPEXT123456784C2IF", + "GROUPEXT123456784C3IF", + "GROUPEXT123456784C4IF" + ] + } + }, + "bulkGroupMembershipsDeletePayload": { + "value": { + "memberships": [ + { + "groupExternalId": "GROUPEXT123456784C2IFA", + "memberExternalIds": [ + "USEREXT123456784C2IFA", + "USEREXT123456784C3IFB", + "USEREXT123456784C4IFC" + ] + }, + { + "groupExternalId": "GROUPEXT123456784C2IFB", + "memberExternalIds": [ + "USEREXT123456784C2IFA", + "USEREXT123456784C3IFB", + "USEREXT123456784C4IFC" + ] + } + ] + } + }, + "bulkGroupMembershipsUpsertPayload": { + "value": { + "memberships": [ + { + "groupExternalId": "GROUPEXT123456784C2IFA", + "memberExternalIds": [ + "USEREXT123456784C2IFA", + "USEREXT123456784C3IFB", + "USEREXT123456784C4IFC" + ] + }, + { + "groupExternalId": "GROUPEXT123456784C2IFB", + "memberExternalIds": [ + "USEREXT123456784C2IFA", + "USEREXT123456784C3IFB", + "USEREXT123456784C4IFC" + ] + } + ] + } + }, + "bulkGroupUpsertPayload": { + "value": { + "profiles": [ + { + "externalId": "GROUPEXT123456784C2IF", + "profile": { + "description": "group1 description", + "displayName": "group1" + } + }, + { + "externalId": "GROUPEXT123456784C3IF", + "profile": { + "description": "group2 description", + "displayName": "group2" + } + } + ] + } + }, + "bulkUpsertPayload": { + "value": { + "entityType": "USERS", + "profiles": [ + { + "externalId": "EXT123456784C2IF", + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "homeAddress": "10800 NE 8th St #600, Bellevue, WA 98004", + "lastName": "Brock", + "mobilePhone": "123-456-7890", + "secondEmail": "isaac2.brock@example.com", + "userName": "isaac.brock@example.com" + } + }, + { + "externalId": "EXT123456784C3IF", + "profile": { + "email": "jane.smith@example.com", + "firstName": "Jane", + "homeAddress": "Seattle, WA 98101", + "lastName": "Smith", + "mobilePhone": "555-123-4567", + "secondEmail": "jane2.smith@example.com", + "userName": "jane.smith@example.com" + } + } + ] + } + }, + "cloud-rule": { + "summary": "Global session policy - Challenge cloud users", + "value": { + "actions": { + "signon": { + "access": "ALLOW", + "factorPromptMode": "ALWAYS", + "rememberDeviceByDefault": false, + "requireFactor": true, + "session": { + "maxSessionIdleMinutes": 720, + "maxSessionLifetimeMinutes": 0, + "usePersistentCookie": false + } + } + }, + "conditions": { + "authContext": { + "authType": "ANY" + }, + "network": { + "connection": "ZONE", + "include": [ + "00u7yq5goxNFTiMjW1d7" + ] + }, + "people": { + "groups": { + "exclude": [], + "include": [] + }, + "users": { + "exclude": [], + "include": [] + } + } + }, + "name": "Challenge Cloud Users", + "type": "SIGN_ON" + } + }, + "cloud-rule-response": { + "summary": "Global session policy - Challenge cloud users", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "signon": { + "access": "ALLOW", + "factorPromptMode": "ALWAYS", + "primaryFactor": "PASSWORD_IDP_ANY_FACTOR", + "rememberDeviceByDefault": false, + "requireFactor": true, + "session": { + "maxSessionIdleMinutes": 720, + "maxSessionLifetimeMinutes": 0, + "usePersistentCookie": false + } + } + }, + "conditions": { + "authContext": { + "authType": "ANY" + }, + "identityProvider": { + "provider": "ANY" + }, + "network": { + "connection": "ZONE", + "include": [ + "00u7yq5goxNFTiMjW1d7" + ] + }, + "people": { + "groups": { + "exclude": [], + "include": [] + }, + "users": { + "exclude": [], + "include": [] + } + }, + "risk": { + "behaviors": [] + }, + "riskScore": { + "level": "ANY" + } + }, + "created": "2024-04-25T17:35:02.000Z", + "id": "rule8jjozjGMGbHyC1d6", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Challenge Cloud Users", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "SIGN_ON" + } + }, + "create-access-policy-response": { + "summary": "ACCESS_POLICY", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/lifecycle/deactivate" + }, + "deviceSignalCollectionPolicy": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{deviceSignalCollectionPolicyId}" + }, + "mappings": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/mappings" + }, + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2024-04-25T17:35:02.000Z", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "ACCESS_POLICY" + } + }, + "create-auth-policy-rule-condition": { + "summary": "App sign-in policy - Create rule with conditions", + "value": { + "actions": { + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "constraints": [ + { + "knowledge": { + "reauthenticateIn": "PT2H", + "types": [ + "password" + ] + } + } + ], + "factorMode": "2FA", + "reauthenticateIn": "PT2H", + "type": "ASSURANCE" + } + } + }, + "conditions": { + "elCondition": { + "condition": "security.risk.level == 'HIGH'" + }, + "network": { + "connection": "ZONE", + "exclude": [ + "00u7yq5goxNFTiMjW1d7" + ] + }, + "people": { + "groups": { + "exclude": [], + "include": [ + "00g9i12jictsYdZdi1d7" + ] + }, + "users": { + "exclude": [ + "00u7yq5goxNFTiMjW1d7" + ], + "include": [] + } + }, + "platform": { + "include": [ + { + "os": { + "type": "IOS" + }, + "type": "MOBILE" + }, + { + "os": { + "type": "ANDROID" + }, + "type": "MOBILE" + }, + { + "os": { + "type": "MACOS" + }, + "type": "DESKTOP" + } + ] + }, + "riskScore": { + "level": "ANY" + }, + "userType": { + "exclude": [ + "otyezu4m0xN6w5JEa1d7" + ], + "include": [] + } + }, + "name": "Rule with conditions", + "system": false, + "type": "ACCESS_POLICY" + } + }, + "create-auth-policy-rule-condition-response": { + "summary": "App sign-in policy - rule with conditions", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul7yut96gmsOzKAA1d6" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul7yut96gmsOzKAA1d6" + } + }, + "actions": { + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "constraints": { + "knowledge": { + "reauthenticateIn": "PT2H", + "required": true, + "types": [ + "password" + ] + } + }, + "factorMode": "2FA", + "reauthenticateIn": "PT2H", + "type": "ASSURANCE" + } + } + }, + "conditions": { + "elCondition": { + "condition": "security.risk.level == 'HIGH'" + }, + "network": { + "connection": "ZONE", + "exclude": [ + "nzo9o4rctwQCJNE6y1d7" + ] + }, + "people": { + "groups": { + "include": [ + "00g9i12jictsYdZdi1d7" + ] + }, + "users": { + "exclude": [ + "00u7yq5goxNFTiMjW1d7" + ] + } + }, + "platform": { + "exclude": [], + "include": [ + { + "os": { + "type": "IOS" + }, + "type": "MOBILE" + }, + { + "os": { + "type": "ANDROID" + }, + "type": "MOBILE" + }, + { + "os": { + "type": "MACOS" + }, + "type": "DESKTOP" + } + ] + }, + "riskScore": { + "level": "ANY" + }, + "userType": { + "exclude": [ + "otyezu4m0xN6w5JEa1d7" + ], + "include": [] + } + }, + "created": "2024-04-25T17:35:02.000Z", + "id": "rule8jjozjGMGbHyC1d6", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Rule with conditions", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "ACCESS_POLICY" + } + }, + "create-device-signal-collection-rule": { + "summary": "Device signal collection policy - collect context for Okta Verify devices", + "value": { + "actions": { + "deviceSignalCollection": { + "deviceContextProviders": [ + { + "key": "OKTA_VERIFY", + "userIdentification": "ALLOW" + }, + { + "id": "0oa159mE9aOSpCwmr0g4", + "key": "DEVICE_POSTURE_IDP" + } + ] + } + }, + "name": "Device signal collection rule", + "type": "DEVICE_SIGNAL_COLLECTION" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "create-group-rule-request-example": { + "summary": "Create group rule request example", + "value": { + "actions": { + "assignUserToGroups": { + "groupIds": [ + "00gjitX9HqABSoqTB0g3" + ] + } + }, + "conditions": { + "expression": { + "type": "urn:okta:expression:1.0", + "value": "user.role==\"Engineer\"" + }, + "people": { + "groups": { + "exclude": [] + }, + "users": { + "exclude": [ + "00u22w79JPMEeeuLr0g4" + ] + } + } + }, + "name": "Engineering group rule", + "type": "group_rule" + } + }, + "create-okta-sign-on-policy-response": { + "summary": "OKTA_SIGN_ON", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/lifecycle/deactivate" + }, + "mappings": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/mappings" + }, + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "2024-04-25T17:35:02.000Z", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "OKTA_SIGN_ON" + } + }, + "create-user-in-group-request": { + "description": "See [Create user in group](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#create-user-in-group)", + "value": { + "groupIds": [ + "00g1emaKYZTWRYYRRTSK", + "00garwpuyxHaWOkdV0g4" + ], + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + } + } + }, + "create-user-in-group-response": { + "value": { + "_links": { + "activate": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/activate" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + } + }, + "activated": null, + "created": "2013-07-02T21:36:25.344Z", + "credentials": { + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00ub0oNGTSWTBKOLGLNR", + "lastLogin": null, + "lastUpdated": "2013-07-02T21:36:25.344Z", + "passwordChanged": null, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + }, + "status": "STAGED", + "statusChanged": null + } + }, + "create-user-with-authentication-provider-request": { + "description": "Set `activate` parameter to `true`. See [Create user with authentication provider](https://developer.okta.com/docs/api/openapi/okta-management/management/user/create-user-with-password-and-recovery-question#user/Create-user-with-authentication-provider).", + "value": { + "credentials": { + "provider": { + "name": "FEDERATION", + "type": "FEDERATION" + } + }, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + } + } + }, + "create-user-with-authentication-provider-response": { + "value": { + "_links": { + "changeRecoveryQuestion": { + "href": "https://{yourOktaDomain}/api/v1/users/00uijntSwJjSHtDY70g3/credentials/change_recovery_question", + "method": "POST" + }, + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/users/00uijntSwJjSHtDY70g3/lifecycle/deactivate", + "method": "POST" + }, + "resetPassword": { + "href": "https://{yourOktaDomain}/api/v1/users/00uijntSwJjSHtDY70g3/lifecycle/reset_password", + "method": "POST" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + } + }, + "activated": "2016-01-19T22:02:08.000Z", + "created": "2016-01-19T22:02:08.000Z", + "credentials": { + "provider": { + "name": "FEDERATION", + "type": "FEDERATION" + } + }, + "id": "00uijntSwJjSHtDY70g3", + "lastLogin": null, + "lastUpdated": "2016-01-19T22:02:08.000Z", + "passwordChanged": null, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337", + "secondEmail": null + }, + "status": "ACTIVE", + "statusChanged": "2016-01-19T22:02:08.000Z" + } + }, + "create-user-with-imported-hashed-password-request": { + "description": "Set `activate` parameter to `true`. See [Create user with imported hashed password](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#create-user-with-imported-hashed-password).", + "value": { + "credentials": { + "password": { + "hash": { + "algorithm": "BCRYPT", + "salt": "rwh3vH166HCH/NT9XV5FYu", + "value": "qaMqvAPULkbiQzkTCWo5XDcvzpk8Tna", + "workFactor": 10 + } + } + }, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + } + } + }, + "create-user-with-imported-hashed-password-response": { + "value": { + "_links": { + "activate": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/activate" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + } + }, + "activated": null, + "created": "2013-07-02T21:36:25.344Z", + "credentials": { + "password": {}, + "provider": { + "name": "IMPORT", + "type": "IMPORT" + } + }, + "id": "00ub0oNGTSWTBKOLGLNR", + "lastLogin": null, + "lastUpdated": "2013-07-02T21:36:25.344Z", + "passwordChanged": "2013-07-02T21:36:25.344Z", + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + }, + "status": "ACTIVE", + "statusChanged": null + } + }, + "create-user-with-non-default-user-type-request": { + "description": "See [Create user with non-default user type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#create-user-with-non-default-user-type)", + "value": { + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + }, + "type": { + "id": "otyfnjfba4ye7pgjB0g4" + } + } + }, + "create-user-with-non-default-user-type-response": { + "value": { + "_links": { + "activate": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/activate" + }, + "schema": { + "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscfnjfba4ye7pgjB0g4" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + }, + "type": { + "href": "https://{yourOktaDomain}/api/v1/meta/types/user/otyfnjfba4ye7pgjB0g4" + } + }, + "activated": null, + "created": "2013-07-02T21:36:25.344Z", + "credentials": { + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00ub0oNGTSWTBKOLGLNR", + "lastLogin": null, + "lastUpdated": "2013-07-02T21:36:25.344Z", + "passwordChanged": null, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + }, + "status": "STAGED", + "statusChanged": null, + "type": { + "id": "otyfnjfba4ye7pgjB0g4" + } + } + }, + "create-user-with-password-and-recovery-question-request": { + "description": "See [Create user with password and recovery question](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#create-user-with-password-and-recovery-question)", + "value": { + "credentials": { + "password": { + "value": "tlpWENT2m" + }, + "recovery_question": { + "answer": "Annie Oakley", + "question": "Who is a major player in the cowboy scene?" + } + }, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + } + } + }, + "create-user-with-password-and-recovery-question-response": { + "value": { + "_links": { + "activate": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/activate" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + } + }, + "activated": null, + "created": "2013-07-02T21:36:25.344Z", + "credentials": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + }, + "recovery_question": { + "question": "Who's a major player in the cowboy scene?" + } + }, + "id": "00ub0oNGTSWTBKOLGLNR", + "lastLogin": null, + "lastUpdated": "2013-07-02T21:36:25.344Z", + "passwordChanged": "2013-07-02T21:36:25.344Z", + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + }, + "status": "STAGED", + "statusChanged": null + } + }, + "create-user-with-password-import-inline-hook-request": { + "description": "Set `activate` parameter to `true`. See [Create user with password import inline hook](https://developer.okta.com/docs/api/openapi/okta-management/management/user/create-user-with-imported-hashed-password#user/Create-user-with-password-import-inline-hook).", + "value": { + "credentials": { + "password": { + "hook": { + "type": "default" + } + } + }, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + } + } + }, + "create-user-with-password-import-inline-hook-response": { + "value": { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + } + }, + "activated": null, + "created": "2013-07-02T21:36:25.344Z", + "credentials": { + "password": {}, + "provider": { + "name": "IMPORT", + "type": "IMPORT" + } + }, + "id": "00ub0oNGTSWTBKOLGLNR", + "lastLogin": null, + "lastUpdated": "2013-07-02T21:36:25.344Z", + "passwordChanged": "2013-07-02T21:36:25.344Z", + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + }, + "status": "ACTIVE", + "statusChanged": null + } + }, + "create-user-with-password-request": { + "description": "Set `activate` parameter to `true`. See [Create user with password](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#create-user-with-password).", + "value": { + "credentials": { + "password": { + "value": "tlpWENT2m" + } + }, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + } + } + }, + "create-user-with-password-response": { + "value": { + "_links": { + "activate": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/activate" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + } + }, + "activated": null, + "created": "2013-07-02T21:36:25.344Z", + "credentials": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00ub0oNGTSWTBKOLGLNR", + "lastLogin": null, + "lastUpdated": "2013-07-02T21:36:25.344Z", + "passwordChanged": "2013-07-02T21:36:25.344Z", + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + }, + "status": "ACTIVE", + "statusChanged": null + } + }, + "create-user-with-recovery-question-request": { + "description": "See [Create user with recovery question](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#create-user-with-recovery-question)", + "value": { + "credentials": { + "recovery_question": { + "answer": "Annie Oakley", + "question": "Who is a major player in the cowboy scene?" + } + }, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + } + } + }, + "create-user-with-recovery-question-response": { + "value": { + "_links": { + "activate": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/activate" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + } + }, + "activated": null, + "created": "2013-07-02T21:36:25.344Z", + "credentials": { + "provider": { + "name": "OKTA", + "type": "OKTA" + }, + "recovery_question": { + "question": "Who's a major player in the cowboy scene?" + } + }, + "id": "00ub0oNGTSWTBKOLGLNR", + "lastLogin": null, + "lastUpdated": "2013-07-02T21:36:25.344Z", + "passwordChanged": null, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + }, + "status": "STAGED", + "statusChanged": null + } + }, + "create-user-without-credentials-request": { + "description": "See [Create user without credentials](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#create-user-without-credentials)", + "value": { + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + } + } + }, + "create-user-without-credentials-response": { + "value": { + "_links": { + "activate": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/activate" + }, + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" + } + }, + "activated": null, + "created": "2013-07-02T21:36:25.344Z", + "credentials": { + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00ub0oNGTSWTBKOLGLNR", + "lastLogin": null, + "lastUpdated": "2013-07-02T21:36:25.344Z", + "passwordChanged": null, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + }, + "status": "STAGED", + "statusChanged": null + } + }, + "createFederatedClaimRequestBody": { + "summary": "Create federated claim example", + "value": { + "expression": "appuser.entitlements.role", + "name": "role" + } + }, + "createInterclientTrustMappingRequestBody": { + "summary": "Create an interclient target and allowed app mapping", + "value": { + "id": "0oa89ks1irGAcYwXw0g5" + } + }, + "createOAuth2ClientSecretCustomRequestBody": { + "summary": "Add a user provided client secret", + "value": { + "client_secret": "DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B", + "status": "ACTIVE" + } + }, + "createOAuth2ClientSecretSystemGeneratedRequestBody": { + "summary": "Add a system-generated client secret", + "value": {} + }, + "deactivateOAuth2ClientJsonWebKeyResponse": { + "summary": "Deactivate JSON signing key example", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/jwks/pks2f50kZB0cITmYU0g4/lifecycle/activate" + } + }, + "alg": "RS256", + "created": "2023-04-06T21:32:33.000Z", + "e": "AQAB", + "id": "pks2f50kZB0cITmYU0g4", + "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", + "status": "INACTIVE", + "use": "sig" + } + }, + "deactivateOAuth2ClientSecretResponse": { + "summary": "Deactivate secret response example", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4" + } + }, + "client_secret": "DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B", + "created": "2023-02-21T20:08:24.000Z", + "id": "ocs2f4zrZbs8nUa7p0g4", + "lastUpdated": "2023-02-21T20:08:24.000Z", + "secret_hash": "yk4SVx4sUWVJVbHt6M-UPA", + "status": "INACTIVE" + } + }, + "deny-rule": { + "summary": "Global session policy - Deny users", + "value": { + "actions": { + "signon": { + "access": "DENY", + "requireFactor": false + } + }, + "conditions": { + "authContext": { + "authType": "ANY" + }, + "network": { + "connection": "ANYWHERE" + } + }, + "name": "Deny users", + "type": "SIGN_ON" + } + }, + "deny-rule-response": { + "summary": "Global session policy - Deny users", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "signon": { + "access": "DENY", + "primaryFactor": "PASSWORD_IDP", + "rememberDeviceByDefault": false, + "requireFactor": false, + "session": { + "maxSessionIdleMinutes": 120, + "maxSessionLifetimeMinutes": 0, + "usePersistentCookie": false + } + } + }, + "conditions": { + "authContext": { + "authType": "ANY" + }, + "identityProvider": { + "provider": "ANY" + }, + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + }, + "risk": { + "behaviors": [] + }, + "riskScore": { + "level": "ANY" + } + }, + "created": "2024-04-25T17:35:02.000Z", + "id": "rule8jjozjGMGbHyC1d6", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Deny", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "SIGN_ON" + } + }, + "device-condition-with-oamp-request": { + "summary": "Okta account management policy rule with device conditions", + "value": { + "actions": { + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "constraints": [ + { + "possession": { + "phishingResistant": "REQUIRED", + "userVerification": "OPTIONAL" + } + } + ], + "factorMode": "2FA", + "reauthenticateIn": "PT1H", + "type": "ASSURANCE" + } + } + }, + "conditions": { + "device": { + "assurance": { + "include": [ + "dae1f42iavrXPlAtG0g5" + ] + }, + "managed": true, + "registered": true + }, + "elCondition": {}, + "network": { + "connection": "ANYWHERE" + }, + "people": { + "groups": { + "exclude": [], + "include": [] + }, + "users": { + "exclude": [], + "include": [] + } + }, + "platform": { + "include": [] + }, + "riskScore": { + "level": "ANY" + }, + "userType": { + "exclude": [], + "include": [] + } + }, + "name": "OAMP rule with device conditions", + "system": false, + "type": "ACCESS_POLICY" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "device-condition-with-oamp-response": { + "summary": "Okta account management policy rule with device conditions", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst159zO35QB45yzK0g4/rules/rul2nf9gMuOPzNITs0g4/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst159zO35QB45yzK0g4/rules/rul2nf9gMuOPzNITs0g4" + } + }, + "actions": { + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "constraints": [ + { + "possession": { + "phishingResistant": "REQUIRED", + "userVerification": "OPTIONAL" + } + } + ], + "factorMode": "1FA", + "reauthenticateIn": "PT0S", + "type": "ASSURANCE" + } + } + }, + "conditions": { + "device": { + "assurance": { + "include": [ + "dae1f42iavrXPlAtG0g5" + ] + }, + "managed": true, + "registered": true + }, + "elCondition": {}, + "network": { + "connection": "ANYWHERE" + }, + "people": { + "groups": { + "exclude": [], + "include": [] + }, + "users": { + "exclude": [], + "include": [] + } + }, + "platform": { + "include": [] + }, + "riskScore": { + "level": "ANY" + }, + "userType": { + "exclude": [], + "include": [] + } + }, + "created": "2025-09-07T19:35:36.000Z", + "id": "rul2nf9gMuOPzNITs0g4", + "lastUpdated": "2025-10-21T22:40:27.000Z", + "name": "OAMP rule with device conditions", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "ACCESS_POLICY" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "device-signal-collection-policy-response": { + "summary": "DEVICE_SIGNAL_COLLECTION", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/lifecycle/deactivate" + }, + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2024-04-25T17:35:02.000Z", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "DEVICE_SIGNAL_COLLECTION" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "device-signal-collection-rule-response": { + "summary": "Device signal collection policy - collect context for Okta Verify devices", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul7yut96gmsOzKAA1d6" + } + }, + "actions": { + "deviceSignalCollection": { + "deviceContextProviders": [ + { + "key": "OKTA_VERIFY", + "userIdentification": "IGNORE" + }, + { + "id": "0oa159mE9aOSpCwmr0g4", + "key": "DEVICE_POSTURE_IDP" + } + ] + } + }, + "conditions": null, + "created": "2023-05-01T21:13:15.000Z", + "id": "rul7yut96gmsOzKAA1d6", + "lastUpdated": "2023-05-01T21:13:15.000Z", + "name": "Device signal collection rule", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "DEVICE_SIGNAL_COLLECTION" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "editFeatureExample": { + "summary": "Enable Okta Personal admin settings", + "value": { + "enableEnduserEntryPoints": true, + "enableExportApps": true + } + }, + "entity-risk-rule-example": { + "summary": "Entity Risk Remediation Rule", + "value": { + "actions": { + "entityRisk": { + "actions": [ + { + "action": "TERMINATE_ALL_SESSIONS" + } + ] + } + }, + "description": "Monitors the org for entity risk changes (e.g., brute-force attacks, session hijacking). Configured here to automatically sign users out of all Okta and app sessions when specific identity-based threats are detected.", + "name": "Risk Remediation Rule", + "status": "ACTIVE", + "type": "ENTITY_RISK" + } + }, + "entity-risk-rule-response": { + "summary": "Entity risk policy - remediate identity-based threats", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/pol456xyz/rules/rul8zvt07hnsPkLBB2e7" + } + }, + "actions": { + "entityRisk": { + "actions": [ + { + "action": "TERMINATE_ALL_SESSIONS" + } + ] + } + }, + "created": "2023-11-01T10:00:00.000Z", + "description": "Monitors the org for entity risk changes (e.g., brute-force attacks, session hijacking). Configured here to automatically sign users out of all Okta and app sessions when specific identity-based threats are detected.", + "id": "rul8zvt07hnsPkLBB2e7", + "lastUpdated": "2023-11-05T14:30:00.000Z", + "name": "Risk Remediation Rule", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "ENTITY_RISK" + } + }, + "federatedClaimResponse": { + "summary": "An example federated claim", + "value": { + "created": "2024-12-25T03:00:00.000Z", + "expression": "appuser.entitlements.role", + "id": "ofc893fbjaBaqdtoX0g7", + "lastUpdated": "2024-12-25T03:00:00.000Z", + "name": "role" + } + }, + "get-entity-risk-policy-response": { + "summary": "ENTITY_RISK", + "value": { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2024-04-25T17:35:02.000Z", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "ENTITY_RISK" + } + }, + "get-identity-claim-sourcing-policy-response": { + "summary": "IDENTITY_CLAIM_SOURCING", + "value": { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2025-10-01T12:00:00.000Z", + "id": "policyId", + "lastUpdated": "2025-10-01T12:00:00.000Z", + "name": "Default policy", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "IDENTITY_CLAIM_SOURCING" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "get-okta-verify-release-policy-response": { + "summary": "CLIENT_UPDATE", + "value": { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2025-11-24T09:28:02.000Z", + "description": "Enables client update policy evaluation for the org.", + "id": "policyId", + "lastUpdated": "2025-11-24T09:28:02.000Z", + "name": "Client Update Policy", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "CLIENT_UPDATE" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "get-post-auth-session-policy-response": { + "summary": "POST_AUTH_SESSION", + "value": { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2024-04-25T17:35:02.000Z", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "POST_AUTH_SESSION" + } + }, + "get-session-violation-detection-policy-response": { + "summary": "SESSION_VIOLATION_DETECTION", + "value": { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2025-09-22T09:28:02.000Z", + "description": "Enables session violation detection for the org", + "id": "policyId", + "lastUpdated": "2025-09-22T09:28:02.000Z", + "name": "Session Violation Detection Policy", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "SESSION_VIOLATION_DETECTION" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "getBlockListExample": { + "summary": "List of blocked email domains", + "value": { + "domains": [ + "yahoo.com", + "google.com" + ] + } + }, + "group-example": { + "description": "Example of a group", + "summary": "Group example", + "value": { + "_links": { + "apps": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK/apps" + }, + "logo": [ + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-medium.png", + "name": "medium", + "type": "image/png" + }, + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-large.png", + "name": "large", + "type": "image/png" + } + ], + "users": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK/users" + } + }, + "created": "2015-02-06T10:11:28.000Z", + "id": "00g1emaKYZTWRYYRRTSK", + "lastMembershipUpdated": "2015-11-28T19:15:32.000Z", + "lastUpdated": "2015-10-05T19:16:43.000Z", + "objectClass": [ + "okta:user_group" + ], + "profile": { + "description": "All users West of The Rockies", + "name": "West Coast users" + }, + "type": "OKTA_GROUP" + } + }, + "group-rule-example": { + "description": "Example of a group rule", + "summary": "Group rule example", + "value": { + "actions": { + "assignUserToGroups": { + "groupIds": [ + "00gjitX9HqABSoqTB0g3" + ] + } + }, + "conditions": { + "expression": { + "type": "urn:okta:expression:1.0", + "value": "user.role==\"Engineer\"" + }, + "people": { + "groups": { + "exclude": [] + }, + "users": { + "exclude": [ + "00u22w79JPMEeeuLr0g4" + ] + } + } + }, + "created": "2016-12-01T14:40:04.000Z", + "id": "0pr3f7zMZZHPgUoWO0g4", + "lastUpdated": "2016-12-01T14:40:04.000Z", + "name": "Engineering group rule", + "status": "INACTIVE", + "type": "group_rule" + } + }, + "identity-claim-sourcing-rule-example": { + "summary": "Identity claims sourcing rule", + "value": { + "actions": { + "claimSourcing": { + "redirectType": "IDP_DISCOVERY", + "refresh": { + "filter": { + "include": [ + { + "id": "idpId1", + "name": "idpName1" + }, + { + "id": "idpId2", + "name": "idpName2" + } + ] + }, + "redirectType": "FIXED" + } + } + }, + "conditions": null, + "name": "Catch-all rule", + "priority": 99, + "status": "ACTIVE", + "type": "IDENTITY_CLAIM_SOURCING" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "identity-claim-sourcing-rule-response": { + "summary": "Identity claims sourcing policy rule", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "claimSourcing": { + "redirectType": "IDP_DISCOVERY", + "refresh": { + "filter": { + "include": [ + { + "id": "idpId1", + "name": "idpName1" + }, + { + "id": "idpId2", + "name": "idpName2" + } + ] + }, + "redirectType": "FIXED" + } + } + }, + "conditions": null, + "created": "2026-02-17T15:12:42.000Z", + "id": "rulIdentityClaimSourcing", + "lastUpdated": "2026-02-19T20:59:00.000Z", + "name": "Catch-all rule", + "priority": 99, + "status": "ACTIVE", + "system": true, + "type": "IDENTITY_CLAIM_SOURCING" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "idp-discovery-dynamic-routing-rule": { + "summary": "IdP discovery policy - Routing rule with dynamic IdP", + "value": { + "actions": { + "idp": { + "idpSelectionType": "DYNAMIC", + "matchCriteria": [ + { + "propertyName": "name", + "providerExpression": "login.identifier.substringAfter('@')" + } + ], + "providers": [], + "shouldFallBackToOkta": false + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + } + }, + "name": "Dynamic routing rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "IDP_DISCOVERY" + } + }, + "idp-discovery-dynamic-routing-rule-response": { + "summary": "IdP discovery policy - Routing rule with dynamic IdP", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "idp": { + "idpSelectionType": "DYNAMIC", + "matchCriteria": [ + { + "propertyName": "name", + "providerExpression": "login.identifier.substringAfter('@')" + } + ], + "providers": [], + "shouldFallBackToOkta": false + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + } + }, + "id": "ruleId", + "name": "Dynamic routing rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "IDP_DISCOVERY" + } + }, + "idp-discovery-policy-response": { + "summary": "IDP_DISCOVERY", + "value": { + "_links": { + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "IDP_DISCOVERY" + } + }, + "idp-discovery-specific-routing-rule": { + "summary": "IdP discovery policy - Routing rule with specific IdP", + "value": { + "actions": { + "idp": { + "idpSelectionType": "SPECIFIC", + "providers": [ + { + "id": "0oa5ks3WmHLRh8Ivr0g4", + "type": "GOOGLE" + } + ], + "shouldFallBackToOkta": false + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + } + }, + "name": "Specific routing rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "IDP_DISCOVERY" + } + }, + "idp-discovery-specific-routing-rule-response": { + "summary": "IdP discovery policy - Routing rule with specific IdP", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "idp": { + "idpSelectionType": "SPECIFIC", + "providers": [ + { + "id": "0oa5ks3WmHLRh8Ivr0g4", + "type": "GOOGLE" + } + ], + "shouldFallBackToOkta": false + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + } + }, + "id": "ruleId", + "name": "Specific routing rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "IDP_DISCOVERY" + } + }, + "inactiveAPIServiceIntegrationInstanceSecretResponse": { + "summary": "Deactivate secret response example", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4" + } + }, + "client_secret": "***DhOW", + "created": "2023-02-21T20:08:24.000Z", + "id": "ocs2f4zrZbs8nUa7p0g4", + "lastUpdated": "2023-02-21T20:08:24.000Z", + "secret_hash": "yk4SVx4sUWVJVbHt6M-UPA", + "status": "INACTIVE" + } + }, + "list-access-policy-response": { + "summary": "ACCESS_POLICY", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2024-04-25T17:35:02.000Z", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "ACCESS_POLICY" + } + ] + }, + "list-all-access-policy-rule-response": { + "summary": "ACCESS_POLICY", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "constraints": [], + "factorMode": "1FA", + "reauthenticateIn": "PT12H", + "type": "ASSURANCE" + } + } + }, + "conditions": null, + "created": "2024-04-25T17:35:02.000Z", + "id": "ruleId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Catch-all rule", + "priority": 99, + "status": "ACTIVE", + "system": true, + "type": "ACCESS_POLICY" + } + ] + }, + "list-all-device-signal-collection-rule-response": { + "summary": "DEVICE_SIGNAL_COLLECTION", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "deviceSignalCollection": { + "deviceContextProviders": [ + { + "key": "OKTA_VERIFY", + "userIdentification": "IGNORE" + }, + { + "key": "CHROME_DEVICE_TRUST" + }, + { + "id": "0oa159mE9aOSpCwmr0g4", + "key": "DEVICE_POSTURE_IDP" + } + ] + } + }, + "conditions": { + "network": { + "connection": "ZONE", + "exclude": [ + "nzo9o4rctwQCJNE6y1d7" + ] + }, + "platform": { + "include": [ + { + "os": { + "type": "ANDROID" + }, + "type": "MOBILE" + } + ] + } + }, + "created": "2024-11-20T18:22:15.000Z", + "id": "ruleId", + "lastUpdated": "2025-01-03T23:04:33.000Z", + "name": "Device signal collection rule", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "DEVICE_SIGNAL_COLLECTION" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "list-all-entity-risk-policy-rule-response": { + "summary": "ENTITY_RISK", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "entityRisk": { + "actions": [] + } + }, + "conditions": null, + "created": "2024-04-25T17:35:02.000Z", + "id": "ruleId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Catch-all rule", + "priority": 99, + "status": "ACTIVE", + "system": true, + "type": "ENTITY_RISK" + } + ] + }, + "list-all-identity-claim-sourcing-policy-rule-response": { + "summary": "IDENTITY_CLAIM_SOURCING", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "claimSourcing": { + "redirectType": "IDP_DISCOVERY", + "refresh": { + "filter": { + "include": [ + { + "id": "idpId1", + "name": "idpName1" + }, + { + "id": "idpId2", + "name": "idpName2" + } + ] + }, + "redirectType": "FIXED" + } + } + }, + "conditions": null, + "created": "2026-02-17T15:12:42.000Z", + "id": "ruleId", + "lastUpdated": "2026-02-19T20:59:00.000Z", + "name": "Catch-all rule", + "priority": 99, + "status": "ACTIVE", + "system": true, + "type": "IDENTITY_CLAIM_SOURCING" + } + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "list-all-idp-discovery-policy-rule-response": { + "summary": "IDP_DISCOVERY", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "idp": { + "idpSelectionType": "SPECIFIC", + "providers": [ + { + "type": "OKTA" + } + ], + "shouldFallBackToOkta": false + } + }, + "conditions": { + "app": { + "exclude": [], + "include": [] + }, + "network": { + "connection": "ANYWHERE" + }, + "platform": { + "exclude": [], + "include": [] + }, + "userIdentifier": { + "patterns": [] + } + }, + "created": "2024-08-27T19:51:15.000Z", + "id": "0prgu3bb10hce267M1d7", + "lastUpdated": "2024-08-27T19:51:15.000Z", + "name": "Test rule", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "IDP_DISCOVERY" + } + ] + }, + "list-all-mfa-enroll-policy-rule-response": { + "summary": "MFA_ENROLL", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "enroll": { + "self": "CHALLENGE" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "created": "2024-08-27T19:51:39.000Z", + "id": "0prgu3g4mon9ARm9F1d7", + "lastUpdated": "2024-08-27T19:51:39.000Z", + "name": "Test Rule", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "MFA_ENROLL" + } + ] + }, + "list-all-okta-verify-release-policy-rule-response": { + "summary": "CLIENT_UPDATE", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "updateControls": { + "actions": [] + } + }, + "conditions": {}, + "created": "2025-11-24T09:28:02.000Z", + "id": "ruleId", + "lastUpdated": "2025-11-24T09:28:02.000Z", + "name": "Okta Verify Update Rule", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "CLIENT_UPDATE" + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId2}" + } + }, + "actions": { + "updateControls": { + "actions": [] + } + }, + "conditions": null, + "created": "2025-11-24T09:28:02.000Z", + "id": "ruleId2", + "lastUpdated": "2025-11-24T09:28:02.000Z", + "name": "Catch-all rule", + "priority": 99, + "status": "ACTIVE", + "system": true, + "type": "CLIENT_UPDATE" + } + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "list-all-password-policy-rule-response": { + "summary": "PASSWORD", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "email" + ] + }, + "stepUp": { + "required": false + } + } + }, + "selfServiceUnlock": { + "access": "DENY" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "created": "2024-08-27T19:51:11.000Z", + "id": "0prgu3baytQGHuVEv1d7", + "lastUpdated": "2024-08-27T19:51:17.000Z", + "name": "Test Rule", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "PASSWORD" + } + ] + }, + "list-all-post-auth-session-policy-rule-response": { + "summary": "POST_AUTH_SESSION", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "postAuthSession": { + "failureActions": [] + } + }, + "conditions": { + "people": { + "users": { + "exclude": [] + } + } + }, + "created": "2024-04-25T17:35:02.000Z", + "id": "ruleId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Post auth rule", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "POST_AUTH_SESSION" + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId2}" + } + }, + "actions": { + "postAuthSession": { + "failureActions": [] + } + }, + "conditions": null, + "created": "2024-04-25T17:35:02.000Z", + "id": "ruleId2", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Catch-all rule", + "priority": 99, + "status": "ACTIVE", + "system": true, + "type": "POST_AUTH_SESSION" + } + ] + }, + "list-all-profile-enrollment-policy-rule-response": { + "summary": "PROFILE_ENROLLMENT", + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "profileEnrollment": { + "access": "ALLOW", + "activationRequirements": { + "emailVerification": true + }, + "preRegistrationInlineHooks": null, + "profileAttributes": [ + { + "label": "Email", + "name": "email", + "required": true + }, + { + "label": "First name", + "name": "firstName", + "required": true + }, + { + "label": "Last name", + "name": "lastName", + "required": true + } + ], + "progressiveProfilingAction": "DISABLED", + "targetGroupIds": null, + "uiSchemaId": "uisgu3bb4zTbvwD8S1d7", + "unknownUserAction": "DENY" + } + }, + "conditions": null, + "created": "2024-08-27T19:51:18.000Z", + "id": "rulgu3bb4oWR7qbMi1d7", + "lastUpdated": "2024-08-27T19:51:22.000Z", + "name": "Test Rule", + "priority": 99, + "status": "ACTIVE", + "system": true, + "type": "PROFILE_ENROLLMENT" + } + ] + }, + "list-all-session-violation-detection-policy-rule-response": { + "summary": "SESSION_VIOLATION_DETECTION", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "sessionViolationDetection": { + "policyEvaluation": { + "enabled": true + } + } + }, + "conditions": { + "network": { + "connection": "ZONE", + "include": [ + "nzo19rah4IjLGd3PD0g4" + ] + }, + "riskScore": { + "minRiskLevel": "LOW" + } + }, + "created": "2025-09-22T09:28:02.000Z", + "id": "ruleId", + "lastUpdated": "2025-09-22T09:28:02.000Z", + "name": "Session Violation Detection Rule", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "SESSION_VIOLATION_DETECTION" + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId2}" + } + }, + "actions": { + "sessionViolationDetection": { + "policyEvaluation": { + "enabled": true + } + } + }, + "conditions": null, + "created": "2025-09-22T09:28:02.000Z", + "id": "ruleId2", + "lastUpdated": "2025-09-22T09:28:02.000Z", + "name": "Catch-all rule", + "priority": 99, + "status": "ACTIVE", + "system": true, + "type": "SESSION_VIOLATION_DETECTION" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "list-all-sign-on-policy-rule-response": { + "summary": "OKTA_SIGN_ON", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "signon": { + "access": "ALLOW", + "factorLifetime": 15, + "factorPromptMode": "ALWAYS", + "primaryFactor": "PASSWORD_IDP_ANY_FACTOR", + "requireFactor": false, + "session": { + "maxSessionIdleMinutes": 720, + "maxSessionLifetimeMinutes": 0, + "usePersistentCookie": false + } + } + }, + "conditions": { + "identityProvider": { + "provider": "ANY" + }, + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + }, + "risk": { + "behaviors": [] + }, + "riskScore": { + "level": "ANY" + } + }, + "created": "2024-04-25T17:35:02.000Z", + "id": "0prh1sd28q5sXGW08697", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Test rule", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "SIGN_ON" + } + ] + }, + "list-apps-example": { + "description": "List all apps example", + "summary": "List apps example", + "value": [ + { + "_links": { + "appLinks": [ + { + "href": "https://{yourOktaDomain}/home/template_basic_auth/0oafwvZDWJKVLDCUWUAC/1438", + "name": "login", + "type": "text/html" + } + ], + "deactivate": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafwvZDWJKVLDCUWUAC/lifecycle/deactivate" + }, + "groups": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafwvZDWJKVLDCUWUAC/groups" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oafwvZDWJKVLDCUWUAC/users" + } + }, + "accessibility": { + "errorRedirectUrl": null, + "selfService": false + }, + "created": "2013-09-30T00:56:52.000Z", + "credentials": { + "scheme": "EDIT_USERNAME_AND_PASSWORD", + "userNameTemplate": { + "template": "${source.login}", + "type": "BUILT_IN" + } + }, + "features": [], + "id": "0oafwvZDWJKVLDCUWUAC", + "label": "Sample Basic Auth App", + "lastUpdated": "2013-09-30T00:56:52.000Z", + "name": "template_basic_auth", + "settings": { + "app": { + "authURL": "https://example.com/auth.html", + "url": "https://example.com/login.html" + } + }, + "signOnMode": "BASIC_AUTH", + "status": "ACTIVE", + "visibility": { + "appLinks": { + "login": true + }, + "autoSubmitToolbar": false, + "hide": { + "iOS": false, + "web": false + } + } + } + ] + }, + "list-device-signal-collection-policy-response": { + "summary": "DEVICE_SIGNAL_COLLECTION", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2025-04-25T17:35:02.000Z", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "2025-04-25T17:35:02.000Z", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "DEVICE_SIGNAL_COLLECTION" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "list-entity-risk-policy-response": { + "summary": "ENTITY_RISK", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2024-04-25T17:35:02.000Z", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "ENTITY_RISK" + } + ] + }, + "list-group-rules-example": { + "description": "List all group rules example", + "summary": "List group rules example", + "value": [ + { + "actions": { + "assignUserToGroups": { + "groupIds": [ + "00gjitX9HqABSoqTB0g3" + ] + } + }, + "conditions": { + "expression": { + "type": "urn:okta:expression:1.0", + "value": "user.role==\"Engineer\"" + }, + "people": { + "groups": { + "exclude": [] + }, + "users": { + "exclude": [ + "00u22w79JPMEeeuLr0g4" + ] + } + } + }, + "created": "2016-12-01T14:40:04.000Z", + "id": "0pr3f7zMZZHPgUoWO0g4", + "lastUpdated": "2016-12-01T14:40:04.000Z", + "name": "Engineering group rule", + "status": "INACTIVE", + "type": "group_rule" + } + ] + }, + "list-group-rules-with-expand-parameter": { + "description": "Example response when `expand=groupIdToGroupNameMap` is specified in the query parameter", + "summary": "List group rules (expanded)", + "value": [ + { + "_embedded": { + "groupIdToGroupNameMap": { + "00gjitX9HqABSoqTB0g3": "Engineering" + } + }, + "actions": { + "assignUserToGroups": { + "groupIds": [ + "00gjitX9HqABSoqTB0g3" + ] + } + }, + "conditions": { + "expression": { + "type": "urn:okta:expression:1.0", + "value": "user.role==\"Engineer\"" + }, + "people": { + "groups": { + "exclude": [] + }, + "users": { + "exclude": [ + "00u22w79JPMEeeuLr0g4" + ] + } + } + }, + "created": "2016-12-01T14:40:04.000Z", + "id": "0pr3f7zMZZHPgUoWO0g4", + "lastUpdated": "2016-12-01T14:40:04.000Z", + "name": "Engineering group rule", + "status": "INACTIVE", + "type": "group_rule" + } + ] + }, + "list-groups-examples": { + "description": "Lists an example of an OKTA_GROUP and an APP_GROUP", + "summary": "List all groups example", + "value": [ + { + "_links": { + "apps": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK/apps" + }, + "logo": [ + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-medium.png", + "name": "medium", + "type": "image/png" + }, + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-large.png", + "name": "large", + "type": "image/png" + } + ], + "users": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK/users" + } + }, + "created": "2015-02-06T10:11:28.000Z", + "id": "00g1emaKYZTWRYYRRTSK", + "lastMembershipUpdated": "2015-11-28T19:15:32.000Z", + "lastUpdated": "2015-10-05T19:16:43.000Z", + "objectClass": [ + "okta:user_group" + ], + "profile": { + "description": "All users West of The Rockies", + "name": "West Coast users" + }, + "type": "OKTA_GROUP" + }, + { + "_links": { + "apps": { + "href": "https://{yourOktaDomain}/api/v1/groups/00garwpuyxHaWOkdV0g4/apps" + }, + "logo": [ + { + "href": "https://{yourOktaDomain}/img/logos/groups/active_directory-medium.png", + "name": "medium", + "type": "image/png" + }, + { + "href": "https://{yourOktaDomain}/img/logos/groups/active_directory-large.png", + "name": "large", + "type": "image/png" + } + ], + "source": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa2v0el0gP90aqjJ0g7" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/groups/00garwpuyxHaWOkdV0g4/users" + } + }, + "created": "2015-08-15T19:15:17.000Z", + "id": "00garwpuyxHaWOkdV0g4", + "lastMembershipUpdated": "2015-08-15T19:15:17.000Z", + "lastUpdated": "2015-11-18T04:02:19.000Z", + "objectClass": [ + "okta:windows_security_principal" + ], + "profile": { + "description": "All users in the engineering department", + "dn": "CN=Engineering users,OU=Engineering,DC=corp,DC=example,DC=com", + "externalId": "OZJdWdONCU6h7WjQKp+LPA==", + "groupScope": "Global", + "groupType": "Security", + "name": "Engineering users", + "objectSid": "S-1-5-21-717838489-685202119-709183397-1177", + "samAccountName": "Engineering users", + "windowsDomainQualifiedName": "CORP\\Engineering users" + }, + "type": "APP_GROUP" + } + ] + }, + "list-groups-filter": { + "description": "Response with `filter=type+eq+%22OKTA_GROUP%22`", + "summary": "List all groups with filter by type", + "value": [ + { + "_links": { + "apps": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK/apps" + }, + "logo": [ + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-medium.png", + "name": "medium", + "type": "image/png" + }, + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-large.png", + "name": "large", + "type": "image/png" + } + ], + "users": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK/users" + } + }, + "created": "2015-02-06T10:11:28.000Z", + "id": "00g1emaKYZTWRYYRRTSK", + "lastMembershipUpdated": "2015-11-28T19:15:32.000Z", + "lastUpdated": "2015-10-05T19:16:43.000Z", + "objectClass": [ + "okta:user_group" + ], + "profile": { + "description": "All users West of The Rockies", + "name": "West Coast users" + }, + "type": "OKTA_GROUP" + }, + { + "_links": { + "apps": { + "href": "https://{yourOktaDomain}/api/v1/groups/00gak46y5hydV6NdM0g4/apps" + }, + "logo": [ + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-medium.png", + "name": "medium", + "type": "image/png" + }, + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-large.png", + "name": "large", + "type": "image/png" + } + ], + "users": { + "href": "https://{yourOktaDomain}/api/v1/groups/00gak46y5hydV6NdM0g4/users" + } + }, + "created": "2015-07-22T08:45:03.000Z", + "id": "00gak46y5hydV6NdM0g4", + "lastMembershipUpdated": "2015-10-22T08:45:03.000Z", + "lastUpdated": "2015-07-22T08:45:03.000Z", + "objectClass": [ + "okta:user_group" + ], + "profile": { + "description": "Keep Calm and Single Sign-On", + "name": "Squabble of users" + }, + "type": "OKTA_GROUP" + } + ] + }, + "list-groups-search": { + "description": "Response with `search=lastUpdated+gt+%222015-10-01T00:00:00.000Z%22+or+lastMembershipUpdated+gt+%222015-10-01T00:00:00.000Z%22`", + "summary": "List all groups with search", + "value": [ + { + "_links": { + "apps": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK/apps" + }, + "logo": [ + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-medium.png", + "name": "medium", + "type": "image/png" + }, + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-large.png", + "name": "large", + "type": "image/png" + } + ], + "source": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa2v0el0gP90aqjJ0g7" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK/users" + } + }, + "created": "2015-02-06T10:11:28.000Z", + "id": "00g1emaKYZTWRYYRRTSK", + "lastMembershipUpdated": "2015-11-28T19:15:32.000Z", + "lastUpdated": "2015-10-05T19:16:43.000Z", + "objectClass": [ + "okta:user_group" + ], + "profile": { + "description": "All users West of The Rockies", + "name": "West Coast users" + }, + "type": "OKTA_GROUP" + }, + { + "_links": { + "apps": { + "href": "https://{yourOktaDomain}/api/v1/groups/00gak46y5hydV6NdM0g4/apps" + }, + "logo": [ + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-medium.png", + "name": "medium", + "type": "image/png" + }, + { + "href": "https://{yourOktaDomain}/img/logos/groups/okta-large.png", + "name": "large", + "type": "image/png" + } + ], + "source": { + "href": "https://{yourOktaDomain}/api/v1/apps/0oa2v0el0gP90aqjJ0g7" + }, + "users": { + "href": "https://{yourOktaDomain}/api/v1/groups/00gak46y5hydV6NdM0g4/users" + } + }, + "created": "2015-07-22T08:45:03.000Z", + "id": "00gak46y5hydV6NdM0g4", + "lastMembershipUpdated": "2015-10-22T08:45:03.000Z", + "lastUpdated": "2015-07-22T08:45:03.000Z", + "objectClass": [ + "okta:user_group" + ], + "profile": { + "description": "Keep Calm and Single Sign-On", + "name": "Squabble of users" + }, + "type": "OKTA_GROUP" + } + ] + }, + "list-identity-claim-sourcing-policy-response": { + "summary": "IDENTITY_CLAIM_SOURCING", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2025-10-01T12:00:00.000Z", + "id": "policyId", + "lastUpdated": "2025-10-01T12:00:00.000Z", + "name": "Default policy", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "IDENTITY_CLAIM_SOURCING" + } + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "list-idp-discovery-policy-response": { + "summary": "IDP_DISCOVERY", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "IDP_DISCOVERY" + } + ] + }, + "list-mfa-enroll-policy-auto-enroll-disabled-response": { + "summary": "MFA_ENROLL with email auto-enrollment disabled", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/lifecycle/deactivate" + }, + "mappings": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/mappings" + }, + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "settings": { + "authenticators": [ + { + "enroll": { + "autoEnroll": false, + "self": "NOT_ALLOWED" + }, + "key": "okta_email" + }, + { + "enroll": { + "self": "OPTIONAL" + }, + "key": "okta_verify" + }, + { + "enroll": { + "self": "REQUIRED" + }, + "key": "okta_password" + } + ], + "type": "AUTHENTICATORS" + }, + "status": "ACTIVE", + "system": true, + "type": "MFA_ENROLL" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "list-mfa-enroll-policy-response": { + "summary": "MFA_ENROLL", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/lifecycle/deactivate" + }, + "mappings": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/mappings" + }, + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "settings": { + "authenticators": [ + { + "enroll": { + "self": "NOT_ALLOWED" + }, + "key": "okta_email" + }, + { + "enroll": { + "self": "OPTIONAL" + }, + "key": "okta_verify" + }, + { + "enroll": { + "self": "REQUIRED" + }, + "key": "okta_password" + } + ], + "type": "AUTHENTICATORS" + }, + "status": "ACTIVE", + "system": true, + "type": "MFA_ENROLL" + } + ] + }, + "list-mfa-enroll-policy-with-grace-period-response": { + "summary": "MFA_ENROLL with grace period", + "value": [ + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/lifecycle/deactivate" + }, + "mappings": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/mappings" + }, + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "settings": { + "authenticators": [ + { + "enroll": { + "self": "NOT_ALLOWED" + }, + "key": "okta_email" + }, + { + "enroll": { + "self": "OPTIONAL" + }, + "key": "okta_verify" + }, + { + "enroll": { + "self": "REQUIRED" + }, + "key": "okta_password" + }, + { + "enroll": { + "gracePeriod": { + "expiry": "2025-01-01T18:30:45.000Z", + "type": "BY_DATE_TIME" + }, + "self": "REQUIRED" + }, + "key": "phone_number" + } + ], + "type": "AUTHENTICATORS" + }, + "status": "ACTIVE", + "system": true, + "type": "MFA_ENROLL" + } + ] + }, + "list-okta-sign-on-policy-response": { + "summary": "OKTA_SIGN_ON", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "2024-04-25T17:35:02.000Z", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "OKTA_SIGN_ON" + } + ] + }, + "list-okta-verify-release-policy-response": { + "summary": "CLIENT_UPDATE", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2025-11-24T09:28:02.000Z", + "description": "Enables client update policy evaluation for the org.", + "id": "policyId", + "lastUpdated": "2025-11-24T09:28:02.000Z", + "name": "Client Update Policy", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "CLIENT_UPDATE" + } + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "list-password-policy-response": { + "summary": "PASSWORD", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "authProvider": { + "provider": "provider" + }, + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "settings": { + "delegation": { + "options": { + "skipUnlock": false + } + }, + "password": { + "age": { + "expireWarnDays": 0, + "historyCount": 4, + "maxAgeDays": 0, + "minAgeMinutes": 0 + }, + "complexity": { + "dictionary": { + "common": { + "exclude": false + } + }, + "excludeAttributes": [], + "excludeUsername": true, + "minLength": 8, + "minLowerCase": 1, + "minNumber": null, + "minSymbol": 0, + "minUpperCase": 1 + }, + "lockout": { + "autoUnlockMinutes": 0, + "maxAttempts": 0, + "showLockoutFailures": false, + "userLockoutNotificationChannels": [] + } + }, + "recovery": { + "factors": { + "okta_call": { + "status": "INACTIVE" + }, + "okta_email": { + "properties": { + "recoveryToken": { + "tokenLifetimeMinutes": 10080 + } + }, + "status": "ACTIVE" + }, + "okta_sms": { + "status": "INACTIVE" + }, + "recovery_question": { + "properties": { + "complexity": { + "complexity": 4 + } + }, + "status": "ACTIVE" + } + } + } + }, + "status": "ACTIVE", + "system": true, + "type": "PASSWORD" + } + ] + }, + "list-password-policy-with-breached-protection-response": { + "summary": "PASSWORD with breached protection", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "authProvider": { + "provider": "provider" + }, + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "settings": { + "delegation": { + "options": { + "skipUnlock": false + } + }, + "password": { + "age": { + "expireWarnDays": 0, + "historyCount": 4, + "maxAgeDays": 0, + "minAgeMinutes": 0 + }, + "breachedProtection": { + "delegatedWorkflowId": "workflowId", + "expireAfterDays": 1, + "logoutEnabled": true + }, + "complexity": { + "dictionary": { + "common": { + "exclude": false + } + }, + "excludeAttributes": [], + "excludeUsername": true, + "minLength": 8, + "minLowerCase": 1, + "minNumber": null, + "minSymbol": 0, + "minUpperCase": 1 + }, + "lockout": { + "autoUnlockMinutes": 0, + "maxAttempts": 0, + "showLockoutFailures": false, + "userLockoutNotificationChannels": [] + } + }, + "recovery": { + "factors": { + "okta_call": { + "status": "INACTIVE" + }, + "okta_email": { + "properties": { + "recoveryToken": { + "tokenLifetimeMinutes": 10080 + } + }, + "status": "ACTIVE" + }, + "okta_sms": { + "status": "INACTIVE" + }, + "recovery_question": { + "properties": { + "complexity": { + "complexity": 4 + } + }, + "status": "ACTIVE" + } + } + } + }, + "status": "ACTIVE", + "system": true, + "type": "PASSWORD" + } + ] + }, + "list-post-auth-session-policy-response": { + "summary": "POST_AUTH_SESSION", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2024-04-25T17:35:02.000Z", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "POST_AUTH_SESSION" + } + ] + }, + "list-profile-enrollment-policy-response": { + "summary": "PROFILE_ENROLLMENT", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "PROFILE_ENROLLMENT" + } + ] + }, + "list-session-violation-detection-policy-response": { + "summary": "SESSION_VIOLATION_DETECTION", + "value": [ + { + "_links": { + "rules": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "2025-09-22T09:28:02.000Z", + "description": "Enables session violation detection for the org", + "id": "policyId", + "lastUpdated": "2025-09-22T09:28:02.000Z", + "name": "Session Violation Detection Policy", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "SESSION_VIOLATION_DETECTION" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "list-user-example": { + "value": [ + { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1f96ECLNVOKVMUSEA" + } + }, + "activated": "2013-12-12T16:14:22.000Z", + "created": "2013-12-12T16:14:22.000Z", + "credentials": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + } + }, + "id": "00u1f96ECLNVOKVMUSEA", + "lastLogin": "2013-12-12T22:14:22.000Z", + "lastUpdated": "2015-11-15T19:23:32.000Z", + "passwordChanged": "2013-12-12T22:14:22.000Z", + "profile": { + "email": "easy-e@example.com", + "firstName": "Easy", + "lastName": "E", + "login": "easy-e@example.com", + "mobilePhone": null + }, + "status": "ACTIVE", + "statusChanged": "2013-12-12T22:14:22.000Z" + } + ] + }, + "listFederatedClaimResponse": { + "summary": "List federated claim response example", + "value": [ + { + "created": "2024-12-25T03:00:00.000Z", + "expression": "appuser.entitlements.role", + "id": "ofc893fbjaBaqdtoX0g7", + "lastUpdated": "2024-12-25T03:00:00.000Z", + "name": "role" + }, + { + "created": "2024-12-25T05:00:00.000Z", + "expression": "appuser.entitlements.readOnly", + "id": "ofc893fbjaTxynmo5v93", + "lastUpdated": "2024-12-25T05:00:00.000Z", + "name": "readOnly" + } + ] + }, + "listStreamConfigurationExample": { + "summary": "List of SSF stream configurations example", + "value": [ + { + "aud": "https://example.com", + "delivery": { + "endpoint_url": "https://example.com", + "method": "urn:ietf:rfc:8935" + }, + "events_delivered": [ + "https://schemas.openid.net/secevent/caep/event-type/session-revoked", + "https://schemas.openid.net/secevent/caep/event-type/credential-change" + ], + "events_requested": [ + "https://schemas.openid.net/secevent/caep/event-type/session-revoked", + "https://schemas.openid.net/secevent/caep/event-type/credential-change" + ], + "events_supported": [ + "https://schemas.openid.net/secevent/caep/event-type/session-revoked", + "https://schemas.openid.net/secevent/caep/event-type/credential-change" + ], + "format": "iss_sub", + "iss": "https://{yourOktaDomain}", + "min_verification_interval": 0, + "stream_id": "esc1k235GIIztAuGK0g5" + } + ] + }, + "mfa-enroll-policy-auto-enroll-disabled-response": { + "summary": "MFA_ENROLL with email auto-enrollment disabled", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/lifecycle/deactivate" + }, + "mappings": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/mappings" + }, + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "settings": { + "authenticators": [ + { + "enroll": { + "autoEnroll": false, + "self": "OPTIONAL" + }, + "key": "okta_email" + }, + { + "enroll": { + "self": "OPTIONAL" + }, + "key": "okta_verify" + }, + { + "enroll": { + "self": "REQUIRED" + }, + "key": "okta_password" + } + ], + "type": "AUTHENTICATORS" + }, + "status": "ACTIVE", + "system": true, + "type": "MFA_ENROLL" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "mfa-enroll-policy-response": { + "summary": "MFA_ENROLL", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/lifecycle/deactivate" + }, + "mappings": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/mappings" + }, + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "settings": { + "authenticators": [ + { + "enroll": { + "self": "NOT_ALLOWED" + }, + "key": "okta_email" + }, + { + "enroll": { + "self": "OPTIONAL" + }, + "key": "okta_verify" + }, + { + "enroll": { + "self": "REQUIRED" + }, + "key": "okta_password" + } + ], + "type": "AUTHENTICATORS" + }, + "status": "ACTIVE", + "system": true, + "type": "MFA_ENROLL" + } + }, + "mfa-enroll-policy-with-grace-period-response": { + "summary": "MFA_ENROLL with grace period", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/lifecycle/deactivate" + }, + "mappings": { + "hints": { + "allow": [ + "GET", + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/mappings" + }, + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "settings": { + "authenticators": [ + { + "enroll": { + "self": "NOT_ALLOWED" + }, + "key": "okta_email" + }, + { + "enroll": { + "self": "OPTIONAL" + }, + "key": "okta_verify" + }, + { + "enroll": { + "self": "REQUIRED" + }, + "key": "okta_password" + }, + { + "enroll": { + "gracePeriod": { + "expiry": "2025-01-01T18:30:45.000Z", + "type": "BY_DATE_TIME" + }, + "self": "REQUIRED" + }, + "key": "phone_number" + }, + { + "enroll": { + "gracePeriod": { + "skipCount": 3, + "type": "BY_SKIP_COUNT" + }, + "self": "OPTIONAL" + }, + "key": "google_otp" + } + ], + "type": "AUTHENTICATORS" + }, + "status": "ACTIVE", + "system": true, + "type": "MFA_ENROLL" + } + }, + "newAPIServiceIntegrationInstanceSecretResponse": { + "summary": "New secret response example", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate" + } + }, + "client_secret": "DRUFXGF9XbLnS9k-Sla3x3POBiIxDreBCdZuFs5B", + "created": "2023-04-06T21:32:33.000Z", + "id": "ocs2f50kZB0cITmYU0g4", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "secret_hash": "FpCwXwSjTRQNtEI11I00-g", + "status": "ACTIVE" + } + }, + "oAuth2ClientSecretResponse": { + "summary": "Client secret response example", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate" + } + }, + "client_secret": "DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B", + "created": "2023-04-06T21:32:33.000Z", + "id": "ocs2f50kZB0cITmYU0g4", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "secret_hash": "FpCwXwSjTRQNtEI11I00-g", + "status": "ACTIVE" + } + }, + "oAuthClientJsonActiveEncryptionKey": { + "summary": "JSON active encryption key example", + "value": { + "created": "2023-04-06T21:32:33.000Z", + "e": "AQAB", + "id": "pks2f50kZB0cITmYU0g4", + "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", + "status": "ACTIVE", + "use": "enc" + } + }, + "oAuthClientJsonActiveEncryptionKeyRequest": { + "summary": "Add an active JSON encryption key request example", + "value": { + "e": "AQAB", + "id": "pks2f50kZB0cITmYU0g4", + "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", + "status": "ACTIVE", + "use": "enc" + } + }, + "oAuthClientJsonInactiveEncryptionKey": { + "summary": "JSON inactive encryption key example", + "value": { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/jwks/pks2f50kZB0cITmYU0g4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/jwks/pks2f50kZB0cITmYU0g4" + } + }, + "created": "2023-04-06T21:32:33.000Z", + "e": "AQAB", + "id": "pks2f50kZB0cITmYU0g4", + "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", + "status": "INACTIVE", + "use": "enc" + } + }, + "oAuthClientJsonInactiveEncryptionKeyRequest": { + "summary": "Add an inactive JSON encryption key request example", + "value": { + "e": "AQAB", + "id": "pks2f50kZB0cITmYU0g4", + "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", + "status": "INACTIVE", + "use": "enc" + } + }, + "oAuthClientJsonWebKey": { + "summary": "JSON Web Key example", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/jwks/pks2f50kZB0cITmYU0g4/lifecycle/deactivate" + } + }, + "alg": "RS256", + "created": "2023-04-06T21:32:33.000Z", + "e": "AQAB", + "id": "pks2f50kZB0cITmYU0g4", + "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", + "status": "ACTIVE", + "use": "sig" + } + }, + "oAuthClientJsonWebKeyListResponse": { + "summary": "JSON Web Key list response example", + "value": { + "jwks": { + "keys": [ + { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/jwks/pks2f4zrZbs8nUa7p0g4" + } + }, + "alg": "RS256", + "created": "2023-02-21T20:08:24.000Z", + "e": "AQAB", + "id": "pks2f4zrZbs8nUa7p0g4", + "kid": "DRUFXGF9XbLnS9k-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "lastUpdated": "2023-02-21T20:08:24.000Z", + "n": "AJncrKuine49_CEVR4GPn.....zOrouIUCSMlRL0HU=", + "status": "INACTIVE", + "use": "sig" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/jwks/pks2f50kZB0cITmYU0g4/lifecycle/deactivate" + } + }, + "alg": "RS256", + "created": "2023-04-06T21:32:33.000Z", + "e": "AQAB", + "id": "pks2f50kZB0cITmYU0g4", + "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", + "status": "ACTIVE", + "use": "sig" + } + ] + } + } + }, + "oAuthClientJsonWebKeyRequest": { + "summary": "JSON Web Key request example", + "value": { + "alg": "RS256", + "e": "AQAB", + "id": "pks2f50kZB0cITmYU0g4", + "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", + "kty": "RSA", + "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", + "status": "ACTIVE", + "use": "sig" + } + }, + "oAuthClientSecretListResponse": { + "summary": "Secrets list response example", + "value": [ + { + "_links": { + "activate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4/lifecycle/activate" + }, + "delete": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f4zrZbs8nUa7p0g4" + } + }, + "client_secret": "DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B", + "created": "2023-02-21T20:08:24.000Z", + "id": "ocs2f4zrZbs8nUa7p0g4", + "lastUpdated": "2023-02-21T20:08:24.000Z", + "secret_hash": "yk4SVx4sUWVJVbHt6M-UPA", + "status": "INACTIVE" + }, + { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/0oa1nkheCuDn82XVI0g4/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate" + } + }, + "client_secret": "HAGDTYU9XbLnS......3xasFDDwecdZuFs5B", + "created": "2023-04-06T21:32:33.000Z", + "id": "ocs2f50kZB0cITmYU0g4", + "lastUpdated": "2023-04-06T21:32:33.000Z", + "secret_hash": "0WOOvBSzV9clc4Nr7Rbaug", + "status": "ACTIVE" + } + ] + }, + "oamp-id-proofing-policy-rule": { + "summary": "Okta account management policy with ID proofing enabled", + "value": { + "actions": { + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "id": "entity_id", + "type": "ID_PROOFING" + } + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "Account management policy rule", + "priority": 1, + "status": "ACTIVE" + } + }, + "oamp-id-proofing-policy-rule-response": { + "summary": "Okta account management policy - account management policy rule with ID proofing enabled", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "id": "entity_id", + "type": "ID_PROOFING" + } + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "Account management policy rule", + "priority": 1, + "status": "ACTIVE" + } + }, + "okta-verify-release-policy-rule-response": { + "summary": "Okta Verify release control policy - allow Okta Verify version updates", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul2z0rRCIFOxp5HF0g4" + } + }, + "actions": { + "updateControls": { + "actions": [ + { + "action": "OKTA_VERIFY_UPDATE", + "value": "ALLOW" + } + ] + } + }, + "conditions": null, + "created": "2025-11-24T21:13:15.000Z", + "id": "rul2z0rRCIFOxp5HF0g4", + "lastUpdated": "2025-11-24T21:13:15.000Z", + "name": "Okta Verify Update Rule", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "CLIENT_UPDATE" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "orgCommunicationOptInResponse": { + "summary": "Opt in to communication emails", + "value": { + "_links": { + "optOut": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaCommunication/optOut" + } + }, + "optOutEmailUsers": false + } + }, + "orgCommunicationOptOutResponse": { + "summary": "Opt out of communication emails", + "value": { + "_links": { + "optIn": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaCommunication/optIn" + } + }, + "optOutEmailUsers": true + } + }, + "orgContactTypeResponse": { + "summary": "Org contact types", + "value": [ + { + "_links": { + "billing": { + "href": "https://{yourOktaDomain}/api/v1/org/contacts/billing" + } + }, + "contactType": "BILLING" + }, + { + "_links": { + "technical": { + "href": "https://{yourOktaDomain}/api/v1/org/contacts/technical" + } + }, + "contactType": "TECHNICAL" + } + ] + }, + "orgContactUserResponse": { + "summary": "Contact user", + "value": { + "_links": { + "user": { + "href": "https://{yourOktaDomain}/api/v1/users/00ux3u0ujW1r5AfZC1d7" + } + }, + "userId": "00ux3u0ujW1r5AfZC1d7" + } + }, + "orgHideFooterPrefResponse": { + "summary": "Hide footer response", + "value": { + "_links": { + "showEndUserFooter": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/preferences/showEndUserFooter" + } + }, + "showEndUserFooter": false + } + }, + "orgShowFooterPrefResponse": { + "summary": "Show footer response", + "value": { + "_links": { + "hideEndUserFooter": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/preferences/hideEndUserFooter" + } + }, + "showEndUserFooter": true + } + }, + "orgSupportSettingsWithCaseNumberResponse": { + "summary": "Org support settings with impersonation grant for cases", + "value": { + "_links": { + "case": { + "hints": { + "allow": [ + "PATCH" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaSupport/case/{caseNumber}" + }, + "cases": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaSupport/cases" + } + }, + "caseNumber": "20000144", + "expiration": "2024-01-24T11:13:14.000Z", + "support": "ENABLED" + } + }, + "password-policy-response": { + "summary": "PASSWORD", + "value": { + "_links": { + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "authProvider": { + "provider": "provider" + }, + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "settings": { + "delegation": { + "options": { + "skipUnlock": false + } + }, + "password": { + "age": { + "expireWarnDays": 0, + "historyCount": 4, + "maxAgeDays": 0, + "minAgeMinutes": 0 + }, + "complexity": { + "dictionary": { + "common": { + "exclude": false + } + }, + "excludeAttributes": [], + "excludeUsername": true, + "minLength": 8, + "minLowerCase": 1, + "minNumber": null, + "minSymbol": 0, + "minUpperCase": 1 + }, + "lockout": { + "autoUnlockMinutes": 0, + "maxAttempts": 0, + "showLockoutFailures": false, + "userLockoutNotificationChannels": [] + } + }, + "recovery": { + "factors": { + "okta_call": { + "status": "INACTIVE" + }, + "okta_email": { + "properties": { + "recoveryToken": { + "tokenLifetimeMinutes": 10080 + } + }, + "status": "ACTIVE" + }, + "okta_sms": { + "status": "INACTIVE" + }, + "recovery_question": { + "properties": { + "complexity": { + "complexity": 4 + } + }, + "status": "ACTIVE" + } + } + } + }, + "status": "ACTIVE", + "system": true, + "type": "PASSWORD" + } + }, + "password-policy-with-breached-protection-response": { + "summary": "PASSWORD with breached protection", + "value": { + "_links": { + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": { + "authProvider": { + "provider": "provider" + }, + "people": { + "groups": { + "include": [ + "groupId" + ] + } + } + }, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "settings": { + "delegation": { + "options": { + "skipUnlock": false + } + }, + "password": { + "age": { + "expireWarnDays": 0, + "historyCount": 4, + "maxAgeDays": 0, + "minAgeMinutes": 0 + }, + "breachedProtection": { + "deletegatedWorkflowId": "workflowId", + "expireAfterDays": 1, + "logoutEnabled": true + }, + "complexity": { + "dictionary": { + "common": { + "exclude": false + } + }, + "excludeAttributes": [], + "excludeUsername": true, + "minLength": 8, + "minLowerCase": 1, + "minNumber": null, + "minSymbol": 0, + "minUpperCase": 1 + }, + "lockout": { + "autoUnlockMinutes": 0, + "maxAttempts": 0, + "showLockoutFailures": false, + "userLockoutNotificationChannels": [] + } + }, + "recovery": { + "factors": { + "okta_call": { + "status": "INACTIVE" + }, + "okta_email": { + "properties": { + "recoveryToken": { + "tokenLifetimeMinutes": 10080 + } + }, + "status": "ACTIVE" + }, + "okta_sms": { + "status": "INACTIVE" + }, + "recovery_question": { + "properties": { + "complexity": { + "complexity": 4 + } + }, + "status": "ACTIVE" + } + } + } + }, + "status": "ACTIVE", + "system": true, + "type": "PASSWORD" + } + }, + "policy-mapping-list-response": { + "summary": "List all mappings for a policy", + "value": [ + { + "_links": { + "application": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}" + }, + "policy": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/mappings/{mappingId}" + } + }, + "id": "policyId" + } + ] + }, + "policy-mapping-response": { + "summary": "Policy mapping for a policy", + "value": { + "_links": { + "application": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/apps/{appId}" + }, + "policy": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/mappings/{mappingId}" + } + }, + "id": "policyId" + } + }, + "post-auth-session-rule-example": { + "summary": "Session Violation Enforcement Rule", + "value": { + "actions": { + "postAuthSession": { + "failureActions": [ + { + "action": "TERMINATE_SESSION" + } + ] + } + }, + "description": "Defines the enforcement actions taken after a session violation is detected. In this example, the session is terminated if the policy re-evaluation fails.", + "name": "Terminate Session on Risk", + "status": "ACTIVE", + "type": "POST_AUTH_SESSION" + } + }, + "post-auth-session-rule-response": { + "summary": "Session violation enforcement policy - terminate session on violation", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/pol123uvw/rules/rul0bxv29jpuRnMDD4g9" + } + }, + "actions": { + "postAuthSession": { + "failureActions": [ + { + "action": "TERMINATE_SESSION" + } + ] + } + }, + "created": "2023-10-15T08:00:00.000Z", + "description": "Defines the enforcement actions taken after a session violation is detected. In this example, the session is terminated if the policy re-evaluation fails.", + "id": "rul0bxv29jpuRnMDD4g9", + "lastUpdated": "2023-10-15T08:00:00.000Z", + "name": "Terminate Session on Risk", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "POST_AUTH_SESSION" + } + }, + "postAPIServiceIntegrationRequest": { + "summary": "POST request example", + "value": { + "grantedScopes": [ + "okta.logs.read", + "okta.groups.read", + "okta.users.read" + ], + "type": "my_app_cie" + } + }, + "postAPIServiceIntegrationResponse": { + "summary": "Post response example", + "value": { + "_links": { + "client": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oa72lrepvp4WqEET1d9" + }, + "logo": { + "href": "https://{logoDomain}/{logoPath}/my_app_cie_small_logo", + "name": "small" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa72lrepvp4WqEET1d9" + } + }, + "clientSecret": "CkF69kXtag0q0P4pXU8OnP5IAzgGlwx6eqGy7Fmg", + "configGuideUrl": "https://{docDomain}/my-app-cie/configuration-guide", + "createdAt": "2023-02-21T20:08:24.000Z", + "createdBy": "00uu3u0ujW1P6AfZC2d5", + "grantedScopes": [ + "okta.logs.read", + "okta.groups.read", + "okta.users.read" + ], + "id": "0oa72lrepvp4WqEET1d9", + "name": "My App Cloud Identity Engine", + "type": "my_app_cie" + } + }, + "postAPIServiceWithPropertiesIntegrationRequest": { + "summary": "POST request example with app properties", + "value": { + "grantedScopes": [ + "okta.logs.read", + "okta.groups.read", + "okta.users.read" + ], + "properties": { + "baseUrl": "https://example.com", + "orgId": "42" + }, + "type": "my_app_cie" + }, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "postAPIServiceWithPropertiesIntegrationResponse": { + "summary": "Post response example with app properties", + "value": { + "_links": { + "client": { + "hints": { + "allow": [ + "GET" + ] + }, + "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oa72lrepvp4WqEET1d9" + }, + "logo": { + "href": "https://{logoDomain}/{logoPath}/my_app_cie_small_logo", + "name": "small" + }, + "self": { + "hints": { + "allow": [ + "GET", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/integrations/api/v1/api-services/0oa72lrepvp4WqEET1d9" + } + }, + "clientSecret": "CkF69kXtag0q0P4pXU8OnP5IAzgGlwx6eqGy7Fmg", + "configGuideUrl": "https://{docDomain}/my-app-cie/configuration-guide", + "createdAt": "2023-02-21T20:08:24.000Z", + "createdBy": "00uu3u0ujW1P6AfZC2d5", + "grantedScopes": [ + "okta.logs.read", + "okta.groups.read", + "okta.users.read" + ], + "id": "0oa72lrepvp4WqEET1d9", + "name": "My App Cloud Identity Engine", + "properties": { + "baseUrl": "https://example.com", + "orgId": "42" + }, + "type": "my_app_cie" + }, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "profile-enrollment-policy-response": { + "summary": "PROFILE_ENROLLMENT", + "value": { + "_links": { + "rules": { + "hints": { + "allow": [ + "POST", + "GET" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}" + } + }, + "conditions": null, + "created": "createdDate", + "description": "Policy description", + "id": "policyId", + "lastUpdated": "lastUpdated", + "name": "Policy name", + "priority": 1, + "status": "ACTIVE", + "system": true, + "type": "PROFILE_ENROLLMENT" + } + }, + "radius-rule": { + "summary": "Global session policy - Challenge VPN users with Radius", + "value": { + "actions": { + "signon": { + "access": "ALLOW", + "factorPromptMode": "ALWAYS", + "primaryFactor": "PASSWORD_IDP_ANY_FACTOR", + "rememberDeviceByDefault": false, + "requireFactor": true, + "session": { + "maxSessionIdleMinutes": 720, + "maxSessionLifetimeMinutes": 0, + "usePersistentCookie": false + } + } + }, + "conditions": { + "authContext": { + "authType": "RADIUS" + }, + "identityProvider": { + "provider": "ANY" + }, + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + }, + "risk": { + "behaviors": [] + }, + "riskScore": { + "level": "ANY" + } + }, + "name": "Challenge VPN users", + "status": "ACTIVE", + "type": "SIGN_ON" + } + }, + "radius-rule-response": { + "summary": "Global session policy - Challenge VPN users with Radius", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "signon": { + "access": "ALLOW", + "factorPromptMode": "ALWAYS", + "rememberDeviceByDefault": false, + "requireFactor": true, + "session": { + "maxSessionIdleMinutes": 720, + "maxSessionLifetimeMinutes": 0, + "usePersistentCookie": false + } + } + }, + "conditions": { + "authContext": { + "authType": "RADIUS" + }, + "network": { + "connection": "ANYWHERE" + } + }, + "created": "2024-04-25T17:35:02.000Z", + "id": "rule8jjozjGMGbHyC1d6", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Challenge VPN users", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "SIGN_ON" + } + }, + "replace-user-request": { + "value": { + "credentials": { + "password": { + "value": "tlpWENT2m" + }, + "provider": { + "name": "OKTA", + "type": "OKTA" + }, + "recovery_question": { + "answer": "Annie Oakley", + "question": "Who's a major player in the cowboy scene?" + } + }, + "profile": { + "email": "isaac.brock@example.com", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "555-415-1337" + } + } + }, + "replaceFederatedClaimRequestBody": { + "summary": "Replace federated claim example", + "value": { + "expression": "appuser.entitlements.readOnly", + "name": "readOnly" + } + }, + "replaceFederatedClaimResponse": { + "summary": "An updated federated claim", + "value": { + "created": "2024-12-25T04:00:00.000Z", + "expression": "appuser.entitlements.readOnly", + "id": "ofc893fbjaTxynmo5v93", + "lastUpdated": "2024-12-25T05:00:00.000Z", + "name": "readOnly" + } + }, + "session-violation-detection-rule-example": { + "summary": "Session Violation Detection Rule", + "value": { + "actions": { + "sessionViolationDetection": { + "policyEvaluation": { + "enabled": true + } + } + }, + "conditions": { + "riskScore": { + "minRiskLevel": "HIGH" + } + }, + "name": "High Risk Session Detection", + "status": "ACTIVE", + "type": "SESSION_VIOLATION_DETECTION" + } + }, + "session-violation-detection-rule-response": { + "summary": "Session violation detection policy - re-evaluate on High risk", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/pol789abc/rules/rul9awu18iotQlMCC3f8" + } + }, + "actions": { + "sessionViolationDetection": { + "policyEvaluation": { + "enabled": true + } + } + }, + "conditions": { + "riskScore": { + "minRiskLevel": "HIGH" + } + }, + "created": "2023-11-01T10:00:00.000Z", + "id": "rul9awu18iotQlMCC3f8", + "lastUpdated": "2023-11-01T10:00:00.000Z", + "name": "High Risk Session Detection", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "SESSION_VIOLATION_DETECTION" + } + }, + "settingsResponseBaseEx": { + "value": { + "emOptInStatus": "DISABLED", + "implicitAssignment": false, + "manualProvisioning": false, + "notes": { + "admin": null, + "enduser": null + }, + "notifications": { + "vpn": { + "helpUrl": null, + "message": null, + "network": { + "connection": "DISABLED" + } + } + } + } + }, + "sign-on-policy-rule": { + "summary": "Global session policy - rule with factor mode always", + "value": { + "actions": { + "signon": { + "access": "ALLOW", + "factorLifetime": 15, + "factorPromptMode": "ALWAYS", + "primaryFactor": "PASSWORD_IDP_ANY_FACTOR", + "requireFactor": false, + "session": { + "maxSessionIdleMinutes": 720, + "maxSessionLifetimeMinutes": 0, + "usePersistentCookie": false + } + } + }, + "conditions": { + "authContext": { + "authType": "ANY" + }, + "identityProvider": { + "provider": "ANY" + }, + "network": { + "connection": "ANYWHERE" + }, + "riskScore": { + "level": "ANY" + } + }, + "name": "Test Sign On", + "type": "SIGN_ON" + } + }, + "sign-on-policy-rule-response": { + "summary": "Global session policy - rule with factor mode always", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "signon": { + "access": "ALLOW", + "factorLifetime": 15, + "factorPromptMode": "ALWAYS", + "primaryFactor": "PASSWORD_IDP_ANY_FACTOR", + "requireFactor": false, + "session": { + "maxSessionIdleMinutes": 720, + "maxSessionLifetimeMinutes": 0, + "usePersistentCookie": false + } + } + }, + "conditions": { + "authContext": { + "authType": "ANY" + }, + "identityProvider": { + "provider": "ANY" + }, + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + }, + "riskScore": { + "level": "ANY" + } + }, + "created": "2024-04-25T17:35:02.000Z", + "id": "0prh1sd28q5sXGW08697", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Test Sign On", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "SIGN_ON" + } + }, + "skip-factor-challenge-on-prem-rule": { + "summary": "Global session policy - Skip factor challenge for on-prem sign-in use", + "value": { + "actions": { + "signon": { + "access": "ALLOW", + "rememberDeviceByDefault": false, + "requireFactor": false, + "session": { + "maxSessionIdleMinutes": 720, + "maxSessionLifetimeMinutes": 0, + "usePersistentCookie": false + } + } + }, + "conditions": { + "authContext": { + "authType": "ANY" + }, + "network": { + "connection": "ZONE", + "include": [ + "00u7yq5goxNFTiMjW1d7" + ] + } + }, + "name": "Skip Factor Challenge when On-Prem", + "status": "ACTIVE", + "type": "SIGN_ON" + } + }, + "skip-factor-challenge-on-prem-rule-response": { + "summary": "Global session policy - Skip factor challenge for on-prem sign-in use", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "signon": { + "access": "ALLOW", + "primaryFactor": "PASSWORD_IDP_ANY_FACTOR", + "rememberDeviceByDefault": false, + "requireFactor": false, + "session": { + "maxSessionIdleMinutes": 720, + "maxSessionLifetimeMinutes": 0, + "usePersistentCookie": false + } + } + }, + "conditions": { + "authContext": { + "authType": "ANY" + }, + "identityProvider": { + "provider": "ANY" + }, + "network": { + "connection": "ZONE", + "include": [ + "00u7yq5goxNFTiMjW1d7" + ] + }, + "people": { + "users": { + "exclude": [] + } + }, + "risk": { + "behaviors": [] + }, + "riskScore": { + "level": "ANY" + } + }, + "created": "2024-04-25T17:35:02.000Z", + "id": "rule8jjozjGMGbHyC1d6", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Skip Factor Challenge when On-Prem", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "SIGN_ON" + } + }, + "sspr-enabled-OAMP": { + "summary": "Password policy - Self-service password change, reset, or unlock requirements defined by Okta account management policy", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "accessControl": "AUTH_POLICY", + "primary": { + "methods": [ + "sms", + "email" + ] + }, + "stepUp": { + "required": false + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-OAMP-response": { + "summary": "Password policy - Self-service password change, reset, or unlock requirements defined by Okta account management policy", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "accessControl": "AUTH_POLICY", + "primary": { + "methods": [ + "sms", + "email" + ] + }, + "stepUp": { + "required": false + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-OAMP-update": { + "summary": "Password policy - Self-service password change, reset, or unlock requirements defined by Okta account management policy", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "accessControl": "AUTH_POLICY", + "primary": { + "methods": [ + "sms", + "email" + ] + }, + "stepUp": { + "required": false + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-no-step-up": { + "summary": "Password policy - Self-service password change, reset, or unlock with no step up", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "sms", + "email" + ] + }, + "stepUp": { + "required": false + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-no-step-up-response": { + "summary": "Password policy - Self-service password change, reset, or unlock with no step up", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "sms", + "email" + ] + }, + "stepUp": { + "required": false + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-no-step-up-update": { + "summary": "Password policy - Self-service password change, reset, or unlock with no step up", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "sms", + "email" + ] + }, + "stepUp": { + "required": false + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-sq-step-up": { + "summary": "Password policy - Self-service password change, reset, or unlock with security question as step up", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "push", + "sms" + ] + }, + "stepUp": { + "methods": [ + "security_question" + ], + "required": true + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-sq-step-up-response": { + "summary": "Password policy - Self-service password change, reset, or unlock with security question as step up", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "push", + "sms" + ] + }, + "stepUp": { + "methods": [ + "security_question" + ], + "required": true + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-sq-step-up-update": { + "summary": "Password policy - Self-service password change, reset, or unlock with security question as step up", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "push", + "sms" + ] + }, + "stepUp": { + "methods": [ + "security_question" + ], + "required": true + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-sso-step-up": { + "summary": "Password policy - Self-service password change, reset, or unlock with any SSO authenticator as step up", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "push", + "sms" + ] + }, + "stepUp": { + "required": true + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-sso-step-up-response": { + "summary": "Password policy - SSPR with any SSO authenticator as step up", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "push", + "sms" + ] + }, + "stepUp": { + "required": true + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-sso-step-up-update": { + "summary": "Password policy - Self-service password change, reset, or unlock with any SSO authenticator as step up", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "push", + "sms" + ] + }, + "stepUp": { + "required": true + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-sso-step-up-with-constraints": { + "summary": "Password policy - Enable self-service password change, reset, or unlock with OTP enabled and Google Authenticator constraint", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methodConstraints": [ + { + "allowedAuthenticators": [ + { + "key": "google_otp" + } + ], + "method": "otp" + } + ], + "methods": [ + "push", + "sms", + "otp" + ] + }, + "stepUp": { + "required": true + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-sso-step-up-with-constraints-response": { + "summary": "Password policy - Enable self-service password change, reset, or unlock with OTP enabled and Google Authenticator constraint", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methodConstraints": [ + { + "allowedAuthenticators": [ + { + "key": "google_otp" + } + ], + "method": "otp" + } + ], + "methods": [ + "push", + "sms", + "otp" + ] + }, + "stepUp": { + "required": true + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-enabled-sso-step-up-with-constraints-update": { + "summary": "Password policy - Enable self-service password change, reset, or unlock with OTP enabled and Google Authenticator constraint", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methodConstraints": [ + { + "allowedAuthenticators": [ + { + "key": "google_otp" + } + ], + "method": "otp" + } + ], + "methods": [ + "push", + "sms", + "otp" + ] + }, + "stepUp": { + "required": true + } + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + } + }, + "sspr-recovery-email-without-enrollment": { + "summary": "Password policy - Self-service password change, reset, or unlock allow recovery email without email enrollment", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "sms", + "email" + ] + }, + "stepUp": { + "required": false + } + }, + "settings": { + "allowRecoveryEmailWithoutEnrollment": true + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "sspr-recovery-email-without-enrollment-response": { + "summary": "Password policy - Self-service password change, reset, or unlock with recovery email without email enrollment requirement", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "sms", + "email" + ] + }, + "stepUp": { + "required": false + } + }, + "settings": { + "allowRecoveryEmailWithoutEnrollment": true + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "sspr-recovery-email-without-enrollment-update": { + "summary": "Password policy - Self-service password change, reset, or unlock allow recovery email without email enrollment", + "value": { + "actions": { + "passwordChange": { + "access": "ALLOW" + }, + "selfServicePasswordReset": { + "access": "ALLOW", + "requirement": { + "primary": { + "methods": [ + "sms", + "email" + ] + }, + "stepUp": { + "required": false + } + }, + "settings": { + "allowRecoveryEmailWithoutEnrollment": true + } + }, + "selfServiceUnlock": { + "access": "ALLOW" + } + }, + "conditions": { + "network": { + "connection": "ANYWHERE" + }, + "people": { + "users": { + "exclude": [] + } + } + }, + "id": "ruleId", + "name": "SSPR Rule", + "priority": 1, + "status": "ACTIVE", + "system": false, + "type": "PASSWORD" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "streamConfigurationExample": { + "summary": "SSF stream configuration example", + "value": { + "aud": "https://example.com", + "delivery": { + "endpoint_url": "https://example.com", + "method": "urn:ietf:rfc:8935" + }, + "events_delivered": [ + "https://schemas.openid.net/secevent/caep/event-type/session-revoked", + "https://schemas.openid.net/secevent/caep/event-type/credential-change" + ], + "events_requested": [ + "https://schemas.openid.net/secevent/caep/event-type/session-revoked", + "https://schemas.openid.net/secevent/caep/event-type/credential-change" + ], + "events_supported": [ + "https://schemas.openid.net/secevent/caep/event-type/session-revoked", + "https://schemas.openid.net/secevent/caep/event-type/credential-change" + ], + "format": "iss_sub", + "iss": "https://{yourOktaDomain}", + "min_verification_interval": 0, + "stream_id": "esc1k235GIIztAuGK0g5" + } + }, + "streamStatusDisabledExample": { + "summary": "SSF stream disabled status example", + "value": { + "status": "disabled", + "stream_id": "esc1k235GIIztAuGK0g5" + } + }, + "streamStatusEnabledExample": { + "summary": "SSF stream enabled status example", + "value": { + "status": "enabled", + "stream_id": "esc1k235GIIztAuGK0g5" + } + }, + "twofa-enabled-disallow-password-allow-phishing": { + "summary": "App sign-in policy - 2FA with granular authentication", + "value": { + "actions": { + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "constraints": { + "knowledge": { + "excludedAuthenticationMethods": { + "key": "okta_password" + } + }, + "possession": { + "deviceBound": "REQUIRED", + "phishingREsistant": "REQUIRED" + } + }, + "factorMode": "2FA", + "reauthenticateIn": "PT0S", + "type": "ASSURANCE" + } + } + }, + "name": "Passwordless 2FA", + "type": "ACCESS_POLICY" + } + }, + "twofa-enabled-disallow-password-allow-phishing-response": { + "summary": "App sign-in policy - 2FA with granular authentication", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul7yut96gmsOzKAA1d6" + } + }, + "actions": { + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "constraints": { + "knowledge": { + "excludedAuthenticationMethods": { + "key": "okta_password" + }, + "required": false + }, + "possession": { + "deviceBound": "REQUIRED", + "phishingREsistant": "REQUIRED", + "required": true + } + }, + "factorMode": "2FA", + "reauthenticateIn": "PT0S", + "type": "ASSURANCE" + } + } + }, + "conditions": null, + "created": "2023-05-01T21:13:15.000Z", + "id": "rul7yut96gmsOzKAA1d6", + "lastUpdated": "2023-05-01T21:13:15.000Z", + "name": "Passwordless 2FA", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "ACCESS_POLICY" + } + }, + "twofa-enabled-post-auth-kmsi-disabled": { + "summary": "App sign-in policy - 2FA with granular authentication with Keep Me Signed In (KMSI) disabled", + "value": { + "actions": { + "appSignOn": { + "access": "ALLOW", + "keepMeSignedIn": { + "postAuth": "NOT_ALLOWED" + }, + "verificationMethod": { + "constraints": { + "knowledge": { + "excludedAuthenticationMethods": { + "key": "okta_password" + } + } + }, + "factorMode": "2FA", + "reauthenticateIn": "PT2H", + "type": "ASSURANCE" + } + } + }, + "name": "2FA with Post Auth KMSI prompt disabled", + "type": "ACCESS_POLICY" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "twofa-enabled-post-auth-kmsi-disabled-response": { + "summary": "App sign-in policy - 2FA with granular authentication with Keep Me Signed In (KMSI) disabled", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul7yut96gmsOzKAA1d6" + } + }, + "actions": { + "appSignOn": { + "access": "ALLOW", + "keepMeSignedIn": { + "postAuth": "NOT_ALLOWED" + }, + "verificationMethod": { + "constraints": { + "knowledge": { + "excludedAuthenticationMethods": { + "key": "okta_password" + }, + "required": true + } + }, + "factorMode": "2FA", + "reauthenticateIn": "PT0S", + "type": "ASSURANCE" + } + } + }, + "conditions": null, + "created": "2023-05-01T21:13:15.000Z", + "id": "rul7yut96gmsOzKAA1d6", + "lastUpdated": "2023-05-01T21:13:15.000Z", + "name": "2FA with Post Auth KMSI prompt disabled", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "ACCESS_POLICY" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "twofa-enabled-post-auth-kmsi-enabled": { + "summary": "App sign-in policy - 2FA with granular authentication with Keep Me Signed In (KMSI) enabled", + "value": { + "actions": { + "appSignOn": { + "access": "ALLOW", + "keepMeSignedIn": { + "postAuth": "ALLOWED", + "postAuthPromptFrequency": "P30D" + }, + "verificationMethod": { + "constraints": { + "knowledge": { + "excludedAuthenticationMethods": { + "key": "okta_password" + } + } + }, + "factorMode": "2FA", + "reauthenticateIn": "PT2H", + "type": "ASSURANCE" + } + } + }, + "name": "2FA with Post Auth KMSI prompt enabled" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "twofa-enabled-post-auth-kmsi-enabled-response": { + "summary": "App sign-in policy - 2FA with granular authentication with Keep Me Signed In (KMSI) enabled", + "value": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "POST" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul7yut96gmsOzKAA1d6" + } + }, + "actions": { + "appSignOn": { + "access": "ALLOW", + "keepMeSignedIn": { + "postAuth": "ALLOWED", + "postAuthPromptFrequency": "PT720H" + }, + "verificationMethod": { + "constraints": { + "knowledge": { + "excludedAuthenticationMethods": { + "key": "okta_password" + }, + "required": true + } + }, + "factorMode": "2FA", + "reauthenticateIn": "PT0S", + "type": "ASSURANCE" + } + } + }, + "conditions": null, + "created": "2023-05-01T21:13:15.000Z", + "id": "rul7yut96gmsOzKAA1d6", + "lastUpdated": "2023-05-01T21:13:15.000Z", + "name": "2FA with Post Auth KMSI prompt enabled", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "ACCESS_POLICY" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "update-auth-policy-rule-condition": { + "summary": "App sign-in policy - rule with conditions", + "value": { + "conditions": { + "elCondition": { + "condition": "security.risk.level == 'HIGH'" + }, + "network": { + "connection": "ZONE", + "exclude": [ + "nzo9o4rctwQCJNE6y1d7" + ] + }, + "people": { + "groups": { + "exclude": [ + "00g8vta8qzkxPEfKC1d7" + ], + "include": [] + }, + "users": { + "exclude": [ + "00u7yq5goxNFTiMjW1d7" + ], + "include": [] + } + }, + "platform": { + "include": [ + { + "os": { + "type": "IOS" + }, + "type": "MOBILE" + }, + { + "os": { + "type": "ANDROID" + }, + "type": "MOBILE" + }, + { + "os": { + "type": "MACOS" + }, + "type": "DESKTOP" + } + ] + }, + "riskScore": { + "level": "ANY" + }, + "userType": { + "exclude": [ + "otyezu4m0xN6w5JEa1d7" + ], + "include": [] + } + }, + "description": "Updated policy rule", + "name": "Rule with conditions - exclude a group", + "type": "ACCESS_POLICY" + } + }, + "update-auth-policy-rule-condition-response": { + "summary": "App sign-in policy - rule with conditions", + "value": { + "actions": { + "_links": { + "deactivate": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul7yut96gmsOzKAA1d6" + }, + "self": { + "hints": { + "allow": [ + "GET", + "PUT", + "DELETE" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul7yut96gmsOzKAA1d6" + } + }, + "appSignOn": { + "access": "ALLOW", + "verificationMethod": { + "constraints": { + "knowledge": { + "reauthenticateIn": "PT2H", + "required": true, + "types": [ + "password" + ] + } + }, + "factorMode": "2FA", + "reauthenticateIn": "PT2H", + "type": "ASSURANCE" + } + }, + "type": "ACCESS_POLICY" + }, + "conditions": { + "elCondition": { + "condition": "security.risk.level == 'HIGH'" + }, + "network": { + "connection": "ZONE", + "exclude": [ + "nzo9o4rctwQCJNE6y1d7" + ] + }, + "people": { + "groups": { + "exclude": [ + "00u7yq5goxNFTiMjW1d7" + ] + }, + "users": { + "exclude": [] + } + }, + "platform": { + "exclude": [], + "include": [ + { + "os": { + "type": "IOS" + }, + "type": "MOBILE" + }, + { + "os": { + "type": "ANDROID" + }, + "type": "MOBILE" + }, + { + "os": { + "type": "MACOS" + }, + "type": "DESKTOP" + } + ] + }, + "riskScore": { + "level": "ANY" + }, + "userType": { + "exclude": [ + "otyezu4m0xN6w5JEa1d7" + ], + "include": [] + } + }, + "created": "2024-04-25T17:35:02.000Z", + "id": "rulezuo73ySrHndLb1d7", + "lastUpdated": "2024-04-25T17:35:02.000Z", + "name": "Rule with conditions - exclude a group", + "priority": 0, + "status": "ACTIVE", + "system": false + } + }, + "update-device-signal-collection-rule": { + "summary": "Device signal collection policy - disallow Okta Verify from identifying users", + "value": { + "actions": { + "deviceSignalCollection": { + "deviceContextProviders": [ + { + "key": "OKTA_VERIFY", + "userIdentification": "IGNORE" + }, + { + "id": "0oa159mE9aOSpCwmr0g4", + "key": "DEVICE_POSTURE_IDP" + } + ] + } + }, + "name": "Device signal collection rule", + "type": "DEVICE_SIGNAL_COLLECTION" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "update-device-signal-collection-rule-response": { + "summary": "Device signal collection policy - collect context for Okta Verify devices", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul7yut96gmsOzKAA1d6" + } + }, + "actions": { + "deviceSignalCollection": { + "deviceContextProviders": [ + { + "key": "OKTA_VERIFY", + "userIdentification": "IGNORE" + }, + { + "id": "0oa159mE9aOSpCwmr0g4", + "key": "DEVICE_POSTURE_IDP" + } + ] + } + }, + "conditions": null, + "created": "2023-05-01T21:13:15.000Z", + "id": "rul7yut96gmsOzKAA1d6", + "lastUpdated": "2023-05-01T21:13:15.000Z", + "name": "Device signal collection rule", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "DEVICE_SIGNAL_COLLECTION" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "update-identifiers-in-user-profile-policy": { + "summary": "User profile policy - Configure multiple identifiers", + "value": { + "actions": { + "profileEnrollment": { + "access": "ALLOW", + "activationRequirements": { + "emailVerification": true + }, + "allowedIdentifiers": [ + "login", + "customAttribute" + ], + "preRegistrationInlineHooks": null, + "profileAttributes": [ + { + "label": "Email", + "name": "email", + "required": true + }, + { + "label": "First name", + "name": "firstName", + "required": true + }, + { + "label": "Last name", + "name": "lastName", + "required": true + } + ], + "progressiveProfilingAction": "DISABLED", + "targetGroupIds": null, + "uiSchemaId": "uisgu3bb4zTbvwD8S1d7", + "unknownUserAction": "DENY" + } + }, + "conditions": "null,", + "id": "rulgu3bb4oWR7qbMi1d7,", + "name": "Test Rule,", + "priority": "99,", + "status": "ACTIVE,", + "system": "true,", + "type": "PROFILE_ENROLLMENT," + } + }, + "update-identifiers-in-user-profile-policy-response": { + "summary": "User profile policy - Configure multiple identifiers", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/{policyId}/rules/{ruleId}" + } + }, + "actions": { + "profileEnrollment": { + "access": "ALLOW", + "activationRequirements": { + "emailVerification": true + }, + "allowedIdentifiers": [ + "login", + "customAttribute" + ], + "preRegistrationInlineHooks": null, + "profileAttributes": [ + { + "label": "Email", + "name": "email", + "required": true + }, + { + "label": "First name", + "name": "firstName", + "required": true + }, + { + "label": "Last name", + "name": "lastName", + "required": true + } + ], + "progressiveProfilingAction": "DISABLED", + "targetGroupIds": null, + "uiSchemaId": "uisgu3bb4zTbvwD8S1d7", + "unknownUserAction": "DENY" + } + }, + "conditions": "null,", + "id": "rulgu3bb4oWR7qbMi1d7,", + "name": "Test Rule,", + "priority": "99,", + "status": "ACTIVE,", + "system": "true,", + "type": "PROFILE_ENROLLMENT," + } + }, + "update-okta-verify-release-policy-rule": { + "summary": "Okta Verify release control policy - disallow Okta Verify version updates", + "value": { + "actions": { + "updateControls": { + "actions": [ + { + "action": "OKTA_VERIFY_UPDATE", + "value": "DENY" + } + ] + } + }, + "name": "Okta Verify Update Rule", + "type": "CLIENT_UPDATE" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "update-okta-verify-release-policy-rule-response": { + "summary": "Okta Verify release control policy - retrieve configured OV release policy", + "value": { + "_links": { + "self": { + "hints": { + "allow": [ + "GET", + "PUT" + ] + }, + "href": "https://{yourOktaDomain}/api/v1/policies/rst7xus97faIAgmti1d7/rules/rul2z0rRCIFOxp5HF0g4" + } + }, + "actions": { + "updateControls": { + "actions": [ + { + "action": "OKTA_VERIFY_UPDATE", + "value": "DENY" + } + ] + } + }, + "conditions": null, + "created": "2025-11-24T21:13:15.000Z", + "id": "rul2z0rRCIFOxp5HF0g4", + "lastUpdated": "2025-11-24T21:13:15.000Z", + "name": "Okta Verify Update Rule", + "priority": 0, + "status": "ACTIVE", + "system": false, + "type": "CLIENT_UPDATE" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "update-user-profile-request": { + "value": { + "profile": { + "email": "isaac.brock@update.example.com", + "firstName": "Isaac", + "mobilePhone": "555-415-1337" + } + } + }, + "update-user-set-password-request": { + "value": { + "credentials": { + "password": { + "value": "uTVM,TPw55" + } + } + } + }, + "update-user-set-recovery-question-and-answer": { + "value": { + "credentials": { + "recovery_question": { + "answer": "forty two", + "question": "How many roads must a man walk down?" + } + } + } + }, + "user-example": { + "summary": "User example", + "value": { + "_links": { + "self": { + "href": "https://{yourOktaDomain}/api/v1/users/00u1f96ECLNVOKVMUSEA" + } + }, + "activated": "2013-06-24T16:39:19.000Z", + "created": "2013-06-24T16:39:18.000Z", + "credentials": { + "password": {}, + "provider": { + "name": "OKTA", + "type": "OKTA" + }, + "recovery_question": { + "question": "What's my childhood elementary school?" + } + }, + "id": "00ub0oNGTSWTBKOLGLNR", + "lastLogin": "2013-06-24T17:39:19.000Z", + "lastUpdated": "2013-07-02T21:36:25.344Z", + "passwordChanged": "2013-07-02T21:36:25.344Z", + "profile": { + "city": "San Francisco", + "costCenter": "10", + "countryCode": "US", + "department": "Engineering", + "displayName": "Isaac Brock", + "division": "R&D", + "email": "isaac.brock@example.com", + "employeeNumber": "187", + "firstName": "Isaac", + "lastName": "Brock", + "login": "isaac.brock@example.com", + "mobilePhone": "+1-555-415-1337", + "nickName": "issac", + "organization": "Okta", + "preferredLanguage": "en-US", + "primaryPhone": "+1-555-514-1337", + "profileUrl": "http://www.example.com/profile", + "secondEmail": "isaac@example.org", + "state": "CA", + "streetAddress": "301 Brannan St.", + "title": "Director", + "userType": "Employee", + "zipCode": "94107" + }, + "status": "ACTIVE", + "statusChanged": "2013-06-24T16:39:19.000Z" + } + }, + "userNameTemplateResponseBaseEx": { + "value": { + "userNameTemplate": { + "template": "${source.email}", + "type": "BUILT_IN" + } + } + }, + "wellKnownSSFMetadataExample": { + "summary": "Well-Known SSF metadata example", + "value": { + "authorization_schemes": [ + { + "spec_urn": "urn:ietf:rfc:6749" + } + ], + "configuration_endpoint": "https://{yourOktaDomain}/api/v1/ssf/stream", + "default_subjects": "ALL", + "delivery_methods_supported": [ + "https://schemas.openid.net/secevent/risc/delivery-method/push", + "urn:ietf:rfc:8935" + ], + "issuer": "https://{yourOktaDomain}", + "jwks_uri": "https://{yourOktaDomain}/oauth2/v1/keys", + "spec_version": "1_0-ID3", + "verification_endpoint": "https://{yourOktaDomain}/api/v1/ssf/stream/verification" + } + } + }, + "parameters": { + "CustomAsPathJsonWebKeyId": { + "description": "Unique `id` of the Custom Authorization Server JSON Web Key", + "example": "apk2f4zrZbs8nUa7p0g4", + "in": "path", + "name": "keyId", + "required": true, + "schema": { + "type": "string" + } + }, + "IntegrationCapabilityStatus": { + "description": "Integration capability status", + "in": "path", + "name": "status", + "required": true, + "schema": { + "enum": [ + "upcoming", + "released", + "deprecated", + "unknown" + ], + "example": "upcoming", + "type": "string" + } + }, + "OktaResponse": { + "description": "Specifies the media type of the resource. Optional `okta-response` value can be included for performance optimization.\n\nComplex DelAuth configurations may degrade performance when fetching specific parts of the response, and passing this parameter can omit these parts, bypassing the bottleneck.\n\nEnum values for `okta-response`:\n * `omitCredentials`: Omits the credentials subobject from the response.\n * `omitCredentialsLinks`: Omits the following HAL links from the response: Update password, Change recovery question, Start forgot password flow, Reset password, Reset factors, Unlock.\n * `omitTransitioningToStatus`: Omits the `transitioningToStatus` field from the response.", + "examples": { + "Omit credentials subobject and credentials links": { + "summary": "Omits the credentials subobject and credentials links from the response. Doesn't apply performance optimization.", + "value": "application/json; okta-response=omitCredentials,omitCredentialsLinks" + }, + "Omit credentials, credentials links, and `transitioningToStatus` field": { + "summary": "Omits the credentials, credentials links, and `transitioningToStatus` field from the response. Applies performance optimization.", + "value": "application/json; okta-response=\"omitCredentials,omitCredentialsLinks, omitTransitioningToStatus\"" + } + }, + "in": "header", + "name": "Content-Type", + "required": false, + "schema": { + "type": "string" + } + }, + "UISchemaId": { + "description": "The unique ID of the UI Schema", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "uis4a7liocgcRgcxZ0g7", + "type": "string" + } + }, + "adAppInstanceId": { + "description": "ID of the AD instance in Okta", + "example": "00a1xucgTZFrziXg10g4", + "in": "path", + "name": "appInstanceId", + "required": true, + "schema": { + "type": "string" + } + }, + "appIdToDelete": { + "description": "App ID of the allowed app instance to delete mapping from the target app.", + "example": "0oa1elyw9EAkUNUrW0g5", + "in": "path", + "name": "allowedAppId", + "required": true, + "schema": { + "type": "string" + } + }, + "appInstanceId": { + "description": "ID of the Active Directory or LDAP app instance in Okta", + "in": "path", + "name": "appInstanceId", + "required": true, + "schema": { + "type": "string" + } + }, + "assignmentId": { + "description": "ID of the realm assignment", + "in": "path", + "name": "assignmentId", + "required": true, + "schema": { + "example": "rul2jy7jLUlnO3ng00g4", + "type": "string" + } + }, + "assignmentType": { + "description": "Specifies the assignment type of the user", + "in": "query", + "name": "assignmentType", + "required": false, + "schema": { + "enum": [ + "USER", + "GROUP" + ], + "example": "GROUP", + "type": "string" + } + }, + "authenticatorEnrollmentId": { + "description": "ID for a WebAuthn preregistration factor in Okta", + "in": "path", + "name": "authenticatorEnrollmentId", + "required": true, + "schema": { + "type": "string" + } + }, + "capabilityType": { + "description": "Capability type", + "in": "path", + "name": "capabilityType", + "required": true, + "schema": { + "$ref": "#/components/schemas/ExpressConfigureCapabilityType", + "example": "SSO" + } + }, + "caseNumber": { + "in": "path", + "name": "caseNumber", + "required": true, + "schema": { + "description": "Okta Support case number", + "example": "00000144", + "type": "string" + } + }, + "claimId": { + "description": "The unique `id` of the federated claim", + "example": "ofc2f4zrZbs8nUa7p0g4", + "in": "path", + "name": "claimId", + "required": true, + "schema": { + "type": "string" + } + }, + "connectionId": { + "description": "Connection ID", + "in": "path", + "name": "connectionId", + "required": true, + "schema": { + "example": "0oafxqCAJWWGELFTYASJ", + "type": "string" + } + }, + "containerId": { + "description": "ID of an existing container, such as an app instance", + "in": "path", + "name": "containerId", + "required": true, + "schema": { + "type": "string" + } + }, + "customTelephonyProviderId": { + "description": "The ID of the custom telephony provider", + "in": "path", + "name": "customTelephonyProviderId", + "required": true, + "schema": { + "type": "string" + } + }, + "domain": { + "description": "The Okta domain name of your org or one of your custom domains", + "in": "path", + "name": "domain", + "required": true, + "schema": { + "type": "string" + } + }, + "groupId": { + "description": "ID of the Okta group", + "example": "00g1xucgTZFrziXg10g4", + "in": "path", + "name": "groupId", + "required": true, + "schema": { + "type": "string" + } + }, + "inlineHookType": { + "description": "One of the supported inline hook types", + "in": "query", + "name": "type", + "schema": { + "enum": [ + "com.okta.import.transform", + "com.okta.oauth2.tokens.transform", + "com.okta.saml.tokens.transform", + "com.okta.user.credential.password.import", + "com.okta.user.pre-registration", + "com.okta.telephony.provider" + ], + "type": "string" + } + }, + "limitParameter": { + "description": "Defines the number of policy rules returned. See [Pagination](https://developer.okta.com/docs/api/#pagination).", + "in": "query", + "name": "limit", + "schema": { + "type": "string" + } + }, + "matchQueryFilter": { + "description": "Searches for app service accounts where the account name (`name`), username (`username`), app instance label (`containerInstanceName`), or OIN app key name (`containerGlobalName`) contains the given value", + "in": "query", + "name": "match", + "required": false, + "schema": { + "example": "salesforce", + "maxLength": 255, + "minLength": 3, + "type": "string" + } + }, + "oktaManagedUserAccountId": { + "description": "ID of an existing Okta managed user account", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "a747a818-a4c4-4446-8a87-704216495a08", + "format": "regex", + "pattern": "(?i)^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", + "type": "string" + } + }, + "oktaManagedUserMatchQueryFilter": { + "description": "Searches for Okta managed user accounts where the account name (`name`) or username (`username`) contains the given value", + "in": "query", + "name": "match", + "required": false, + "schema": { + "example": "admin", + "maxLength": 255, + "minLength": 3, + "type": "string" + } + }, + "operationId": { + "description": "ID of the asynchronous operation in Okta", + "in": "path", + "name": "operationId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathAAGUID": { + "description": "Unique ID of a custom AAGUID", + "in": "path", + "name": "aaguid", + "required": true, + "schema": { + "example": "cb69481e-8ff7-4039-93ec-0a272911111", + "type": "string" + } + }, + "pathActionId": { + "description": "Action ID", + "in": "path", + "name": "actionId", + "required": true, + "schema": { + "example": "action_1234567890", + "type": "string" + } + }, + "pathActionsProviderType": { + "description": "Actions provider type", + "in": "path", + "name": "actionsProviderType", + "required": true, + "schema": { + "enum": [ + "workflows" + ], + "example": "workflows", + "type": "string" + } + }, + "pathApiServiceId": { + "description": "`id` of the API Service Integration instance", + "example": "000lr2rLjZ6NsGn1P0g3", + "in": "path", + "name": "apiServiceId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathApiTokenId": { + "description": "id of the API Token", + "in": "path", + "name": "apiTokenId", + "required": true, + "schema": { + "example": "00Tabcdefg1234567890", + "type": "string" + } + }, + "pathAppId": { + "description": "Application ID", + "in": "path", + "name": "appId", + "required": true, + "schema": { + "example": "0oafxqCAJWWGELFTYASJ", + "type": "string" + } + }, + "pathAppName": { + "description": "Name of the app definition (the OIN catalog app key name)", + "in": "path", + "name": "appName", + "required": true, + "schema": { + "example": "google", + "type": "string" + } + }, + "pathAppUserId": { + "description": "ID of an existing Okta user", + "in": "path", + "name": "userId", + "required": true, + "schema": { + "example": "00u13okQOVWZJGDOAUVR", + "type": "string" + } + }, + "pathAssociatedServerId": { + "description": "`id` of the associated Authorization Server", + "in": "path", + "name": "associatedServerId", + "required": true, + "schema": { + "example": "aus6xt9jKPmCyn6kg0g4", + "type": "string" + } + }, + "pathAuthServerId": { + "description": "`id` of the Authorization Server", + "in": "path", + "name": "authServerId", + "required": true, + "schema": { + "example": "GeGRTEr7f3yu2n7grw22", + "type": "string" + } + }, + "pathAuthenticatorId": { + "description": "`id` of the authenticator", + "in": "path", + "name": "authenticatorId", + "required": true, + "schema": { + "example": "aut1nd8PQhGcQtSxB0g4", + "type": "string" + } + }, + "pathBehaviorId": { + "description": "ID of the Behavior Detection Rule", + "in": "path", + "name": "behaviorId", + "required": true, + "schema": { + "example": "abcd1234", + "type": "string" + } + }, + "pathBrandId": { + "description": "The ID of the brand", + "in": "path", + "name": "brandId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathBundleId": { + "description": "The `id` of a bundle", + "in": "path", + "name": "bundleId", + "required": true, + "schema": { + "example": "enbllojq9J9J105DL1d6", + "type": "string" + } + }, + "pathCapability": { + "description": "Capability", + "in": "path", + "name": "capability", + "required": true, + "schema": { + "enum": [ + "sso", + "universal-logout", + "provisioning", + "entitlements", + "shared" + ], + "example": "provisioning", + "type": "string" + } + }, + "pathCaptchaId": { + "description": "The unique key used to identify your CAPTCHA instance", + "in": "path", + "name": "captchaId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathClaimId": { + "description": "`id` of Claim", + "in": "path", + "name": "claimId", + "required": true, + "schema": { + "example": "hNJ3Uk76xLagWkGx5W3N", + "type": "string" + } + }, + "pathClientId": { + "description": "`client_id` of the app", + "in": "path", + "name": "clientId", + "required": true, + "schema": { + "example": "52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD", + "type": "string" + } + }, + "pathClientSecretId": { + "description": "Unique `id` of the OAuth 2.0 client secret", + "example": "ocs2f4zrZbs8nUa7p0g4", + "in": "path", + "name": "secretId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathContactType": { + "in": "path", + "name": "contactType", + "required": true, + "schema": { + "description": "Type of contact", + "enum": [ + "BILLING", + "TECHNICAL" + ], + "example": "BILLING", + "type": "string" + } + }, + "pathCredentialKeyId": { + "description": "`id` of the certificate key", + "in": "path", + "name": "keyId", + "required": true, + "schema": { + "example": "P7jXpG-LG2ObNgY9C0Mn2uf4InCQTmRZMDCZoVNxdrk", + "type": "string" + } + }, + "pathCsrId": { + "description": "`id` of the CSR", + "in": "path", + "name": "csrId", + "required": true, + "schema": { + "example": "fd7x1h7uTcZFx22rU1f7", + "type": "string" + } + }, + "pathCustomizationId": { + "description": "The ID of the email customization", + "in": "path", + "name": "customizationId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathDeviceAssuranceId": { + "description": "Id of the device assurance policy", + "in": "path", + "name": "deviceAssuranceId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathDeviceId": { + "description": "`id` of the device", + "in": "path", + "name": "deviceId", + "required": true, + "schema": { + "example": "guo4a5u7JHHhjXrMK0g4", + "type": "string" + } + }, + "pathDeviceIntegrationId": { + "description": "The ID of the device integration", + "in": "path", + "name": "deviceIntegrationId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathDomainId": { + "description": "`id` of the Domain", + "in": "path", + "name": "domainId", + "required": true, + "schema": { + "example": "OmWNeywfTzElSLOBMZsL", + "type": "string" + } + }, + "pathEmailDomainId": { + "in": "path", + "name": "emailDomainId", + "required": true, + "schema": { + "description": "The ID of the email domain.", + "type": "string" + } + }, + "pathEmailServerId": { + "in": "path", + "name": "emailServerId", + "required": true, + "schema": { + "description": "ID of your SMTP server configuration", + "type": "string" + } + }, + "pathEnrollmentId": { + "description": "Unique identifier of an enrollment", + "in": "path", + "name": "enrollmentId", + "required": true, + "schema": { + "example": "sms8lqwuzSpWT4kVs0g4", + "type": "string" + } + }, + "pathEntitlementId": { + "description": "The `id` of a bundle entitlement", + "in": "path", + "name": "entitlementId", + "required": true, + "schema": { + "example": "ent4rg7fltWSgrlDT8g6", + "type": "string" + } + }, + "pathEventHookId": { + "description": "`id` of the Event Hook", + "in": "path", + "name": "eventHookId", + "required": true, + "schema": { + "example": "who8vt36qfNpCGz9H1e6", + "type": "string" + } + }, + "pathExternalUserId": { + "description": "The external ID of the user", + "example": "00u7m9p9ZT8k2S2EX1f7", + "in": "path", + "name": "externalId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathFactorId": { + "description": "ID of an existing user factor", + "in": "path", + "name": "factorId", + "required": true, + "schema": { + "example": "zAgrsaBe0wVGRugDYtdv", + "type": "string" + } + }, + "pathFeatureId": { + "description": "`id` of the feature", + "in": "path", + "name": "featureId", + "required": true, + "schema": { + "example": "R5HjqNn1pEqWGy48E9jg", + "type": "string" + } + }, + "pathFeatureName": { + "description": "Name of the Feature", + "in": "path", + "name": "featureName", + "required": true, + "schema": { + "$ref": "#/components/schemas/ApplicationFeatureType" + } + }, + "pathFirstPartyAppName": { + "description": "The key name for the Okta app.
\nSupported apps:\n * Okta Admin Console (`admin-console`)\n", + "in": "path", + "name": "appName", + "required": true, + "schema": { + "example": "admin-console", + "type": "string" + } + }, + "pathGrantId": { + "description": "Grant ID", + "in": "path", + "name": "grantId", + "required": true, + "schema": { + "example": "iJoqkwx50mrgX4T9LcaH", + "type": "string" + } + }, + "pathGroupId": { + "description": "The `id` of the group", + "in": "path", + "name": "groupId", + "required": true, + "schema": { + "example": "00g1emaKYZTWRYYRRTSK", + "type": "string" + } + }, + "pathGroupPushMappingId": { + "description": "Group push mapping ID", + "in": "path", + "name": "mappingId", + "required": true, + "schema": { + "example": "gPm00000000000000000", + "type": "string" + } + }, + "pathGroupRuleId": { + "description": "The `id` of the group rule", + "in": "path", + "name": "groupRuleId", + "required": true, + "schema": { + "example": "0pr3f7zMZZHPgUoWO0g4", + "type": "string" + } + }, + "pathHookKeyId": { + "description": "ID of the Hook Key", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "XreKU5laGwBkjOTehusG", + "type": "string" + } + }, + "pathId": { + "description": "An ID, login, or login shortname (as long as the shortname is unambiguous) of an existing Okta user", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + "pathIdentitySourceExternalId": { + "description": "The external ID of the identity source group", + "example": "GROUPEXT123456784C2IF", + "in": "path", + "name": "externalId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathIdentitySourceGroupOrExternalId": { + "description": "The Okta group ID or external ID of the identity source group", + "example": "00gsl4xM9ys8TdnbZ0g4 or GROUPEXT123456784C2IF", + "in": "path", + "name": "groupOrExternalId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathIdentitySourceId": { + "description": "The ID of the identity source for which the session is created", + "example": "0oa3l6l6WK6h0R0QW0g4", + "in": "path", + "name": "identitySourceId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathIdentitySourceMemberExternalId": { + "description": "The external ID of the identity source user", + "example": "USEREXT123456784C2IFA", + "in": "path", + "name": "memberExternalId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathIdentitySourceSessionId": { + "description": "The ID of the identity source session", + "example": "aps1qqonvr2SZv6o70h8", + "in": "path", + "name": "sessionId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathIdentitySourceUserId": { + "description": "The ID of the user in the identity source", + "example": "00u7m9p9ZT8k2S2EX1f7", + "in": "path", + "name": "appUserId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathIdpCsrId": { + "description": "`id` of the IdP CSR", + "in": "path", + "name": "idpCsrId", + "required": true, + "schema": { + "example": "1uEhyE65oV3H6KM9gYcN", + "type": "string" + } + }, + "pathIdpId": { + "description": "`id` of IdP", + "in": "path", + "name": "idpId", + "required": true, + "schema": { + "example": "0oa62bfdjnK55Z5x80h7", + "type": "string" + } + }, + "pathInlineHookId": { + "description": "`id` of the inline hook", + "in": "path", + "name": "inlineHookId", + "required": true, + "schema": { + "example": "Y7Rzrd4g4xj6WdKzrBHH", + "type": "string" + } + }, + "pathJsonWebKeyId": { + "description": "Unique `id` of the OAuth 2.0 client JSON Web Key", + "example": "pks2f4zrZbs8nUa7p0g4", + "in": "path", + "name": "keyId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathKeyId": { + "description": "ID of the Key Credential for the application", + "in": "path", + "name": "keyId", + "required": true, + "schema": { + "example": "sjP9eiETijYz110VkhHN", + "type": "string" + } + }, + "pathKid": { + "description": "Unique `id` of the IdP key credential", + "in": "path", + "name": "kid", + "required": true, + "schema": { + "example": "KmMo85SSsU7TZzOShcGb", + "type": "string" + } + }, + "pathLifecycle": { + "description": "Whether to `ENABLE` or `DISABLE` the feature", + "in": "path", + "name": "lifecycle", + "required": true, + "schema": { + "$ref": "#/components/schemas/FeatureLifecycle" + } + }, + "pathLinkedObjectName": { + "description": "Primary or Associated name", + "in": "path", + "name": "linkedObjectName", + "required": true, + "schema": { + "type": "string" + } + }, + "pathLogStreamId": { + "description": "Unique identifier for the log stream", + "in": "path", + "name": "logStreamId", + "required": true, + "schema": { + "example": "0oa1orzg0CHSgPcjZ0g4", + "type": "string" + } + }, + "pathLogStreamType": { + "in": "path", + "name": "logStreamType", + "required": true, + "schema": { + "$ref": "#/components/schemas/LogStreamType" + } + }, + "pathMappingId": { + "description": "`id` of the Mapping", + "in": "path", + "name": "mappingId", + "required": true, + "schema": { + "example": "cB6u7X8mptebWkffatKA", + "type": "string" + } + }, + "pathMemberId": { + "description": "`id` of the member", + "in": "path", + "name": "memberId", + "required": true, + "schema": { + "example": "irb1qe6PGuMc7Oh8N0g4", + "type": "string" + } + }, + "pathMethodType": { + "description": "Type of authenticator method", + "in": "path", + "name": "methodType", + "required": true, + "schema": { + "$ref": "#/components/schemas/AuthenticatorMethodType" + } + }, + "pathNotificationType": { + "in": "path", + "name": "notificationType", + "required": true, + "schema": { + "$ref": "#/components/schemas/NotificationType" + } + }, + "pathOAuthProvisioningAppName": { + "in": "path", + "name": "appName", + "required": true, + "schema": { + "$ref": "#/components/schemas/OAuthProvisioningEnabledApp" + } + }, + "pathOperation": { + "in": "path", + "name": "operation", + "required": true, + "schema": { + "type": "string" + } + }, + "pathOsAccountId": { + "description": "The unique identifier for the OS account", + "example": "dao3qgkIEKjhNZudR0g4", + "in": "path", + "name": "osAccountId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathOwnerId": { + "description": "The `id` of the group owner", + "in": "path", + "name": "ownerId", + "required": true, + "schema": { + "example": "00u1emaK22TWRYd3TtG", + "type": "string" + } + }, + "pathPermissionType": { + "description": "An Okta [permission](/openapi/okta-management/guides/permissions)", + "in": "path", + "name": "permissionType", + "required": true, + "schema": { + "example": "okta.users.manage", + "type": "string" + } + }, + "pathPolicyId": { + "description": "`id` of the policy", + "in": "path", + "name": "policyId", + "required": true, + "schema": { + "example": "00plrilJ7jZ66Gn0X0g3", + "type": "string" + } + }, + "pathPolicyMappingId": { + "description": "`id` of the policy resource Mapping", + "in": "path", + "name": "mappingId", + "required": true, + "schema": { + "example": "maplr2rLjZ6NsGn1P0g3", + "type": "string" + } + }, + "pathPoolId": { + "description": "ID of the agent pool for which the settings apply to", + "in": "path", + "name": "poolId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathPostureCheckId": { + "description": "ID of the device posture check", + "in": "path", + "name": "postureCheckId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathPrimaryRelationshipName": { + "description": "Name of the `primary` relationship being assigned", + "in": "path", + "name": "primaryRelationshipName", + "required": true, + "schema": { + "example": "manager", + "type": "string" + } + }, + "pathPrimaryUserId": { + "description": "User ID to be assigned to the `primary` relationship for the `associated` user", + "in": "path", + "name": "primaryUserId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathPrincipalRateLimitId": { + "description": "ID of the principal rate limit", + "in": "path", + "name": "principalRateLimitId", + "required": true, + "schema": { + "example": "0oacamvryxiyMqgiY1d7", + "type": "string" + } + }, + "pathPublicKeyId": { + "description": "id\" of the Public Key", + "in": "path", + "name": "keyId", + "required": true, + "schema": { + "example": "FcH2P9Eg7wr0o8N2FuV0", + "type": "string" + } + }, + "pathPushProviderId": { + "description": "Id of the push provider", + "in": "path", + "name": "pushProviderId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathQueryRoleExpand": { + "description": "An optional parameter used to return targets configured for the standard role assignment in the `embedded` property. Supported values: `targets/groups` or `targets/catalog/apps`", + "examples": { + "appTarget": { + "summary": "Return app targets", + "value": "targets/catalog/apps" + }, + "groupTarget": { + "summary": "Return group targets", + "value": "targets/groups" + } + }, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "type": "string" + } + }, + "pathRealmId": { + "description": "ID of the realm", + "in": "path", + "name": "realmId", + "required": true, + "schema": { + "example": "vvrcFogtKCrK9aYq3fgV", + "type": "string" + } + }, + "pathRelationshipName": { + "description": "Name of the `primary` or `associated` relationship being queried", + "examples": { + "manager": { + "summary": "Example of a `primary` name", + "value": "manager" + }, + "subordinate": { + "summary": "Example of an `associated` name", + "value": "subordinate" + } + }, + "in": "path", + "name": "relationshipName", + "required": true, + "schema": { + "type": "string" + } + }, + "pathResourceId": { + "description": "`id` of the resource", + "in": "path", + "name": "resourceId", + "required": true, + "schema": { + "example": "ire106sQKoHoXXsAe0g4", + "type": "string" + } + }, + "pathResourceSetIdOrLabel": { + "description": "`id` or `label` of the resource set", + "in": "path", + "name": "resourceSetIdOrLabel", + "required": true, + "schema": { + "example": "iamoJDFKaJxGIr0oamd9g", + "type": "string" + } + }, + "pathRiskProviderId": { + "description": "`id` of the risk provider object", + "in": "path", + "name": "riskProviderId", + "required": true, + "schema": { + "example": "00rp12r4skkjkjgsn", + "type": "string" + } + }, + "pathRoleAssignmentId": { + "description": "The `id` of the role assignment", + "in": "path", + "name": "roleAssignmentId", + "required": true, + "schema": { + "example": "JBCUYUC7IRCVGS27IFCE2SKO", + "type": "string" + } + }, + "pathRoleId": { + "description": "`id` of the role", + "in": "path", + "name": "roleId", + "required": true, + "schema": { + "example": "3Vg1Pjp3qzw4qcCK5EdO", + "type": "string" + } + }, + "pathRoleIdOrEncodedRoleId": { + "description": "The `id` of the role or Base32 encoded `id` of the role name", + "in": "path", + "name": "roleIdOrEncodedRoleId", + "required": true, + "schema": { + "example": "JBCUYUC7IRCVGS27IFCE2SKO", + "type": "string" + } + }, + "pathRoleIdOrLabel": { + "description": "`id` or `label` of the role", + "in": "path", + "name": "roleIdOrLabel", + "required": true, + "schema": { + "example": "cr0Yq6IJxGIr0ouum0g3", + "type": "string" + } + }, + "pathRoleRef": { + "description": "A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard roles](/openapi/okta-management/guides/roles/#standard-roles).", + "in": "path", + "name": "roleRef", + "required": true, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/RoleType" + }, + { + "$ref": "#/components/schemas/RoleId" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + } + }, + "pathRuleId": { + "description": "`id` of the policy rule", + "in": "path", + "name": "ruleId", + "required": true, + "schema": { + "example": "ruld3hJ7jZh4fn0st0g3", + "type": "string" + } + }, + "pathSchemaId": { + "description": "Schema ID. You can also use `default` to refer to the default user type schema.", + "in": "path", + "name": "schemaId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathScopeId": { + "description": "`id` of Scope", + "in": "path", + "name": "scopeId", + "required": true, + "schema": { + "example": "0TMRpCWXRKFjP7HiPFNM", + "type": "string" + } + }, + "pathSecretId": { + "description": "`id` of the API Service Integration instance Secret", + "example": "ocs2f4zrZbs8nUa7p0g4", + "in": "path", + "name": "secretId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathSection": { + "in": "path", + "name": "section", + "required": true, + "schema": { + "type": "string" + } + }, + "pathSecurityEventProviderId": { + "description": "`id` of the security events provider instance", + "in": "path", + "name": "securityEventProviderId", + "required": true, + "schema": { + "example": "sse1qg25RpusjUP6m0g5", + "type": "string" + } + }, + "pathSessionId": { + "description": "`id` of the session", + "in": "path", + "name": "sessionId", + "required": true, + "schema": { + "example": "l7FbDVqS8zHSy65uJD85", + "type": "string" + } + }, + "pathSubmissionId": { + "description": "OIN integration ID", + "in": "path", + "name": "submissionId", + "required": true, + "schema": { + "example": "acme_submissionapp_1", + "type": "string" + } + }, + "pathTargetGroupId": { + "in": "path", + "name": "targetGroupId", + "required": true, + "schema": { + "example": "00g1e9dfjHeLAsdX983d", + "type": "string" + } + }, + "pathTemplateId": { + "description": "`id` of the Template", + "in": "path", + "name": "templateId", + "required": true, + "schema": { + "example": "6NQUJ5yR3bpgEiYmq8IC", + "type": "string" + } + }, + "pathTemplateName": { + "description": "The name of the email template", + "in": "path", + "name": "templateName", + "required": true, + "schema": { + "type": "string" + } + }, + "pathThemeId": { + "description": "The ID of the theme", + "in": "path", + "name": "themeId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathTokenId": { + "description": "`id` of Token", + "in": "path", + "name": "tokenId", + "required": true, + "schema": { + "example": "sHHSth53yJAyNSTQKDJZ", + "type": "string" + } + }, + "pathTransactionId": { + "description": "ID of an existing factor verification transaction", + "in": "path", + "name": "transactionId", + "required": true, + "schema": { + "example": "gPAQcN3NDjSGOCAeG2Jv", + "type": "string" + } + }, + "pathTrustedOriginId": { + "description": "`id` of the trusted origin", + "in": "path", + "name": "trustedOriginId", + "required": true, + "schema": { + "example": "7j2PkU1nyNIDe26ZNufR", + "type": "string" + } + }, + "pathTypeId": { + "in": "path", + "name": "typeId", + "required": true, + "schema": { + "description": "The unique key for the user type", + "type": "string" + } + }, + "pathUpdateId": { + "description": "ID of the update", + "in": "path", + "name": "updateId", + "required": true, + "schema": { + "type": "string" + } + }, + "pathUserId": { + "description": "ID of an existing Okta user", + "in": "path", + "name": "userId", + "required": true, + "schema": { + "example": "00ub0oNGTSWTBKOLGLNR", + "type": "string" + } + }, + "pathUserIdOrLogin": { + "description": "If for the `self` link, this is the ID of the user for whom you want to get the primary user ID. If for the `associated` relation, this is the user ID or login value of the user assigned the associated relationship.\n\nThis can be `me` to represent the current session user.", + "examples": { + "manager": { + "summary": "Example ID of `primary`", + "value": "00u5zex6ztMbOZhF50h7" + }, + "subordinate": { + "summary": "Example ID of `associated`", + "value": "00u5zex6ztMbOZhF50h7" + } + }, + "in": "path", + "name": "userIdOrLogin", + "required": true, + "schema": { + "type": "string" + } + }, + "pathWebAuthnMethodType": { + "description": "Type of authenticator method", + "in": "path", + "name": "webAuthnMethodType", + "required": true, + "schema": { + "$ref": "#/components/schemas/AuthenticatorMethodTypeWebAuthn" + } + }, + "pathWellKnownUriPath": { + "description": "The path of the well-known URI", + "in": "path", + "name": "path", + "required": true, + "schema": { + "enum": [ + "apple-app-site-association", + "assetlinks.json", + "webauthn" + ], + "type": "string" + } + }, + "pathZoneId": { + "description": "`id` of the Network Zone", + "example": "nzowc1U5Jh5xuAK0o0g3", + "in": "path", + "name": "zoneId", + "required": true, + "schema": { + "type": "string" + } + }, + "privQueryAfter": { + "description": "The cursor used for pagination. It represents the last privileged resource ID returned in the previous fetch operation.", + "example": "oprbuthToCeLWOBwh0g4", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + "privQueryLastUpdated": { + "description": "Last updated timestamp query parameter", + "example": "2024-11-03T00:00:00.000Z", + "in": "query", + "name": "lastUpdated", + "schema": { + "type": "string" + } + }, + "privQueryLimit": { + "description": "Specifies the batch size of the results to be returned", + "in": "query", + "name": "limit", + "schema": { + "default": 200, + "format": "int32", + "maximum": 1000, + "type": "integer" + } + }, + "privQueryStatus": { + "description": "The status of the privileged resource to filter on", + "example": "ACTIVE", + "in": "query", + "name": "status", + "schema": { + "type": "string" + } + }, + "privilegedResourceId": { + "description": "ID of an existing privileged resource", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + "queryAfter": { + "description": "The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + "queryAppAfter": { + "description": "Specifies the pagination cursor for the next page of results. Treat this as an opaque value obtained through the next link relationship. See [Pagination](/#pagination).", + "in": "query", + "name": "after", + "schema": { + "example": 16275000448691, + "type": "string" + } + }, + "queryAppGrantsExpand": { + "description": "An optional parameter to return scope details in the `_embedded` property. Valid value: `scope`", + "in": "query", + "name": "expand", + "schema": { + "example": "scope", + "type": "string" + } + }, + "queryAppLimit": { + "description": "Specifies the number of objects to return per page.\nIf there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it).\nSee [Pagination](/#pagination).\n", + "in": "query", + "name": "limit", + "schema": { + "default": 50, + "format": "int32", + "maximum": 500, + "minimum": 1, + "type": "integer" + } + }, + "queryAppUserExpand": { + "description": "An optional query parameter to return the corresponding [User](/openapi/okta-management/management/tags/user) object in the `_embedded` property.\nValid value: `user`", + "in": "query", + "name": "expand", + "schema": { + "example": "user", + "type": "string" + } + }, + "queryAppUserQ": { + "description": "Specifies a filter for the list of application users returned based on their profile attributes.\nThe value of `q` is matched against the beginning of the following profile attributes: `userName`, `firstName`, `lastName`, and `email`.\nThis filter only supports the `startsWith` operation that matches the `q` string against the beginning of the attribute values.\n> **Note:** For OIDC apps, user profiles don't contain the `firstName` or `lastName` attributes. Therefore, the query only matches against the `userName` or `email` attributes.\n", + "in": "query", + "name": "q", + "schema": { + "example": "sam", + "type": "string" + } + }, + "queryAppsExpand": { + "description": "An optional parameter used for link expansion to embed more resources in the response.\nOnly supports `expand=user/{userId}` and must be used with the `user.id eq \"{userId}\"` filter query for the same user.\nReturns the assigned [application user](/openapi/okta-management/management/tags/applicationusers) in the `_embedded` property.", + "in": "query", + "name": "expand", + "schema": { + "example": "user/0oa1gjh63g214q0Hq0g4", + "type": "string" + } + }, + "queryDiscloseIdentifiers": { + "description": "Indicates whether or not the identifier of an authenticator enrollment is disclosed or anonymized. If it's included in the operation query, then the identifier of the authenticator enrollment (the actual phone number, for example) is included in the response.", + "in": "query", + "name": "discloseIdentifiers", + "schema": { + "items": { + "enum": [ + "phone" + ], + "type": "string" + }, + "type": "array" + } + }, + "queryExpand": { + "description": "Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.", + "in": "query", + "name": "expand", + "schema": { + "type": "string" + } + }, + "queryExpandBrand": { + "description": "Specifies additional metadata to be included in the response", + "explode": false, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "enum": [ + "themes", + "domains", + "emailDomain" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + "queryExpandEmailDomain": { + "description": "Specifies additional metadata to be included in the response", + "explode": false, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "enum": [ + "brands" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + "queryExpandEmailTemplate": { + "description": "Specifies additional metadata to be included in the response", + "explode": false, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "enum": [ + "settings", + "customizationCount" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + "queryExpandGroupIdToGroupNameMap": { + "description": "If specified, returns the mapping of group IDs to group names in the `_embedded` object.", + "in": "query", + "name": "expand", + "schema": { + "enum": [ + "groupIdToGroupNameMap" + ], + "type": "string" + }, + "x-okta-added-version": "1.3.0" + }, + "queryExpandPageRoot": { + "description": "Specifies additional metadata to be included in the response", + "explode": false, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "enum": [ + "default", + "customized", + "customizedUrl", + "preview", + "previewUrl" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + "queryExpandWellKnownUri": { + "description": "Specifies additional metadata to include in the response", + "explode": false, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "enum": [ + "customized" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + "queryExpandWellKnownUris": { + "description": "Specifies additional metadata to include in the response", + "explode": false, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "enum": [ + "all", + "apple-app-site-association", + "assetlinks.json", + "webauthn" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + "queryFilter": { + "description": "Searches the records for matching value", + "in": "query", + "name": "q", + "schema": { + "type": "string" + } + }, + "queryGroupAssignmentLimit": { + "description": "Specifies the number of objects to return per page.\nIf there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it).\nSee [Pagination](/#pagination).", + "examples": { + "hundred": { + "summary": "Sample limit value", + "value": 100 + }, + "max": { + "summary": "Maximum limit value", + "value": 200 + }, + "min": { + "summary": "Minimum limit value", + "value": 20 + } + }, + "in": "query", + "name": "limit", + "schema": { + "default": 20, + "format": "int32", + "maximum": 200, + "minimum": 20, + "type": "integer" + } + }, + "queryGroupAssignmentWithGroupExpand": { + "description": "An optional query parameter to return the corresponding assigned [group](openapi/okta-management/management/group) or the group assignment metadata details in the `_embedded` property.", + "examples": { + "group": { + "summary": "Embedded assigned group", + "value": "group" + }, + "metadata": { + "summary": "Embedded group assignment metadata", + "value": "metadata" + } + }, + "in": "query", + "name": "expand", + "schema": { + "example": "group", + "type": "string" + } + }, + "queryGroupAssignmentWithMetadataExpand": { + "description": "An optional query parameter to return the corresponding assigned [group](openapi/okta-management/management/group) or the group assignment metadata details in the `_embedded` property.", + "examples": { + "group": { + "summary": "Embedded assigned group", + "value": "group" + }, + "metadata": { + "summary": "Embedded group assignment metadata", + "value": "metadata" + } + }, + "in": "query", + "name": "expand", + "schema": { + "example": "metadata", + "type": "string" + } + }, + "queryLanguage": { + "description": "The language to use for the email. Defaults to the current user's language if unspecified.", + "in": "query", + "name": "language", + "schema": { + "$ref": "#/components/schemas/Language" + } + }, + "queryLimit": { + "description": "A limit on the number of objects to return", + "in": "query", + "name": "limit", + "schema": { + "default": 20, + "maximum": 200, + "minimum": 1, + "type": "integer" + } + }, + "queryLimitPerPoolType": { + "description": "Maximum number of agent pools returned", + "in": "query", + "name": "limitPerPoolType", + "required": false, + "schema": { + "default": 5, + "type": "integer" + } + }, + "queryOsAccountExpand": { + "description": "Comma-separated list of related resources to include in the `_embedded` attribute. Supported values are `users` and `account_linked_enrollments`.", + "explode": false, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "example": [ + "users", + "account_linked_enrollments" + ], + "items": { + "enum": [ + "users", + "account_linked_enrollments" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + "queryPoolType": { + "description": "Agent type to search for", + "in": "query", + "name": "poolType", + "required": false, + "schema": { + "$ref": "#/components/schemas/AgentType" + } + }, + "queryResultId": { + "description": "The unique identifier returned by the initial POST request (`POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query`)", + "in": "path", + "name": "resultId", + "required": true, + "schema": { + "type": "string" + } + }, + "queryScheduled": { + "description": "Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates.", + "in": "query", + "name": "scheduled", + "required": false, + "schema": { + "type": "boolean" + } + }, + "querySortOrder": { + "description": "Specifies sort order: `asc` or `desc` (for search queries only). This parameter is ignored if `sortBy` isn't present.", + "in": "query", + "name": "sortOrder", + "schema": { + "default": "asc", + "type": "string" + } + }, + "queryUserExpand": { + "description": "An optional parameter to include metadata in the `_embedded` attribute. Valid values: `blocks` or `classification`.", + "in": "query", + "name": "expand", + "required": false, + "schema": { + "example": "blocks", + "type": "string" + } + }, + "serviceAccountId": { + "description": "ID of an existing service account", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + "simulateParameter": { + "description": "Use `expand=EVALUATED` to include a list of evaluated but not matched policies and policy rules. Use `expand=RULE` to include details about why a rule condition wasn't matched.", + "in": "query", + "name": "expand", + "schema": { + "example": "EVALUATED", + "type": "string" + } + }, + "yubikeyTokenId": { + "description": "ID of a YubiKey token", + "in": "path", + "name": "tokenId", + "required": true, + "schema": { + "example": "ykkxdtCA1fKVxyu6R0g3", + "type": "string" + } + } + }, + "requestBodies": { + "AuthenticatorRequestBody": { + "content": { + "application/json": { + "examples": { + "Duo": { + "$ref": "#/components/examples/AuthenticatorRequestDuo" + }, + "Passkeys with custom name and description": { + "$ref": "#/components/examples/AuthenticatorRequestWebAuthnWithNameAndDescription" + }, + "TAC": { + "$ref": "#/components/examples/AuthenticatorRequestTac" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorBase" + } + } + }, + "required": true + }, + "PhoneAuthenticatorEnrollmentRequestBody": { + "content": { + "application/json": { + "examples": { + "PhoneSmsEx": { + "$ref": "#/components/examples/AuthenticatorEnrollmentCreateRequestPhone" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentCreateRequest" + } + } + }, + "required": true + }, + "TacAuthenticatorEnrollmentRequestBody": { + "content": { + "application/json": { + "examples": { + "TacEx": { + "$ref": "#/components/examples/AuthenticatorEnrollmentCreateRequestTac" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentCreateRequestTac" + } + } + }, + "required": true + } + }, + "responses": { + "AuthenticatorEnrollmentResponse": { + "content": { + "application/json": { + "examples": { + "PhoneCallEx": { + "$ref": "#/components/examples/AuthenticatorEnrollmentResponsePhoneVoice" + }, + "PhoneDisclosedEx": { + "$ref": "#/components/examples/AuthenticatorEnrollmentResponsePhoneDisclosed" + }, + "PhoneSmsEx": { + "$ref": "#/components/examples/AuthenticatorEnrollmentResponsePhoneSms" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorEnrollment" + } + } + }, + "description": "Success" + }, + "AuthenticatorResponse": { + "content": { + "application/json": { + "examples": { + "Duo": { + "$ref": "#/components/examples/AuthenticatorResponseDuo" + }, + "Email": { + "$ref": "#/components/examples/AuthenticatorResponseEmail" + }, + "Passkeys with custom name and description": { + "$ref": "#/components/examples/AuthenticatorResponseWebAuthnWithNameAndDescription" + }, + "Password": { + "$ref": "#/components/examples/AuthenticatorResponsePassword" + }, + "Phone": { + "$ref": "#/components/examples/AuthenticatorResponsePhone" + }, + "SecurityQuestion": { + "$ref": "#/components/examples/AuthenticatorResponseSecurityQuestion" + }, + "TAC": { + "$ref": "#/components/examples/AuthenticatorResponseTac" + }, + "WebAuthn": { + "$ref": "#/components/examples/AuthenticatorResponseWebAuthn" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorBase" + } + } + }, + "description": "OK" + }, + "AuthenticatorResponseInactiveWebAuthn": { + "content": { + "application/json": { + "examples": { + "WebAuthn": { + "$ref": "#/components/examples/AuthenticatorResponseInactiveWebAuthn" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorBase" + } + } + }, + "description": "OK" + }, + "DRStatusResponse": { + "content": { + "application/json": { + "example": { + "status": [ + { + "domain": "yourOktaDomain.okta.com", + "isFailedOver": true + } + ] + }, + "schema": { + "properties": { + "status": { + "description": "List of domains and their disaster recovery status", + "items": { + "$ref": "#/components/schemas/DRStatusItem" + }, + "type": "array" + } + } + } + } + }, + "description": "OK", + "headers": { + "Link": { + "description": "A link to the next page of responses", + "schema": { + "type": "string" + } + } + } + }, + "Error-FF-NotEnabled-Response-401": { + "content": { + "application/json": { + "examples": { + "Unauthorized": { + "value": { + "errorCauses": [], + "errorCode": "E0000015", + "errorId": "oaeStOuPPxDRUm3PJhf-tL7bQ", + "errorLink": "E0000015", + "errorSummary": "You do not have permission to access the feature you are requesting" + } + } + } + } + }, + "description": "Unauthorized" + }, + "Error502NoConnectedAgents": { + "content": { + "application/json": { + "examples": { + "AgentTimeOut": { + "$ref": "#/components/examples/ErrorNoConnectedAgents" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "There are no connected agents." + }, + "Error504AgentTimeOut": { + "content": { + "application/json": { + "examples": { + "AgentTimeOut": { + "$ref": "#/components/examples/ErrorAgentTimeOut" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Timed out waiting for agent" + }, + "ErrorAccessDenied403": { + "content": { + "application/json": { + "examples": { + "AccessDenied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "ErrorApiValidationConflict409": { + "content": { + "application/json": { + "examples": { + "AccessDenied": { + "$ref": "#/components/examples/ErrorApiValidationConflict" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Conflict" + }, + "ErrorApiValidationFailed400": { + "content": { + "application/json": { + "examples": { + "APIValidationFailed": { + "$ref": "#/components/examples/ErrorApiValidationFailed" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "ErrorAppUserForbidden403": { + "content": { + "application/json": { + "examples": { + "AccessDenied": { + "$ref": "#/components/examples/ErrorAccessDenied" + }, + "AppUserProvEx": { + "$ref": "#/components/examples/ErrorAppUserForbiddenAction" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "ErrorAppUserUpdateBadRequest400": { + "content": { + "application/json": { + "examples": { + "APIValidationFailed": { + "$ref": "#/components/examples/ErrorApiValidationFailed" + }, + "AppUserUpdateCredEx": { + "$ref": "#/components/examples/ErrorAppUserUpdateBadRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "ErrorInternalServer500": { + "content": { + "application/json": { + "examples": { + "InternalServerError": { + "$ref": "#/components/examples/ErrorInternalServer" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Internal Server Error" + }, + "ErrorInvalidToken401": { + "content": { + "application/json": { + "examples": { + "InvalidTokenProvided": { + "$ref": "#/components/examples/ErrorInvalidTokenProvided" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Unauthorized" + }, + "ErrorMissingRequiredParameter400": { + "content": { + "application/json": { + "examples": { + "MissingRequiredParameter": { + "$ref": "#/components/examples/ErrorMissingRequiredParameter" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "ErrorResourceNotFound404": { + "content": { + "application/json": { + "examples": { + "ResourceNotFound": { + "$ref": "#/components/examples/ErrorResourceNotFound" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "ErrorTooManyRequests429": { + "content": { + "application/json": { + "examples": { + "TooManyRequests": { + "$ref": "#/components/examples/ErrorTooManyRequests" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Too Many Requests" + }, + "FailbackResponse": { + "content": { + "application/json": { + "schema": { + "properties": { + "results": { + "description": "Results of the failback operation", + "items": { + "properties": { + "domain": { + "description": "Domain for your org", + "example": "yourOktaDomain.okta.com", + "type": "string" + }, + "message": { + "description": "Domain failback message", + "example": "Failback was successful", + "type": "string" + } + } + }, + "type": "array" + } + } + } + } + }, + "description": "OK" + }, + "FailoverResponse": { + "content": { + "application/json": { + "schema": { + "properties": { + "results": { + "description": "Results of the failover operation", + "items": { + "properties": { + "domain": { + "description": "Domain for your org", + "example": "yourOktaDomain.okta.com", + "type": "string" + }, + "message": { + "description": "Domain failover message", + "example": "Failover was successful", + "type": "string" + } + } + }, + "type": "array" + } + } + } + } + }, + "description": "OK" + }, + "GetFactorResponse": { + "content": { + "application/json": { + "examples": { + "Email": { + "$ref": "#/components/examples/FactorEmail" + }, + "SMS": { + "$ref": "#/components/examples/FactorResponseSms" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactor" + } + } + }, + "description": "Success" + }, + "NzErrorApiValidationFailed400": { + "content": { + "application/json": { + "examples": { + "APIValidationFailed": { + "$ref": "#/components/examples/NzErrorApiValidationFailed" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "NzErrorResourceNotFound404": { + "content": { + "application/json": { + "examples": { + "ResourceNotFound": { + "$ref": "#/components/examples/NzErrorResourceNotFound" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "PhoneAuthenticatorCreateEnrollmentResponse": { + "content": { + "application/json": { + "examples": { + "PhoneCallEx": { + "$ref": "#/components/examples/AuthenticatorEnrollmentResponsePhoneVoice" + }, + "PhoneSmsEx": { + "$ref": "#/components/examples/AuthenticatorEnrollmentResponsePhoneSms" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorEnrollment" + } + } + }, + "description": "Success" + }, + "TacAuthenticatorCreateEnrollmentResponse": { + "content": { + "application/json": { + "examples": { + "TacEx": { + "$ref": "#/components/examples/AuthenticatorEnrollmentResponseTac" + } + }, + "schema": { + "$ref": "#/components/schemas/TacAuthenticatorEnrollment" + } + } + }, + "description": "Success" + } + }, + "schemas": { + "AAGUIDAuthenticatorCharacteristics": { + "description": "Contains additional properties about custom AAGUID.", + "properties": { + "fipsCompliant": { + "description": "Indicates whether the authenticator meets Federal Information Processing Standards (FIPS) compliance requirements", + "type": "boolean" + }, + "hardwareProtected": { + "description": "Indicates whether the authenticator stores the private key on a hardware component", + "type": "boolean" + }, + "platformAttached": { + "description": "Indicates whether the custom AAGUID is built into the authenticator (`true`) or if it's a separate, external authenticator", + "type": "boolean" + } + }, + "type": "object" + }, + "AAGUIDGroupObject": { + "properties": { + "aaguids": { + "description": "A list of YubiKey hardware FIDO2 AAGUIDs. The available [AAGUIDs](https://support.yubico.com/hc/en-us/articles/360016648959-YubiKey-Hardware-FIDO2-AAGUIDs) are provided by the FIDO Alliance Metadata Service.", + "items": { + "description": "AAGUID", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "A name to identify the group of YubiKey hardware FIDO2 AAGUIDs", + "type": "string" + } + }, + "type": "object" + }, + "APIServiceIntegrationInstance": { + "properties": { + "_links": { + "$ref": "#/components/schemas/APIServiceIntegrationLinks", + "readOnly": true + }, + "configGuideUrl": { + "description": "The URL to the API service integration configuration guide", + "example": "https://{docDomain}/my-app-cie/configuration-guide", + "readOnly": true, + "type": "string" + }, + "createdAt": { + "description": "Timestamp when the API Service Integration instance was created", + "example": "2023-02-21T20:08:24.000Z", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "The user ID of the API Service Integration instance creator", + "example": "00uu3u0ujW1P6AfZC2d5", + "readOnly": true, + "type": "string" + }, + "grantedScopes": { + "description": "The list of Okta management scopes granted to the API Service Integration instance. See [Okta management OAuth 2.0 scopes](/oauth2/#okta-admin-management).", + "example": [ + "okta.logs.read" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "The ID of the API Service Integration instance", + "example": "0oa72lrepvp4WqEET1d9", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the API service integration that corresponds with the `type` property. This is the full name of the API service integration listed in the Okta Integration Network (OIN) catalog.", + "example": "My App Cloud Identity Engine", + "readOnly": true, + "type": "string" + }, + "properties": { + "$ref": "#/components/schemas/AppProperties" + }, + "type": { + "description": "The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name. For example, `my_api_log_integration`.", + "example": "my_app_cie", + "type": "string" + } + }, + "type": "object" + }, + "APIServiceIntegrationInstanceSecret": { + "properties": { + "_links": { + "$ref": "#/components/schemas/APIServiceIntegrationSecretLinks", + "readOnly": true + }, + "client_secret": { + "description": "The OAuth 2.0 client secret string. The client secret string is returned in the response of a Secret creation request. In other responses (such as list, activate, or deactivate requests), the client secret is returned as an undisclosed hashed value.", + "example": "DRUFXGF9XbLnS9k-Sla3x3POBiIxDreBCdZuFs5B", + "readOnly": true, + "type": "string" + }, + "created": { + "description": "Timestamp when the API Service Integration instance Secret was created", + "example": "2023-02-21T20:08:24.000Z", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the API Service Integration instance Secret", + "example": "ocs2f4zrZbs8nUa7p0g4", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the API Service Integration instance Secret was updated", + "example": "2023-02-21T20:08:24.000Z", + "readOnly": true, + "type": "string" + }, + "secret_hash": { + "description": "OAuth 2.0 client secret string hash", + "example": "yk4SVx4sUWVJVbHt6M-UPA", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Status of the API Service Integration instance Secret", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE", + "type": "string" + } + }, + "required": [ + "id", + "status", + "client_secret", + "created", + "lastUpdated", + "secret_hash", + "_links" + ], + "type": "object" + }, + "APIServiceIntegrationLinks": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of an application using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.", + "properties": { + "client": { + "$ref": "#/components/schemas/HrefObjectClientLink" + }, + "logo": { + "$ref": "#/components/schemas/HrefObjectLogoLink" + }, + "self": { + "$ref": "#/components/schemas/HrefObjectSelfLink" + } + }, + "readOnly": true + }, + "APIServiceIntegrationSecretLinks": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of an application using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.", + "properties": { + "activate": { + "$ref": "#/components/schemas/HrefObjectActivateLink" + }, + "deactivate": { + "$ref": "#/components/schemas/HrefObjectDeactivateLink" + }, + "delete": { + "$ref": "#/components/schemas/HrefObjectDeleteLink" + } + }, + "readOnly": true + }, + "APNSConfiguration": { + "properties": { + "fileName": { + "description": "(Optional) File name for Admin Console display", + "type": "string" + }, + "keyId": { + "description": "10-character Key ID obtained from the Apple developer account", + "type": "string" + }, + "teamId": { + "description": "10-character Team ID used to develop the iOS app", + "type": "string" + }, + "tokenSigningKey": { + "description": "APNs private authentication token signing key", + "type": "string", + "writeOnly": true + } + } + }, + "APNSPushProvider": { + "allOf": [ + { + "$ref": "#/components/schemas/PushProvider" + }, + { + "properties": { + "configuration": { + "$ref": "#/components/schemas/APNSConfiguration" + } + }, + "type": "object" + } + ] + }, + "AccessPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "properties": { + "resourceType": { + "description": "The resource that this policy controls. For the [Okta account management policy](https://developer.okta.com/docs/guides/okta-account-management-policy/main/#example-response), `END_USER_ACCOUNT_MANAGEMENT` is returned. For other policies, `APP` is returned.", + "type": "string" + } + }, + "type": "object" + }, + "conditions": { + "default": null, + "description": "Policy conditions aren't supported. Conditions are applied at the rule level for this policy type.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AccessPolicyConstraint": { + "description": "Consists of a `POSSESSION` constraint, a `KNOWLEDGE` constraint, or both. You can't configure an `INHERENCE` constraint, but an inherence factor can satisfy the second part of a 2FA assurance if no other constraints are specified.\nConstraints are logically evaluated such that only one `constraint` object needs to be satisfied, but within a `constraint` object, each `constraint` property must be satisfied.", + "properties": { + "authenticationMethods": { + "description": "This property specifies the precise authenticator and method for authentication. ", + "items": { + "$ref": "#/components/schemas/AuthenticationMethodObject" + }, + "type": "array" + }, + "excludedAuthenticationMethods": { + "description": "This property specifies the precise authenticator and method to exclude from authentication. ", + "items": { + "$ref": "#/components/schemas/AuthenticationMethodObject" + } + }, + "methods": { + "description": "The authenticator methods that are permitted", + "items": { + "enum": [ + "PASSWORD", + "SECURITY_QUESTION", + "SMS", + "VOICE", + "EMAIL", + "PUSH", + "SIGNED_NONCE", + "OTP", + "TOTP", + "WEBAUTHN", + "DUO", + "IDP", + "CERT" + ], + "type": "string" + }, + "type": "array" + }, + "reauthenticateIn": { + "description": "The duration after which the user must re-authenticate regardless of user activity. This re-authentication interval overrides the Verification Method object's `reauthenticateIn` interval. The supported values use ISO 8601 period format for recurring time intervals (for example, `PT1H`).", + "type": "string" + }, + "required": { + "description": "This property indicates whether the knowledge or possession factor is required by the assurance. It's optional in the request, but is always returned in the response. By default, this field is `true`. If the knowledge or possession constraint has values for `excludedAuthenticationMethods` the `required` value is false. ", + "type": "boolean" + }, + "types": { + "description": "The authenticator types that are permitted", + "items": { + "enum": [ + "SECURITY_KEY", + "PHONE", + "EMAIL", + "PASSWORD", + "SECURITY_QUESTION", + "APP", + "FEDERATED" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AccessPolicyConstraints": { + "description": "Specifies constraints for the authenticator. Constraints are logically evaluated such that only one constraint object needs to be satisfied. But, within a constraint object, each constraint property must be satisfied.", + "properties": { + "knowledge": { + "$ref": "#/components/schemas/KnowledgeConstraint" + }, + "possession": { + "$ref": "#/components/schemas/PossessionConstraint" + } + }, + "type": "object" + }, + "AccessPolicyLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the app access policy resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AccessPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "$ref": "#/components/schemas/AccessPolicyRuleActions" + }, + "conditions": { + "$ref": "#/components/schemas/AccessPolicyRuleConditions" + } + }, + "type": "object" + } + ] + }, + "AccessPolicyRuleActions": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRuleActions" + }, + { + "type": "object" + }, + { + "description": "Specifies actions to be taken, or operations that may be allowed, if the rule conditions are satisfied.", + "properties": { + "appSignOn": { + "$ref": "#/components/schemas/AccessPolicyRuleApplicationSignOn" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AccessPolicyRuleApplicationSignOn": { + "description": "Specifies the results when a user attempts to sign in", + "properties": { + "access": { + "$ref": "#/components/schemas/AccessPolicyRuleApplicationSignOnAccess" + }, + "keepMeSignedIn": { + "$ref": "#/components/schemas/KeepMeSignedIn" + }, + "verificationMethod": { + "$ref": "#/components/schemas/VerificationMethod" + } + }, + "type": "object" + }, + "AccessPolicyRuleApplicationSignOnAccess": { + "enum": [ + "ALLOW", + "DENY" + ], + "type": "string" + }, + "AccessPolicyRuleConditions": { + "allOf": [ + { + "type": "object" + }, + { + "description": "Specifies conditions that must be met during policy evaluation to apply the rule. All policy conditions, as well as conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule.", + "properties": { + "device": { + "$ref": "#/components/schemas/DeviceAccessPolicyRuleCondition" + }, + "elCondition": { + "$ref": "#/components/schemas/AccessPolicyRuleCustomCondition" + }, + "network": { + "$ref": "#/components/schemas/PolicyNetworkCondition" + }, + "people": { + "$ref": "#/components/schemas/PolicyPeopleCondition" + }, + "platform": { + "$ref": "#/components/schemas/PlatformPolicyRuleCondition" + }, + "riskScore": { + "$ref": "#/components/schemas/RiskScorePolicyRuleCondition" + }, + "userType": { + "$ref": "#/components/schemas/UserTypeCondition" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AccessPolicyRuleCustomCondition": { + "description": "Specifies [Okta Expression Language](https://developer.okta.com/docs/reference/okta-expression-language-in-identity-engine/) expressions", + "properties": { + "condition": { + "description": "expression to match", + "type": "string" + } + }, + "required": [ + "condition" + ] + }, + "AccessTokenKeyEncryptionAlgorithm": { + "description": "The algorithm for encrypting access tokens issued by this authorization server. If this is requested, the response is signed, and then encrypted. The result is a nested JWT. The default, if omitted, is that no encryption is performed.", + "enum": [ + "RSA-OAEP-256", + "RSA-OAEP-384", + "RSA-OAEP-512" + ], + "type": "string", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "AccountLinkedEnrollment": { + "description": "An enrollment linked to an OS account", + "properties": { + "_embedded": { + "$ref": "#/components/schemas/AccountLinkedEnrollmentEmbedded" + }, + "created": { + "description": "Timestamp when the enrollment was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique identifier of the enrollment", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the enrollment was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/AccountLinkedEnrollmentProfile" + }, + "status": { + "description": "Status of the enrollment. Possible values depend on `type`. For `platform_sso` - `ACTIVE`, `SUSPENDED`, `REVOKED`. For `desktop_mfa` - `ACTIVE`, `DELETED`.", + "enum": [ + "ACTIVE", + "SUSPENDED", + "REVOKED", + "DELETED" + ], + "type": "string" + }, + "type": { + "description": "Type of the linked enrollment", + "enum": [ + "platform_sso", + "desktop_mfa" + ], + "type": "string" + } + }, + "type": "object" + }, + "AccountLinkedEnrollmentEmbedded": { + "description": "Embedded data for a linked enrollment", + "properties": { + "lastAuthenticatedOn": { + "description": "Timestamp of the last successful authentication", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "AccountLinkedEnrollmentProfile": { + "description": "Profile details for a linked enrollment", + "properties": { + "authenticationMethod": { + "description": "Authentication method used for the enrollment", + "enum": [ + "PASSWORD", + "SECURE_ENCLAVE" + ], + "type": "string" + } + }, + "type": "object" + }, + "AcsEndpoint": { + "description": "An array of ACS endpoints. You can configure a maximum of 100 endpoints.", + "properties": { + "index": { + "description": "Index of the URL in the array of ACS endpoints", + "example": 0, + "type": "integer" + }, + "url": { + "description": "URL of the ACS", + "example": "https://www.example.com/sso/saml", + "maxLength": 1024, + "type": "string" + } + }, + "required": [ + "url", + "index" + ], + "type": "object" + }, + "ActionProvider": { + "discriminator": { + "mapping": { + "WORKFLOWS": "#/components/schemas/WorkflowActionProvider" + }, + "propertyName": "type" + }, + "properties": { + "externalId": { + "description": "The unique identifier of the action flow in the provider system", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ActionProviderPayloadType" + } + }, + "required": [ + "type", + "externalId" + ], + "type": "object" + }, + "ActionProviderPayloadType": { + "description": "Type of action provider", + "enum": [ + "WORKFLOWS" + ], + "type": "string" + }, + "ActionProviderType": { + "enum": [ + "workflows" + ], + "type": "string" + }, + "Actions": { + "description": "Action to apply to a user", + "properties": { + "assignUserToRealm": { + "$ref": "#/components/schemas/AssignUserToRealm" + } + }, + "type": "object" + }, + "ActiveDirectoryGroupScope": { + "description": "The scope of the group in Active Directory", + "enum": [ + "DOMAIN_LOCAL", + "GLOBAL", + "UNIVERSAL" + ], + "type": "string" + }, + "ActiveDirectoryGroupType": { + "description": "The type of the group in Active Directory", + "enum": [ + "DISTRIBUTION", + "SECURITY" + ], + "type": "string" + }, + "AdminConsoleSettings": { + "description": "Settings specific to the Okta Admin Console", + "properties": { + "sessionIdleTimeoutMinutes": { + "default": 15, + "description": "The maximum idle time before the Okta Admin Console session expires. Must be no more than 12 hours.", + "maximum": 720, + "minimum": 5, + "type": "integer" + }, + "sessionMaxLifetimeMinutes": { + "default": 720, + "description": "The absolute maximum session lifetime of the Okta Admin Console. Must be no more than 7 days.", + "maximum": 10080, + "minimum": 5, + "type": "integer" + } + }, + "title": "Okta Admin Console Settings", + "type": "object" + }, + "Agent": { + "description": "Agent details", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "id": { + "description": "Unique identifier for the agent that's generated during installation", + "example": "ajd3fxzltQKQ2VeLu5s6", + "readOnly": true, + "type": "string" + }, + "isHidden": { + "description": "Determines if an agent is hidden from the Admin Console", + "type": "boolean" + }, + "isLatestGAedVersion": { + "description": "Determines if the agent is on the latest generally available version", + "type": "boolean" + }, + "lastConnection": { + "description": "Unix timestamp in milliseconds when the agent last connected to Okta", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "Agent name", + "example": "WIN-region1A-dc", + "type": "string" + }, + "operationalStatus": { + "$ref": "#/components/schemas/OperationalStatus" + }, + "poolId": { + "description": "Pool ID", + "example": "0oa3eu7ekG8tjbD9J5s6", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/AgentType" + }, + "updateMessage": { + "description": "Status message of the agent", + "example": "Queued for update.", + "type": "string" + }, + "updateStatus": { + "$ref": "#/components/schemas/AgentUpdateInstanceStatus" + }, + "version": { + "description": "Agent version number", + "example": "3.19.0", + "type": "string" + } + }, + "type": "object" + }, + "AgentAction": { + "description": "Details about the Active Directory or LDAP group membership update", + "properties": { + "id": { + "description": "ID of the Active Directory or LDAP group to update", + "type": "string" + }, + "parameters": { + "$ref": "#/components/schemas/Parameters" + } + }, + "required": [ + "id", + "parameters" + ], + "type": "object" + }, + "AgentPool": { + "description": "An agent pool is a collection of agents that serve a common purpose. An agent pool has a unique ID within an org, and contains a collection of agents disjoint to every other agent pool, meaning that no two agent pools share an agent.", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "agents": { + "items": { + "$ref": "#/components/schemas/Agent" + }, + "type": "array" + }, + "disruptedAgents": { + "description": "Number of agents in the pool that are in a disrupted state", + "type": "integer" + }, + "id": { + "description": "Agent pool ID", + "readOnly": true, + "type": "string" + }, + "inactiveAgents": { + "description": "Number of agents in the pool that are in an inactive state", + "type": "integer" + }, + "name": { + "description": "Agent pool name", + "type": "string" + }, + "operationalStatus": { + "$ref": "#/components/schemas/OperationalStatus" + }, + "type": { + "$ref": "#/components/schemas/AgentType" + } + }, + "type": "object" + }, + "AgentPoolUpdate": { + "description": "Various information about agent auto-update configuration", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "agentType": { + "$ref": "#/components/schemas/AgentType" + }, + "agents": { + "items": { + "$ref": "#/components/schemas/Agent" + }, + "type": "array" + }, + "enabled": { + "description": "Indicates if auto-update is enabled for the agent pool", + "type": "boolean" + }, + "id": { + "description": "ID of the agent pool update", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the agent pool update", + "example": "region1A.dc", + "type": "string" + }, + "notifyAdmin": { + "description": "Indicates if the admin is notified about the update", + "type": "boolean" + }, + "reason": { + "description": "Reason for the update", + "example": "Update failed.", + "type": "string" + }, + "schedule": { + "$ref": "#/components/schemas/AutoUpdateSchedule" + }, + "sortOrder": { + "description": "Specifies the sort order", + "type": "integer" + }, + "status": { + "$ref": "#/components/schemas/AgentUpdateJobStatus" + }, + "targetVersion": { + "description": "The agent version to update to", + "example": "3.20.0", + "type": "string" + } + }, + "type": "object" + }, + "AgentPoolUpdateSettingRequest": { + "description": "Settings for auto-update", + "properties": { + "agentType": { + "$ref": "#/components/schemas/AgentType" + }, + "continueOnError": { + "description": "Continues the update even if some agents fail to update", + "type": "boolean" + }, + "latestVersion": { + "description": "Latest version of the agent", + "example": "3.20.0", + "type": "string" + }, + "minimalSupportedVersion": { + "description": "Minimal version of the agent", + "example": "3.19.0", + "type": "string" + }, + "poolId": { + "description": "ID of the agent pool that the settings apply to", + "example": "0oa3eu7ekG8tjbD9J5s6", + "readOnly": true, + "type": "string" + }, + "poolName": { + "description": "Pool name", + "example": "iwa.dc", + "type": "string" + }, + "releaseChannel": { + "$ref": "#/components/schemas/ReleaseChannel" + } + }, + "required": [ + "agentType" + ], + "type": "object" + }, + "AgentPoolUpdateSettingResponse": { + "description": "Settings for auto-update", + "properties": { + "agentType": { + "$ref": "#/components/schemas/AgentType" + }, + "continueOnError": { + "description": "Continues the update even if some agents fail to update", + "type": "boolean" + }, + "latestVersion": { + "description": "Latest version of the agent", + "example": "3.20.0", + "type": "string" + }, + "minimalSupportedVersion": { + "description": "Minimal version of the agent", + "example": "3.19.0", + "type": "string" + }, + "poolId": { + "description": "ID of the agent pool that the settings apply to", + "example": "0oa3eu7ekG8tjbD9J5s6", + "readOnly": true, + "type": "string" + }, + "poolName": { + "description": "Pool name", + "example": "iwa.dc", + "type": "string" + }, + "releaseChannel": { + "$ref": "#/components/schemas/ReleaseChannel" + } + }, + "type": "object" + }, + "AgentType": { + "description": "Agent types that are being monitored", + "enum": [ + "AD", + "IWA", + "LDAP", + "MFA", + "OPP", + "RUM", + "Radius" + ], + "type": "string" + }, + "AgentUpdateInstanceStatus": { + "description": "Status for one agent regarding the status to auto-update that agent", + "enum": [ + "Cancelled", + "Failed", + "InProgress", + "PendingCompletion", + "Scheduled", + "Success" + ], + "type": "string" + }, + "AgentUpdateJobStatus": { + "description": "Overall state for the auto-update job from the admin perspective", + "enum": [ + "Cancelled", + "Failed", + "InProgress", + "Paused", + "Scheduled", + "Success" + ], + "type": "string" + }, + "AllCustomAAGUIDResponseObject": { + "items": { + "$ref": "#/components/schemas/CustomAAGUIDResponseObject" + }, + "type": "array" + }, + "AllowedForEnum": { + "description": "The allowed types of uses for the authenticator", + "enum": [ + "any", + "none", + "recovery", + "sso" + ], + "type": "string" + }, + "AndroidDeviceTrust": { + "description": "Android Device Trust integration provider", + "properties": { + "deviceIntegrityLevel": { + "$ref": "#/components/schemas/DeviceIntegrity" + }, + "networkProxyDisabled": { + "description": "Indicates whether a device has a network proxy disabled", + "type": "boolean" + }, + "playProtectVerdict": { + "$ref": "#/components/schemas/PlayProtectVerdict" + }, + "requireMajorVersionUpdate": { + "description": "Indicates whether the device needs to be on the latest major version available to the device\n\n**Note:** This option requires an `osVersion.dynamicVersionRequirement` value to be supplied with the `osVersion.dynamicVersionRequirement.type` as either `MINIMUM` or `EXACT`.\n", + "type": "boolean" + }, + "screenLockComplexity": { + "$ref": "#/components/schemas/ScreenLockComplexity" + }, + "usbDebuggingDisabled": { + "description": "Indicates whether Android Debug Bridge (adb) over USB is disabled", + "type": "boolean" + }, + "wifiSecured": { + "description": "Indicates whether a device is on a password-protected Wi-Fi network", + "type": "boolean" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "ApiService": { + "properties": { + "authenticationMethod": { + "description": "Specifies the authentication method used by the API service application when requesting an access token
**Note:** Only the `client_secret_basic` method is supported", + "enum": [ + "client_secret_basic" + ], + "example": "client_secret_basic", + "type": "string" + }, + "scopes": { + "description": "A list of Okta OAuth 2.0 scopes required for the API service app to function", + "items": { + "$ref": "#/components/schemas/Scope" + }, + "type": "array" + }, + "setupInstructionsUri": { + "description": "The URL for the API service integration configuration document", + "example": "https://example.com/strawberry/help/apiServiceSetup", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "ApiServiceCapability": { + "description": "API Service capability configuration with embedded protocol details", + "properties": { + "capability": { + "description": "API Service capability identifier", + "enum": [ + "API_SERVICE" + ], + "type": "string" + }, + "supportedProtocols": { + "description": "List of supported protocols", + "items": { + "enum": [ + "OAUTH2" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "capability", + "supportedProtocols" + ], + "type": "object" + }, + "ApiToken": { + "description": "An API token for an Okta User. This token is NOT scoped any further and can be used for any API the user has permissions to call.", + "properties": { + "_link": { + "$ref": "#/components/schemas/LinksSelf" + }, + "clientName": { + "readOnly": true, + "type": "string" + }, + "created": { + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "expiresAt": { + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "type": "string" + }, + "network": { + "description": "The Network Condition of the API Token", + "properties": { + "connection": { + "description": "The connection type of the Network Condition", + "type": "string" + }, + "exclude": { + "description": "List of excluded IP network zones", + "items": { + "type": "string" + }, + "type": "array" + }, + "include": { + "description": "List of included IP network zones", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "tokenWindow": { + "$ref": "#/components/schemas/TimeDuration" + }, + "userId": { + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "API Token", + "type": "object" + }, + "ApiTokenUpdate": { + "description": "An API Token Update Object for an Okta user. This token is NOT scoped any further and can be used for any API that the user has permissions to call.", + "properties": { + "clientName": { + "description": "The client name associated with the API Token", + "readOnly": true, + "type": "string" + }, + "created": { + "description": "The creation date of the API Token", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name associated with the API Token", + "type": "string" + }, + "network": { + "description": "The Network Condition of the API Token", + "properties": { + "connection": { + "description": "The connection type of the Network Condition", + "type": "string" + }, + "exclude": { + "description": "List of excluded IP network zones", + "items": { + "type": "string" + }, + "type": "array" + }, + "include": { + "description": "List of included IP network zones", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "userId": { + "description": "The userId of the user who created the API Token", + "type": "string" + } + }, + "title": "API Token Update", + "type": "object" + }, + "AppAccountContainerDetails": { + "description": "Container details for resource type APP_ACCOUNT", + "properties": { + "_links": { + "$ref": "#/components/schemas/AppAccountContainerLink" + }, + "appName": { + "description": "The application name", + "example": "google", + "readOnly": true, + "type": "string" + }, + "containerId": { + "description": "The app ID associated with the privileged resource", + "example": "0oa103099SBEb3Z2b0g4", + "type": "string" + }, + "displayName": { + "description": "Human-readable name of the container that owns the privileged resource", + "example": "Google App1", + "readOnly": true, + "type": "string" + }, + "globalAppId": { + "description": "The application global ID", + "example": "964b82aa-85b4-5645-b790-83312c473480", + "readOnly": true, + "type": "string" + }, + "passwordPushSupported": { + "description": "Indicates if the application supports password push", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "provisioningEnabled": { + "description": "Indicates if provisioning is enabled for this application", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "status": { + "$ref": "#/components/schemas/AppInstanceContainerStatus" + } + }, + "required": [ + "containerId" + ], + "type": "object" + }, + "AppAccountContainerLink": { + "properties": { + "login": { + "$ref": "#/components/schemas/HrefObjectAppLink" + }, + "logo": { + "$ref": "#/components/schemas/HrefObjectLogoLink" + } + }, + "readOnly": true, + "type": "object" + }, + "AppAndInstanceConditionEvaluatorAppOrInstance": { + "properties": { + "id": { + "description": "ID of the app", + "readOnly": false, + "type": "string" + }, + "name": { + "description": "Name of the app type", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/AppAndInstanceType" + } + }, + "type": "object" + }, + "AppAndInstancePolicyRuleCondition": { + "description": "Specifies apps to include or exclude. If `include` is empty, then the condition is met for all apps.", + "properties": { + "exclude": { + "description": "The list of apps or app instances to exclude", + "items": { + "$ref": "#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance" + }, + "type": "array" + }, + "include": { + "description": "The list of apps or app instances to match on", + "items": { + "$ref": "#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance" + }, + "type": "array" + } + }, + "type": "object" + }, + "AppAndInstanceType": { + "description": "Type of app", + "enum": [ + "APP", + "APP_TYPE" + ], + "type": "string" + }, + "AppConfig": { + "description": "Additional app configuration for group push mappings. Currently only required for Active Directory.", + "discriminator": { + "mapping": { + "ACTIVE_DIRECTORY": "#/components/schemas/AppConfigActiveDirectory" + }, + "propertyName": "type" + }, + "properties": { + "type": { + "$ref": "#/components/schemas/AppConfigType", + "type": "string" + } + }, + "type": "object" + }, + "AppConfigActiveDirectory": { + "allOf": [ + { + "$ref": "#/components/schemas/AppConfig" + } + ], + "properties": { + "distinguishedName": { + "description": "The distinguished name of the group in Active Directory", + "type": "string" + }, + "groupScope": { + "$ref": "#/components/schemas/ActiveDirectoryGroupScope" + }, + "groupType": { + "$ref": "#/components/schemas/ActiveDirectoryGroupType" + }, + "samAccountName": { + "description": "The SAM account name of the group in Active Directory", + "type": "string" + } + }, + "required": [ + "distinguishedName", + "groupScope", + "groupType", + "samAccountName" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AppConfigType": { + "description": "The type of the app configuration", + "enum": [ + "ACTIVE_DIRECTORY" + ], + "type": "string" + }, + "AppConnectionUserProvisionJWKList": { + "properties": { + "keys": { + "items": { + "$ref": "#/components/schemas/JsonWebKey" + }, + "type": "array" + } + }, + "required": [ + "keys" + ] + }, + "AppConnectionUserProvisionJWKResponse": { + "properties": { + "jwks": { + "$ref": "#/components/schemas/AppConnectionUserProvisionJWKList" + } + }, + "required": [ + "jwks" + ] + }, + "AppCsrPkcs10": { + "description": "Base64URL-encoded CSR in DER format", + "format": "base64", + "type": "string" + }, + "AppCustomHrefObject": { + "properties": { + "hints": { + "description": "Describes allowed HTTP verbs for the `href`", + "properties": { + "allow": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "href": { + "description": "Link URI", + "type": "string" + }, + "title": { + "description": "Link name", + "type": "string" + }, + "type": { + "description": "The media type of the link. If omitted, it is implicitly `application/json`.", + "type": "string" + } + }, + "readOnly": true, + "required": [ + "href" + ], + "type": "object" + }, + "AppGroup": { + "properties": { + "externalId": { + "description": "The external ID of the app group whose members might be privileged app users", + "example": 18070146415, + "maxLength": 255, + "type": "string" + }, + "name": { + "description": "The name of the app group whose members might be privileged app users", + "example": "domainAdminsGroup", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "name", + "externalId" + ], + "type": "object" + }, + "AppInstanceContainerStatus": { + "description": "Current status of the application instance", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ], + "readOnly": true, + "type": "string" + }, + "AppInstancePolicyRuleCondition": { + "properties": { + "exclude": { + "items": { + "type": "string" + }, + "type": "array" + }, + "include": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AppInstanceProperty": { + "properties": { + "label": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "name", + "label" + ], + "type": "object" + }, + "AppProperties": { + "additionalProperties": { + "properties": { + "name": { + "description": "Name of the property", + "example": "baseUrl", + "type": "string" + }, + "value": { + "description": "Value of the property", + "example": "https://example.com", + "type": "string" + } + }, + "type": "object" + }, + "description": "App instance properties", + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "AppResourceHrefObject": { + "properties": { + "href": { + "description": "Link URI", + "example": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7", + "type": "string" + }, + "title": { + "description": "Link name", + "example": "My App", + "type": "string" + } + }, + "type": "object" + }, + "AppServiceAccount": { + "properties": { + "containerGlobalName": { + "description": "The key name of the app in the Okta Integration Network (OIN)", + "example": "salesforce", + "readOnly": true, + "type": "string" + }, + "containerInstanceName": { + "description": "The app instance label", + "example": "salesforce Prod 5", + "readOnly": true, + "type": "string" + }, + "containerOrn": { + "description": "The [ORN](/openapi/okta-management/guides/roles/#okta-resource-name-orn) of the relevant resource.\n\nUse the specific app ORN format (`orn:{partition}:idp:{yourOrgId}:apps:{appType}:{appId}`) to identify an Okta app instance in your org.", + "example": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:salesforce:0oa1gjh63g214q0Hq0g4", + "type": "string" + }, + "created": { + "description": "Timestamp when the app service account was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the app service account", + "example": "This is for accessing salesforce Prod-5", + "format": "regex", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "The UUID of the app service account", + "example": "a747a818-a4c4-4446-8a87-704216495a08", + "format": "regex", + "pattern": "(?i)^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the app service account was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The user-defined name for the app service account", + "example": "salesforce Prod-5 account", + "format": "regex", + "maxLength": 50, + "minLength": 1, + "pattern": "^[\\w\\-_. ]+$", + "type": "string" + }, + "ownerGroupIds": { + "description": "A list of IDs of the Okta groups who own the app service account", + "example": [ + "00g57qp78yZT2XBA40g7" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ownerUserIds": { + "description": "A list of IDs of the Okta users who own the app service account", + "example": [ + "00u11s48P9zGW8yqm0g5" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "password": { + "description": "The app service account password", + "format": "password", + "maxLength": 255, + "minLength": 1, + "type": "string", + "writeOnly": true + }, + "status": { + "$ref": "#/components/schemas/ServiceAccountStatus" + }, + "statusDetail": { + "$ref": "#/components/schemas/ServiceAccountStatusDetail" + }, + "username": { + "description": "The username that serves as the direct link to your managed app account. Ensure that this value precisely matches the identifier of the target app account.", + "example": "testuser-salesforce-5@example.com", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "containerOrn", + "username", + "password" + ], + "type": "object" + }, + "AppServiceAccountCredentials": { + "description": "Credentials for a SaaS app account", + "properties": { + "password": { + "description": "The password associated with the service account", + "format": "password", + "type": "string", + "writeOnly": true + }, + "username": { + "description": "The username associated with the service account", + "example": "testuser@example.com", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "username" + ], + "type": "object" + }, + "AppServiceAccountForUpdate": { + "properties": { + "description": { + "description": "The description of the app service account", + "example": "This is for accessing salesforce Prod-5", + "format": "regex", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The user-defined name for the app service account", + "example": "salesforce Prod-5 account", + "format": "regex", + "maxLength": 50, + "minLength": 1, + "pattern": "^[\\w\\-_. ]+$", + "type": "string" + }, + "ownerGroupIds": { + "description": "A list of IDs of the Okta groups who own the app service account", + "example": [ + "00g57qp78yZT2XBA40g7" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ownerUserIds": { + "description": "A list of IDs of the Okta users who own the app service account", + "example": [ + "00u11s48P9zGW8yqm0g5" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "AppUser": { + "description": "The app user object defines a user's app-specific profile and credentials for an app", + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "Embedded resources related to the application user using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "readOnly": true, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/LinksAppAndUser" + }, + "created": { + "allOf": [ + { + "$ref": "#/components/schemas/createdProperty" + }, + { + "example": "2014-06-24T15:27:59.000Z" + } + ] + }, + "credentials": { + "$ref": "#/components/schemas/AppUserCredentials" + }, + "externalId": { + "description": "The ID of the user in the target app that's linked to the Okta application user object.\nThis value is the native app-specific identifier or primary key for the user in the target app.\n\nThe `externalId` is set during import when the user is confirmed (reconciled) or during provisioning when the user is created in the target app.\nThis value isn't populated for SSO app assignments (for example, SAML or SWA) because it isn't synchronized with a target app.", + "example": "70c14cc17d3745e8a9f98d599a68329c", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the Okta user", + "example": "00u11z6WHMYCGPCHCRFK", + "type": "string" + }, + "lastSync": { + "description": "Timestamp of the last synchronization operation. This value is only updated for apps with the `IMPORT_PROFILE_UPDATES` or `PUSH PROFILE_UPDATES` feature.", + "example": "2014-06-24T15:27:59.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "allOf": [ + { + "$ref": "#/components/schemas/lastUpdatedProperty" + }, + { + "example": "2014-06-24T15:28:14.000Z" + } + ] + }, + "passwordChanged": { + "description": "Timestamp when the application user password was last changed", + "example": "2014-06-24T15:27:59.000Z", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/AppUserProfile" + }, + "scope": { + "description": "Indicates if the assignment is direct (`USER`) or by group membership (`GROUP`). If not specified, Okta tries to determine the scope based on the assignment type.", + "enum": [ + "USER", + "GROUP" + ], + "example": "USER", + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/AppUserStatus" + }, + "statusChanged": { + "description": "Timestamp when the application user status was last changed", + "example": "2014-06-24T15:28:14.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "syncState": { + "$ref": "#/components/schemas/AppUserSyncState" + } + }, + "title": "Application User", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AppUserAssignRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/AppUser" + }, + { + "required": [ + "id" + ] + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AppUserCredentials": { + "description": "Specifies a user's credentials for the app.\nThis parameter can be omitted for apps with [sign-on mode](/openapi/okta-management/management/application/getapplication#application/getapplication/t=response&c=200&path=&d=0/signonmode) (`signOnMode`) or [authentication schemes](/openapi/okta-management/management/application/getapplication#application/getapplication/t=response&c=200&path=&d=0/credentials/scheme) (`credentials.scheme`) that don't require credentials.\n", + "properties": { + "password": { + "$ref": "#/components/schemas/AppUserPasswordCredential" + }, + "userName": { + "description": "The user's username in the app\n\n> **Note:** The [userNameTemplate](/openapi/okta-management/management/tags/application/other/createapplication#application/createapplication/t=response&c=200&path=&d=0/credentials/usernametemplate) in the application object defines the default username generated when a user is assigned to that app.\n> If you attempt to assign a username or password to an app with an incompatible [authentication scheme](/openapi/okta-management/management/tags/application/other/createapplication#application/createapplication/t=response&c=200&path=&d=0/credentials/scheme), the following error is returned:\n> \"Credentials should not be set on this resource based on the scheme.\"", + "example": "testuser@example.com", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "AppUserCredentialsRequestPayload": { + "description": "Updates the assigned user credentials", + "properties": { + "credentials": { + "$ref": "#/components/schemas/AppUserCredentials" + } + }, + "title": "Credentials", + "type": "object" + }, + "AppUserPasswordCredential": { + "description": "The user's password. This is a write-only property. An empty `password` object is returned to indicate that a password value exists.", + "properties": { + "value": { + "description": "Password value", + "format": "password", + "type": "string", + "writeOnly": true + } + }, + "type": "object" + }, + "AppUserProfile": { + "additionalProperties": true, + "description": "Specifies the default and custom profile properties for a user.\nProperties that are visible in the Admin Console for an app assignment can also be assigned through the API.\nSome properties are reference properties that are imported from the target app and can't be configured.\nSee [profile](/openapi/okta-management/management/user/getuser#user/getuser/t=response&c=200&path=profile).\n", + "type": "object" + }, + "AppUserProfileRequestPayload": { + "description": "Updates the assigned user profile\n> **Note:** The Okta API currently doesn't support entity tags for conditional updates. As long as you're the only user updating the the user profile, Okta recommends you fetch the most recent profile with [Retrieve an Application User](/openapi/okta-management/management/applicationusers#tag/ApplicationUsers/operation/getApplicationUser), apply your profile update, and then `POST` back the updated profile.", + "properties": { + "profile": { + "$ref": "#/components/schemas/AppUserProfile" + } + }, + "title": "Profile", + "type": "object" + }, + "AppUserStatus": { + "description": "Status of an application user", + "enum": [ + "ACTIVE", + "APPROVED", + "DEPROVISIONED", + "IMPLICIT", + "IMPORTED", + "INACTIVE", + "MATCHED", + "PENDING", + "PROVISIONED", + "REVOKED", + "STAGED", + "SUSPENDED", + "UNASSIGNED" + ], + "example": "ACTIVE", + "readOnly": true, + "type": "string", + "x-enumDescriptions": { + "ACTIVE": "The application user is provisioned and is enabled to use the app. This status also occurs if the app has the `IMPORT_PROFILE_UPDATES` feature enabled and user import is confirmed, or if the app doesn't have provisioning enabled.", + "APPROVED": "The application user was created but not provisioned. This status can occur when manual provisioning acknowledgment is required.", + "DEPROVISIONED": "The user was removed by the provisioning operation and the `externalId` property is unassigned.", + "IMPLICIT": "The application user is now migrated to use implicit app assignment.", + "IMPORTED": "The application user is created based on imported data.", + "INACTIVE": "The application user is provisioned, but isn't enabled to use the app. Application users in this status can be reactivated with a password reset or permanently deleted.", + "MATCHED": "The imported user is matched with an existing Application User.", + "PENDING": "The application user is provisioned, but in a pending state and can't use the app. The status moves to `ACTIVE` when the application user is activated.", + "PROVISIONED": "The background provisioning operation completed and the application user was assigned an `externalId` successfully.", + "REVOKED": "The application user is disabled and waiting for deprovisioning acknowledgment. The application user can be deleted after deprovisioning acknowledgment.", + "STAGED": "The application user doesn't have `externalId` set and the background provisioning operation is queued. This applies to apps with the `PUSH_NEW_USERS` feature enabled.", + "SUSPENDED": "The application user is provisioned, but isn't enabled to use the app. Application users in this status can be reactivated without a password reset.", + "UNASSIGNED": "The application user was imported, but the user-matching operation was skipped." + } + }, + "AppUserSyncState": { + "description": "The synchronization state for the application user.\nThe application user's `syncState` depends on whether the `PROFILE_MASTERING` feature is enabled for the app.\n\n> **Note:** User provisioning currently must be configured through the Admin Console.", + "enum": [ + "DISABLED", + "ERROR", + "OUT_OF_SYNC", + "SYNCHRONIZED", + "SYNCING" + ], + "example": "SYNCHRONIZED", + "readOnly": true, + "type": "string", + "x-enumDescriptions": { + "DISABLED": "The provisioning feature is disabled for the app (`PROFILE_MASTERING` feature is disabled).", + "ERROR": "A background provisioning operation failed to update the user's profile in the target app. You must resolve the provisioning task in the Admin Console before you retry the operation.", + "OUT_OF_SYNC": "The Application User has changes that haven't been pushed to the target app.", + "SYNCHRONIZED": "All changes to the application user profile have successfully been synchronized with the target app.", + "SYNCING": "A background provisioning operation is running to update the user's profile in the target app." + } + }, + "AppUserUpdateRequest": { + "oneOf": [ + { + "$ref": "#/components/schemas/AppUserCredentialsRequestPayload" + }, + { + "$ref": "#/components/schemas/AppUserProfileRequestPayload" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AppleClientSigning": { + "description": "Information used to generate the secret JSON Web Token for the token requests to Apple IdP\n> **Note:** The `privateKey` property is required for a CREATE request. For an UPDATE request, it can be null and keeps the existing value if it's null. The `privateKey` property isn't returned for LIST and GET requests or UPDATE requests if it's null.", + "properties": { + "kid": { + "description": "The key ID that you obtained from Apple when you created the private key for the client", + "example": "test key id", + "maxLength": 1024, + "type": "string" + }, + "privateKey": { + "description": "The PKCS \\#8 encoded private key that you created for the client and downloaded from Apple", + "example": "MIGTAgEAMBM........Cb9PnybCnzDv+3cWSGWqpAIsQQZ", + "maxLength": 1024, + "type": "string" + }, + "teamId": { + "description": "The Team ID associated with your Apple developer account", + "example": "test team id", + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "Application": { + "discriminator": { + "mapping": { + "AUTO_LOGIN": "#/components/schemas/AutoLoginApplication", + "BASIC_AUTH": "#/components/schemas/BasicAuthApplication", + "BOOKMARK": "#/components/schemas/BookmarkApplication", + "BROWSER_PLUGIN": "#/components/schemas/BrowserPluginApplication", + "OPENID_CONNECT": "#/components/schemas/OpenIdConnectApplication", + "SAML_1_1": "#/components/schemas/Saml11Application", + "SAML_2_0": "#/components/schemas/SamlApplication", + "SECURE_PASSWORD_STORE": "#/components/schemas/SecurePasswordStoreApplication", + "WS_FEDERATION": "#/components/schemas/WsFederationApplication" + }, + "propertyName": "signOnMode" + }, + "properties": { + "_embedded": { + "description": "Embedded resources related to the app using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. If the `expand=user/{userId}` query parameter is specified, then the assigned [Application User](/openapi/okta-management/management/tags/applicationusers) is embedded.", + "properties": { + "user": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "The specified [Application User](/openapi/okta-management/management/tags/applicationusers) assigned to the app", + "type": "object" + } + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/ApplicationLinks" + }, + "accessibility": { + "$ref": "#/components/schemas/ApplicationAccessibility" + }, + "created": { + "description": "Timestamp when the application object was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "expressConfiguration": { + "$ref": "#/components/schemas/ApplicationExpressConfiguration" + }, + "features": { + "description": "Enabled app features\n> **Note:** See [Application Features](/openapi/okta-management/management/tags/applicationfeatures/) for app provisioning features.\n", + "items": { + "enum": [ + "GROUP_PUSH", + "IMPORT_NEW_USERS", + "IMPORT_PROFILE_UPDATES", + "IMPORT_USER_SCHEMA", + "PROFILE_MASTERING", + "PUSH_NEW_USERS", + "PUSH_PASSWORD_UPDATES", + "PUSH_PROFILE_UPDATES", + "PUSH_USER_DEACTIVATION", + "REACTIVATE_USERS", + "OUTBOUND_DEL_AUTH", + "DESKTOP_SSO", + "FEDERATED_PROFILE", + "SUPPRESS_ACTIVATION_EMAIL", + "PUSH_PENDING_USERS", + "MFA", + "UPDATE_EXISTING_USERNAME", + "EXCLUDE_USERNAME_UPDATE_ON_PROFILE_PUSH", + "EXCHANGE_ACTIVE_SYNC", + "IMPORT_SYNC", + "IMPORT_SYNC_CONTACTS", + "DEVICE_COMPLIANCE", + "VPN_CONFIG", + "IMPORT_SCHEMA_ENUM_VALUES", + "SCIM_PROVISIONING", + "DEVICE_FILTER_IN_SIGN_ON_RULES", + "PROFILE_TEMPLATE_UPGRADE", + "DEFAULT_PUSH_STATUS_TO_PUSH", + "REAL_TIME_SYNC", + "SSO", + "AUTHN_CONTEXT", + "JIT_PROVISIONING", + "GROUP_SYNC", + "OPP_SCIM_INCREMENTAL_IMPORTS", + "IN_MEMORY_APP_USER", + "LOG_STREAMING", + "OAUTH_INTEGRATION", + "IDP", + "PUSH_NEW_USERS_WITHOUT_PASSWORD", + "SKYHOOK_SERVICE", + "ENTITLEMENT_MANAGEMENT", + "PUSH_NEW_USERS_WITH_HASHED_PASSWORD" + ], + "type": "string", + "x-enumDescriptions": { + "AUTHN_CONTEXT": "Apps support establishing an authentication context based on claims from an IdP", + "DEFAULT_PUSH_STATUS_TO_PUSH": "App defaults Push status to `PUSH`. This feature is for apps, such as SharePoint, that want to receive App User profile updates even though they didn't implement traditional PUSH_PROFILE_UPDATES in the client API.", + "DESKTOP_SSO": "Okta user authentication requests are handled by desktop SSO negotiation (if possible)", + "DEVICE_COMPLIANCE": "Apps support device compliance rules", + "DEVICE_FILTER_IN_SIGN_ON_RULES": "App supports filtering by client type in app sign-on rules", + "ENTITLEMENT_MANAGEMENT": "Marker to showcase which OIN apps are entitlement enabled", + "EXCHANGE_ACTIVE_SYNC": "App supports synchronizing credentials with OMM enrolled devices", + "EXCLUDE_USERNAME_UPDATE_ON_PROFILE_PUSH": "Exclude username update during profile push", + "FEDERATED_PROFILE": "App user profiles are synchronized at sign-in and profile-view instances instead of during bulk imports", + "GROUP_PUSH": "Creates or links a group in the app when a mapping is defined for a group in Okta. Okta is the source for group memberships and all group members in Okta who are also assigned to the app are synced as group members to the app.", + "GROUP_SYNC": "Apps support syncing group information based on claims from an IdP", + "IDP": "Apps support IdP functionalities", + "IMPORT_NEW_USERS": "Creates or links a user in Okta to a user from the app", + "IMPORT_PROFILE_UPDATES": "Updates a linked user's app profile during manual or scheduled imports", + "IMPORT_SCHEMA_ENUM_VALUES": "App supports downloading schema enum values. You can download custom objects and integrating them with UD without being tied to the type metadata system.", + "IMPORT_SYNC": "Synchronize import events", + "IMPORT_SYNC_CONTACTS": "Synchronize contacts", + "IMPORT_USER_SCHEMA": "Discovers the profile schema for a user from the app automatically", + "IN_MEMORY_APP_USER": "Apps support in-memory app users. This feature is used as an alternative to Implicit App Assignment for a non-persisted app user.", + "JIT_PROVISIONING": "Apps support provisioning a user based on claims from an IdP", + "LOG_STREAMING": "Apps support log streaming", + "MFA": "App can verify credentials as a second factor", + "OAUTH_INTEGRATION": "App is an OAuth 2.0 integration", + "OPP_SCIM_INCREMENTAL_IMPORTS": "Apps support incremental imports. Used for SCIM app instances", + "OUTBOUND_DEL_AUTH": "Okta user authentication requests are delegated to a third-party app", + "PROFILE_MASTERING": "Designates the app as the identity lifecycle and profile attribute authority for linked users. The user's profile in Okta is read-only.", + "PROFILE_TEMPLATE_UPGRADE": "App supports profile template upgrades. This is primarily to help roll out the profile template upgrade feature for individual apps", + "PUSH_NEW_USERS": "Creates or links a user account in the app when assigning the app to a user in Okta", + "PUSH_NEW_USERS_WITHOUT_PASSWORD": "Don't send generated password for new users", + "PUSH_NEW_USERS_WITH_HASHED_PASSWORD": "Send hashed password for new users. This feature is only used for CIS to CIC migration.", + "PUSH_PASSWORD_UPDATES": "Updates the user's app password when their password changes in Okta", + "PUSH_PENDING_USERS": "Users are in PENDING state in Okta and are created but not active in the sourced app user", + "PUSH_PROFILE_UPDATES": "Updates a user's profile in the app when the user's profile changes in Okta (the profile source)", + "PUSH_USER_DEACTIVATION": "Deactivates a user's account in the app when unassigned from the app in Okta or deactivated", + "REACTIVATE_USERS": "Reactivates an existing inactive user when provisioning a user to the app", + "REAL_TIME_SYNC": "Apps support real-time synchronization", + "SCIM_PROVISIONING": "App supports generic SCIM client provisioning and can leverage SCIM standard for provisioning and push custom attributes to a third-party app", + "SKYHOOK_SERVICE": "Use the Skyhook microservice for LCM operations", + "SSO": "Apps support establishing a subject based on claims from an IdP", + "SUPPRESS_ACTIVATION_EMAIL": "Activation emails aren't sent to users sourced by AD and orgs with DelAuth enabled", + "UPDATE_EXISTING_USERNAME": "App can update the user name for existing users", + "VPN_CONFIG": "App supports pushing VPN configuration to OMM enrolled devices" + } + }, + "readOnly": true, + "type": "array" + }, + "id": { + "description": "Unique ID for the app instance", + "readOnly": true, + "type": "string" + }, + "label": { + "$ref": "#/components/schemas/ApplicationLabel" + }, + "lastUpdated": { + "description": "Timestamp when the application object was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "licensing": { + "$ref": "#/components/schemas/ApplicationLicensing" + }, + "orn": { + "description": "The Okta resource name (ORN) for the current app instance", + "readOnly": true, + "type": "string" + }, + "profile": { + "additionalProperties": true, + "description": "Contains any valid JSON schema for specifying properties that can be referenced from a request (only available to OAuth 2.0 client apps).\nFor example, add an app manager contact email address or define an allowlist of groups that you can then reference using the Okta Expression Language `getFilteredGroups` function.\n\n> **Notes:**\n> * `profile` isn't encrypted, so don't store sensitive data in it.\n> * `profile` doesn't limit the level of nesting in the JSON schema you created, but there is a practical size limit. Okta recommends a JSON schema size of 1 MB or less for best performance.", + "type": "object" + }, + "signOnMode": { + "$ref": "#/components/schemas/ApplicationSignOnMode" + }, + "status": { + "$ref": "#/components/schemas/ApplicationLifecycleStatus" + }, + "universalLogout": { + "$ref": "#/components/schemas/ApplicationUniversalLogout" + }, + "visibility": { + "$ref": "#/components/schemas/ApplicationVisibility" + } + }, + "required": [ + "signOnMode", + "label" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ApplicationAccessibility": { + "description": "Specifies access settings for the app", + "properties": { + "errorRedirectUrl": { + "description": "Custom error page URL for the app", + "type": "string" + }, + "loginRedirectUrl": { + "description": "Custom login page URL for the app\n> **Note:** The `loginRedirectUrl` property is deprecated in Identity Engine. This property is used with the custom app login feature. Orgs that actively use this feature can continue to do so. See [Okta-hosted sign-in (redirect authentication)](https://developer.okta.com/docs/guides/redirect-authentication/) or [configure IdP routing rules](https://help.okta.com/okta_help.htm?type=oie&id=ext-cfg-routing-rules) to redirect users to the appropriate sign-in app for orgs that don't use the custom app login feature.", + "type": "string" + }, + "selfService": { + "description": "Represents whether the app can be self-assignable by users", + "type": "boolean" + } + }, + "type": "object" + }, + "ApplicationCapability": { + "description": "Capabilities supported by the app", + "enum": [ + "PROVISIONING", + "SSO", + "UNIVERSAL_LOGOUT" + ], + "type": "string" + }, + "ApplicationCredentials": { + "description": "Credentials for the specified `signOnMode`", + "properties": { + "signing": { + "$ref": "#/components/schemas/ApplicationCredentialsSigning" + }, + "userNameTemplate": { + "$ref": "#/components/schemas/ApplicationCredentialsUsernameTemplate" + } + }, + "type": "object" + }, + "ApplicationCredentialsOAuthClient": { + "properties": { + "autoKeyRotation": { + "default": true, + "description": "Requested key rotation mode", + "type": "boolean" + }, + "client_id": { + "description": "Unique identifier for the OAuth 2.0 client app\n\n> **Notes:**\n> * If you don't specify the `client_id`, this immutable property is populated with the [Application instance ID](/openapi/okta-management/management/application/replaceapplication#application/replaceapplication/t=response&c=200&path=&d=0/id).\n> * The `client_id` must consist of alphanumeric characters or the following special characters: `$-_.+!*'(),`.\n> * You can't use the reserved word `ALL_CLIENTS`.", + "maxLength": 100, + "minLength": 6, + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 client secret string (used for confidential clients)\n\n> **Notes:** If a `client_secret` isn't provided on creation, and the `token_endpoint_auth_method` requires one, Okta generates a random `client_secret` for the client app.\n> The `client_secret` is only shown when an OAuth 2.0 client app is created or updated (and only if the `token_endpoint_auth_method` requires a client secret).", + "maxLength": 100, + "minLength": 14, + "type": "string" + }, + "pkce_required": { + "default": true, + "description": "Requires Proof Key for Code Exchange (PKCE) for additional verification. If `token_endpoint_auth_method` is `none`, then `pkce_required` must be `true`. The default is `true` for browser and native app types.", + "type": "boolean" + }, + "token_endpoint_auth_method": { + "$ref": "#/components/schemas/OAuthEndpointAuthenticationMethod" + } + }, + "type": "object" + }, + "ApplicationCredentialsScheme": { + "description": "Apps with `BASIC_AUTH`, `BROWSER_PLUGIN`, or `SECURE_PASSWORD_STORE` sign-on modes have credentials vaulted by Okta and can be configured with the following schemes.\n", + "enum": [ + "ADMIN_SETS_CREDENTIALS", + "EDIT_PASSWORD_ONLY", + "EDIT_USERNAME_AND_PASSWORD", + "EXTERNAL_PASSWORD_SYNC", + "SHARED_USERNAME_AND_PASSWORD" + ], + "type": "string", + "x-enumDescriptions": { + "ADMIN_SETS_CREDENTIALS": "Admin sets username and password", + "EDIT_PASSWORD_ONLY": "Admin sets username, user sets password", + "EDIT_USERNAME_AND_PASSWORD": "User sets username and password", + "EXTERNAL_PASSWORD_SYNC": "Admin sets username, password is the same as user's Okta password", + "SHARED_USERNAME_AND_PASSWORD": "Users share a single username and password set by the admin" + } + }, + "ApplicationCredentialsSigning": { + "description": "App signing key properties\n> **Note:** Only apps with SAML_2_0, SAML_1_1, WS_FEDERATION, or OPENID_CONNECT `signOnMode` support the key rotation feature.\n", + "properties": { + "kid": { + "description": "Key identifier used for signing assertions\n> **Note:** Currently, only the X.509 JWK format is supported for apps with SAML_2_0 `signOnMode`.", + "type": "string" + }, + "lastRotated": { + "description": "Timestamp when the signing key was last rotated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "nextRotation": { + "description": "The scheduled time for the next signing key rotation", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "rotationMode": { + "description": "The mode of key rotation", + "type": "string" + }, + "use": { + "$ref": "#/components/schemas/ApplicationCredentialsSigningUse" + } + }, + "type": "object" + }, + "ApplicationCredentialsSigningUse": { + "description": "Specifies the intended use of the key", + "enum": [ + "sig" + ], + "type": "string" + }, + "ApplicationCredentialsUsernameTemplate": { + "description": "The template used to generate the username when the app is assigned through a group or directly to a user", + "properties": { + "pushStatus": { + "description": "Determines if the username is pushed to the app on updates for CUSTOM `type`", + "enum": [ + "PUSH", + "DONT_PUSH", + "NOT_CONFIGURED" + ], + "type": "string" + }, + "template": { + "default": "${source.login}", + "description": "Mapping expression used to generate usernames.\n\nThe following are supported mapping expressions that are used with the `BUILT_IN` template type:\n\n| Name | Template Expression |\n| ------------------------------- | ---------------------------------------------- |\n| AD Employee ID | `${source.employeeID}` |\n| AD SAM Account Name | `${source.samAccountName}` |\n| AD SAM Account Name (lowercase) | `${fn:toLowerCase(source.samAccountName)}` |\n| AD User Principal Name | `${source.userName}` |\n| AD User Principal Name prefix | `${fn:substringBefore(source.userName, \"@\")}` |\n| Email | `${source.email}` |\n| Email (lowercase) | `${fn:toLowerCase(source.email)}` |\n| Email prefix | `${fn:substringBefore(source.email, \"@\")}` |\n| LDAP UID + custom suffix | `${source.userName}${instance.userSuffix}` |\n| Okta username | `${source.login}` |\n| Okta username prefix | `${fn:substringBefore(source.login, \"@\")}` |", + "type": "string" + }, + "type": { + "default": "BUILT_IN", + "description": "Type of mapping expression. Empty string is allowed.", + "enum": [ + "NONE", + "BUILT_IN", + "CUSTOM" + ], + "type": "string" + }, + "userSuffix": { + "description": "An optional suffix appended to usernames for `BUILT_IN` mapping expressions", + "type": "string" + } + }, + "type": "object" + }, + "ApplicationExpressConfiguration": { + "description": "

\nIndicates which Express Configuration capabilities the app supports and has enabled", + "properties": { + "enabledCapabilities": { + "description": "Capabilities currently enabled for the app", + "example": [ + "SSO" + ], + "items": { + "$ref": "#/components/schemas/ApplicationCapability" + }, + "type": "array" + }, + "supportedCapabilities": { + "description": "Capabilities supported by the app", + "example": [ + "SSO", + "PROVISIONING", + "UNIVERSAL_LOGOUT" + ], + "items": { + "$ref": "#/components/schemas/ApplicationCapability" + }, + "type": "array" + } + }, + "readOnly": true, + "type": "object" + }, + "ApplicationFeature": { + "description": "The Feature object is used to configure app feature settings.\n", + "discriminator": { + "mapping": { + "INBOUND_PROVISIONING": "#/components/schemas/InboundProvisioningApplicationFeature", + "USER_PROVISIONING": "#/components/schemas/UserProvisioningApplicationFeature" + }, + "propertyName": "name" + }, + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "readOnly": true + } + ] + }, + "description": { + "description": "Description of the feature", + "example": "Settings for provisioning users from Okta to a downstream app", + "readOnly": true, + "type": "string" + }, + "name": { + "$ref": "#/components/schemas/ApplicationFeatureType", + "readOnly": true + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/EnabledStatus" + }, + { + "default": "DISABLED" + }, + { + "example": "ENABLED" + }, + { + "readOnly": true + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ApplicationFeatureType": { + "description": "Key name of the feature\n\n| Feature name | Description |\n| --------- | ------------- |\n| USER_PROVISIONING | User profiles are pushed from Okta to the third-party app. Represents the **To App** provisioning feature setting in the Admin Console. |\n| INBOUND_PROVISIONING | User profiles are imported from the third-party app into Okta. This feature represents the **To Okta** provisioning feature setting in the Admin Console. |\n\nSelect the feature:\n", + "enum": [ + "USER_PROVISIONING", + "INBOUND_PROVISIONING" + ], + "example": "USER_PROVISIONING", + "type": "string" + }, + "ApplicationGroupAssignment": { + "description": "The Application Group object that defines a group of users' app-specific profile and credentials for an app", + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "Embedded resource related to the Application Group using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification.\nIf the `expand=group` query parameter is specified, then the [group](openapi/okta-management/management/group) object is embedded. \nIf the `expand=metadata` query parameter is specified, then the group assignment metadata is embedded.", + "readOnly": true, + "type": "object" + }, + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/HrefObjectAppLink" + }, + "group": { + "$ref": "#/components/schemas/HrefObjectGroupLink" + } + }, + "type": "object" + } + ] + }, + "id": { + "description": "ID of the [group](openapi/okta-management/management/group)", + "example": "00g4hb1HChfUriNgW0g4", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "allOf": [ + { + "$ref": "#/components/schemas/lastUpdatedProperty" + }, + { + "example": "2014-06-24T15:28:14.000Z" + } + ] + }, + "priority": { + "description": "Priority assigned to the group. If an app has more than one group assigned to the same user, then the group with the higher priority has its profile applied to the [application user](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/applicationusers).\nIf a priority value isn't specified, then the next highest priority is assigned by default.\nSee [Assign attribute group priority](https://help.okta.com/okta_help.htm?type=oie&id=ext-usgp-app-group-priority) and the [sample priority use case](https://help.okta.com/okta_help.htm?type=oie&id=ext-usgp-combine-values-use).", + "example": 99, + "type": "integer" + }, + "profile": { + "$ref": "#/components/schemas/GroupAssignmentProfile" + } + }, + "title": "Application Group Assignment", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ApplicationLabel": { + "description": "User-defined display name for app", + "type": "string" + }, + "ApplicationLayout": { + "properties": { + "elements": { + "items": { + "additionalProperties": {}, + "type": "object" + }, + "type": "array" + }, + "label": { + "type": "string" + }, + "options": { + "additionalProperties": {}, + "type": "object" + }, + "rule": { + "properties": { + "condition": { + "$ref": "#/components/schemas/ApplicationLayoutRuleCondition" + }, + "effect": { + "type": "string" + } + }, + "type": "object" + }, + "scope": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "ApplicationLayoutRuleCondition": { + "properties": { + "schema": { + "additionalProperties": {}, + "type": "object" + }, + "scope": { + "type": "string" + } + }, + "type": "object" + }, + "ApplicationLayouts": { + "properties": { + "_links": { + "properties": { + "general": { + "$ref": "#/components/schemas/ApplicationLayoutsLinksItem" + }, + "provisioning": { + "$ref": "#/components/schemas/ApplicationLayoutsLinksItem" + }, + "signOn": { + "$ref": "#/components/schemas/ApplicationLayoutsLinksItem" + } + }, + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, + "ApplicationLayoutsLinksItem": { + "items": { + "$ref": "#/components/schemas/HrefObject" + }, + "type": "array" + }, + "ApplicationLicensing": { + "description": "Licenses for the app", + "properties": { + "seatCount": { + "description": "Number of licenses purchased for the app", + "type": "integer" + } + }, + "type": "object" + }, + "ApplicationLifecycleStatus": { + "description": "App instance status", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ], + "readOnly": true, + "type": "string" + }, + "ApplicationLinks": { + "description": "Discoverable resources related to the app", + "properties": { + "accessPolicy": { + "$ref": "#/components/schemas/AccessPolicyLink" + }, + "activate": { + "$ref": "#/components/schemas/HrefObjectActivateLink" + }, + "appLinks": { + "description": "List of app link resources", + "items": { + "$ref": "#/components/schemas/HrefObject" + }, + "type": "array" + }, + "deactivate": { + "$ref": "#/components/schemas/HrefObjectDeactivateLink" + }, + "groups": { + "$ref": "#/components/schemas/GroupsLink" + }, + "help": { + "$ref": "#/components/schemas/HelpLink" + }, + "logo": { + "description": "List of app logo resources", + "items": { + "$ref": "#/components/schemas/HrefObject" + }, + "type": "array" + }, + "metadata": { + "$ref": "#/components/schemas/MetadataLink" + }, + "self": { + "$ref": "#/components/schemas/HrefObjectSelfLink" + }, + "users": { + "$ref": "#/components/schemas/UsersLink" + } + }, + "readOnly": true + }, + "ApplicationSettings": { + "description": "App settings", + "properties": { + "emOptInStatus": { + "description": "The entitlement management opt-in status for the app", + "enum": [ + "DISABLED", + "DISABLING", + "ENABLED", + "ENABLING", + "NONE" + ], + "readOnly": true, + "type": "string", + "x-enumDescriptions": { + "DISABLED": "Entitlement management for the app is disabled.", + "DISABLING": "Entitlement management for the app was enabled and is now being disabled.", + "ENABLED": "Entitlement management for the app is enabled.", + "ENABLING": "Entitlement management for the app was disabled and is now being enabled." + } + }, + "identityStoreId": { + "description": "Identifies an additional identity store app, if your app supports it. The `identityStoreId` value must be a valid identity store app ID. This identity store app must be created in the same org as your app.", + "type": "string" + }, + "implicitAssignment": { + "description": "Controls whether Okta automatically assigns users to the app based on the user's role or group membership.", + "type": "boolean" + }, + "inlineHookId": { + "description": "Identifier of an inline hook. Inline hooks are outbound calls from Okta to your own custom code, triggered at specific points in Okta process flows. They allow you to integrate custom functionality into those flows. See [Inline hooks](/openapi/okta-management/management/tags/inlinehook/).", + "type": "string" + }, + "notes": { + "$ref": "#/components/schemas/ApplicationSettingsNotes" + }, + "notifications": { + "$ref": "#/components/schemas/ApplicationSettingsNotifications" + } + }, + "type": "object" + }, + "ApplicationSettingsNotes": { + "description": "App notes visible to either the admin or end user", + "properties": { + "admin": { + "description": "An app message that's visible to admins", + "type": "string" + }, + "enduser": { + "description": "A message that's visible in the End-User Dashboard", + "type": "string" + } + }, + "type": "object" + }, + "ApplicationSettingsNotifications": { + "description": "Specifies notifications settings for the app", + "properties": { + "vpn": { + "$ref": "#/components/schemas/ApplicationSettingsNotificationsVpn" + } + }, + "type": "object" + }, + "ApplicationSettingsNotificationsVpn": { + "description": "Sends customizable messages with conditions to end users when a VPN connection is required", + "properties": { + "helpUrl": { + "description": "An optional URL to a help page to assist your end users in signing in to your company VPN", + "type": "string" + }, + "message": { + "description": "A VPN requirement message that's displayed to users", + "type": "string" + }, + "network": { + "$ref": "#/components/schemas/ApplicationSettingsNotificationsVpnNetwork" + } + }, + "required": [ + "network" + ], + "type": "object" + }, + "ApplicationSettingsNotificationsVpnNetwork": { + "description": "Defines network zones for VPN notification", + "properties": { + "connection": { + "description": "Specifies the VPN connection details required to access the app", + "enum": [ + "DISABLED", + "ANYWHERE", + "ON_NETWORK", + "OFF_NETWORK", + "ZONE" + ], + "type": "string", + "x-enumDescriptions": { + "ANYWHERE": "Displays VPN connection information regardless of the browser's client IP. The notification appears before the end user can access the app.", + "DISABLED": "The default state. Retain this setting for apps that don't require a VPN connection.", + "OFF_NETWORK": "Displays VPN connection information only when the browser's client IP doesn't match the configured Public Gateway IPs. The notification appears before the end user can access the app.", + "ON_NETWORK": "Displays VPN connection information only when a browser's client IP matches the configured Public Gateway IPs. The notification appears before the end user can access the app." + } + }, + "exclude": { + "description": "Defines the IP addresses or network ranges that are excluded from the VPN requirement", + "items": { + "type": "string" + }, + "type": "array" + }, + "include": { + "description": "Defines the IP addresses or network ranges that are required to use the VPN", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ApplicationSignOnMode": { + "description": "Authentication mode for the app\n\n| signOnMode | Description |\n| ---------- | ----------- |\n| AUTO_LOGIN | Secure Web Authentication (SWA) |\n| BASIC_AUTH | HTTP Basic Authentication with Okta Browser Plugin |\n| BOOKMARK | Just a bookmark (no-authentication) |\n| BROWSER_PLUGIN | Secure Web Authentication (SWA) with Okta Browser Plugin |\n| OPENID_CONNECT | Federated Authentication with OpenID Connect (OIDC) |\n| SAML_1_1 | Federated Authentication with SAML 1.1 WebSSO (not supported for custom apps) |\n| SAML_2_0 | Federated Authentication with SAML 2.0 WebSSO |\n| SECURE_PASSWORD_STORE | Secure Web Authentication (SWA) with POST (plugin not required) |\n| WS_FEDERATION | Federated Authentication with WS-Federation Passive Requestor Profile |\n\nSelect the `signOnMode` for your custom app:\n", + "enum": [ + "AUTO_LOGIN", + "BASIC_AUTH", + "BOOKMARK", + "BROWSER_PLUGIN", + "OPENID_CONNECT", + "SAML_1_1", + "SAML_2_0", + "SECURE_PASSWORD_STORE", + "WS_FEDERATION" + ], + "type": "string" + }, + "ApplicationType": { + "description": "The type of client application. Default value: `web`.", + "enum": [ + "browser", + "native", + "service", + "web" + ], + "type": "string" + }, + "ApplicationUniversalLogout": { + "description": "
\nUniversal Logout properties for the app. These properties are only returned and can't be updated.", + "example": "ACTIVE", + "properties": { + "identityStack": { + "description": "Indicates whether the app uses a shared identity stack that may cause the user to sign out of other apps by the same company", + "enum": [ + "SHARED", + "NOT_SHARED" + ], + "example": "SHARED", + "type": "string" + }, + "protocol": { + "description": "The protocol used for Universal Logout", + "enum": [ + "PROPRIETARY", + "GLOBAL_TOKEN_REVOCATION" + ], + "example": "PROPRIETARY", + "type": "string", + "x-enumDescriptions": { + "GLOBAL_TOKEN_REVOCATION": "Universal Logout is implemented with the [Global Token Revocation](https://datatracker.ietf.org/doc/draft-parecki-oauth-global-token-revocation/) protocol. See the [Global Token Revocation API](https://developer.okta.com/docs/api/openapi/okta-oauth/oauth/tag/GlobalTokenRevocation/).", + "PROPRIETARY": "Universal Logout is implemented with a proprietary method." + } + }, + "status": { + "description": "Universal Logout status for the app instance", + "enum": [ + "ENABLED", + "DISABLED", + "UNSUPPORTED" + ], + "example": "ENABLED", + "type": "string", + "x-enumDescriptions": { + "DISABLED": "Universal Logout is disabled", + "ENABLED": "Universal Logout is enabled. Users are signed out of the app instance when the Okta system or an admin initiates logout.", + "UNSUPPORTED": "The app doesn't support Universal Logout" + } + }, + "supportType": { + "description": "Indicates whether the app supports full or partial Universal Logout (UL).", + "enum": [ + "FULL", + "PARTIAL" + ], + "example": "FULL", + "type": "string", + "x-enumDescriptions": { + "FULL": "Full UL support (users are signed out of an app when the Okta system or an admin initiates logout)", + "PARTIAL": "This app's sign-out behavior can be different from other supported UL apps." + } + } + }, + "readOnly": true, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "ApplicationVisibility": { + "description": "Specifies visibility settings for the app", + "properties": { + "appLinks": { + "additionalProperties": { + "type": "boolean" + }, + "description": "Links or icons that appear on the End-User Dashboard if they're set to `true`.", + "type": "object" + }, + "autoLaunch": { + "description": "Automatically signs in to the app when user signs into Okta", + "type": "boolean" + }, + "autoSubmitToolbar": { + "description": "Automatically sign in when user lands on the sign-in page", + "type": "boolean" + }, + "hide": { + "$ref": "#/components/schemas/ApplicationVisibilityHide" + } + }, + "type": "object" + }, + "ApplicationVisibilityHide": { + "description": "Hides the app for specific end-user apps", + "properties": { + "iOS": { + "default": false, + "description": "Okta Mobile for iOS or Android (pre-dates Android)", + "example": false, + "type": "boolean" + }, + "web": { + "default": false, + "description": "Okta End-User Dashboard on a web browser", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "AssignGroupOwnerRequestBody": { + "properties": { + "id": { + "description": "The `id` of the group owner", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/GroupOwnerType" + } + }, + "type": "object" + }, + "AssignRoleRequest": { + "properties": { + "type": { + "$ref": "#/components/schemas/RoleType" + } + }, + "type": "object" + }, + "AssignUserToRealm": { + "description": "Action that assigns a user to a realm", + "properties": { + "realmId": { + "description": "ID of the realm", + "type": "string" + } + }, + "type": "object" + }, + "AssignedAppLink": { + "properties": { + "appAssignmentId": { + "readOnly": true, + "type": "string" + }, + "appInstanceId": { + "readOnly": true, + "type": "string" + }, + "appName": { + "readOnly": true, + "type": "string" + }, + "credentialsSetup": { + "readOnly": true, + "type": "boolean" + }, + "hidden": { + "readOnly": true, + "type": "boolean" + }, + "id": { + "readOnly": true, + "type": "string" + }, + "label": { + "readOnly": true, + "type": "string" + }, + "linkUrl": { + "readOnly": true, + "type": "string" + }, + "logoUrl": { + "readOnly": true, + "type": "string" + }, + "sortOrder": { + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "AssociatedServerMediated": { + "properties": { + "trusted": { + "description": "A list of the authorization server IDs", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AssuranceMethod": { + "allOf": [ + { + "$ref": "#/components/schemas/VerificationMethod" + }, + { + "properties": { + "constraints": { + "description": "Specifies constraints for the authenticator. Constraints are logically evaluated such that only one constraint object needs to be satisfied. But, within a constraint object, each constraint property must be satisfied.", + "items": { + "$ref": "#/components/schemas/AccessPolicyConstraints" + }, + "type": "array" + }, + "factorMode": { + "$ref": "#/components/schemas/AssuranceMethodFactorMode" + }, + "inactivityPeriod": { + "description": "The inactivity duration after which the user must re-authenticate. Use the ISO 8601 period format (for example, PT2H).", + "type": "string" + }, + "reauthenticateIn": { + "description": "The duration after which the user must re-authenticate, regardless of user activity. Keep in mind that the re-authentication intervals for constraints take precedent over this value. Use the ISO 8601 period format for recurring time intervals (for example, PT2H, PT0S, PT43800H, and so on).", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "AssuranceMethodFactorMode": { + "enum": [ + "1FA", + "2FA" + ], + "type": "string" + }, + "AttackProtectionAuthenticatorSettings": { + "properties": { + "verifyKnowledgeSecondWhen2faRequired": { + "default": false, + "description": "If true, requires users to verify a possession factor before verifying a knowledge factor when the assurance requires two-factor authentication (2FA).", + "type": "boolean" + } + }, + "type": "object" + }, + "AttestationRootCertificatesRequest": { + "description": "Contains the certificate and information about it", + "items": { + "properties": { + "x5c": { + "description": "X.509 certificate chain", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "AttestationRootCertificatesResponse": { + "items": { + "properties": { + "exp": { + "description": "Expiry date of certificate", + "type": "string" + }, + "iss": { + "description": "Issuer of certificate", + "type": "string" + }, + "x5c": { + "description": "X.509 certificate chain", + "type": "string" + }, + "x5t#S256": { + "description": "SHA-256 hash (thumbprint) of the X.509 certificate", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "AuthServerLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "claims": { + "allOf": [ + { + "description": "Link to the authorization server claims" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + }, + "deactivate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObjectDeactivateLink" + } + ] + }, + "metadata": { + "description": "Link to the authorization server metadata", + "items": { + "$ref": "#/components/schemas/HrefObject" + }, + "type": "array" + }, + "policies": { + "allOf": [ + { + "description": "Link to the authorization server policies" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + }, + "rotateKey": { + "allOf": [ + { + "description": "Link to the authorization server key rotation" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + }, + "scopes": { + "allOf": [ + { + "description": "Link to the authorization server scopes" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthSettings": { + "properties": { + "authType": { + "$ref": "#/components/schemas/AuthType" + }, + "customSettings": { + "$ref": "#/components/schemas/CustomAuthSettings" + }, + "oAuth2Settings": { + "$ref": "#/components/schemas/OAuth2Settings" + } + }, + "required": [ + "authType" + ], + "type": "object" + }, + "AuthType": { + "enum": [ + "BASIC", + "CUSTOM", + "OAUTH2", + "SCIM_BEARER", + "SCIM_HEADER" + ], + "type": "string" + }, + "AuthenticationMethod": { + "properties": { + "hardwareProtection": { + "default": "OPTIONAL", + "description": "Indicates if any secrets or private keys used during authentication must be hardware protected and not exportable. This property is only set for `POSSESSION` constraints.", + "enum": [ + "OPTIONAL", + "REQUIRED" + ], + "type": "string" + }, + "id": { + "description": "An ID that identifies the authenticator", + "type": "string" + }, + "key": { + "description": "A label that identifies the authenticator", + "type": "string" + }, + "method": { + "description": "Specifies the method used for the authenticator", + "type": "string" + }, + "phishingResistant": { + "default": "OPTIONAL", + "description": "Indicates if phishing-resistant Factors are required. This property is only set for `POSSESSION` constraints", + "enum": [ + "OPTIONAL", + "REQUIRED" + ], + "type": "string" + }, + "userVerification": { + "default": "OPTIONAL", + "description": "Indicates if a user is required to be verified with a verification method.", + "enum": [ + "OPTIONAL", + "REQUIRED" + ], + "type": "string" + }, + "userVerificationMethods": { + "description": "Indicates which methods can be used for user verification. `userVerificationMethods` can only be used when `userVerification` is `REQUIRED`. `BIOMETRICS` is currently the only supported method.", + "items": { + "enum": [ + "BIOMETRICS", + "PIN" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "key", + "method" + ], + "type": "object" + }, + "AuthenticationMethodChain": { + "properties": { + "authenticationMethods": { + "items": { + "$ref": "#/components/schemas/AuthenticationMethod" + }, + "type": "array" + }, + "next": { + "description": "The next steps of the authentication method chain. This is an array of `AuthenticationMethodChain`. Only supports one item in the array.", + "items": { + "type": "object" + }, + "type": "array" + }, + "reauthenticateIn": { + "description": "Specifies how often the user is prompted for authentication using duration format for the time period.\nFor example, `PT2H30M` for two and a half hours. This parameter can't be set at the same time as the `reauthenticateIn` property on the `verificationMethod`.", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticationMethodChainMethod": { + "allOf": [ + { + "$ref": "#/components/schemas/VerificationMethod" + }, + { + "properties": { + "chains": { + "description": "Authentication method chains. Only supports 5 items in the array. Each chain can support maximum 3 steps.", + "items": { + "$ref": "#/components/schemas/AuthenticationMethodChain" + }, + "type": "array" + }, + "reauthenticateIn": { + "description": "Specifies how often the user is prompted for authentication using duration format for the time period.\nFor example, `PT2H30M` for two and a half hours. Don't set this parameter if you're setting the `reauthenticateIn` parameter in `chains`.", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "AuthenticationMethodObject": { + "properties": { + "id": { + "description": "Authenticator ID", + "type": "string", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "key": { + "description": "A label that identifies the authenticator", + "type": "string" + }, + "method": { + "description": "Specifies the method used for the authenticator", + "type": "string" + } + }, + "required": [ + "key" + ], + "type": "object" + }, + "AuthenticationProvider": { + "description": "Specifies the authentication provider that validates the user's password credential. The user's current provider is managed by the **Delegated Authentication** settings for your org. The provider object is **read-only**.", + "properties": { + "name": { + "description": "The name of the authentication provider", + "example": "OKTA", + "readOnly": true, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/AuthenticationProviderType" + } + }, + "readOnly": true, + "type": "object" + }, + "AuthenticationProviderType": { + "description": "The type of authentication provider", + "enum": [ + "ACTIVE_DIRECTORY", + "FEDERATION", + "IMPORT", + "LDAP", + "OKTA", + "SOCIAL" + ], + "readOnly": true, + "type": "string", + "x-enumDescriptions": { + "ACTIVE_DIRECTORY": "Specifies the Microsoft Active Directory instance name as the `name` property", + "FEDERATION": "Specifies a federated identity provider (such as an SAML IdP) that validates the user's password credentials. Doesn't support a `password` or `recovery question` credential. The user must authenticate through a trusted identity provider.", + "IMPORT": "Specifies a hashed password that was imported from an external source", + "LDAP": "Specifies the LDAP directory instance name as the `name` property", + "OKTA": "Specifies the Okta identity provider", + "SOCIAL": "Specifies an OIDC or third-party social identity provider. Doesn't support a `password` or `recovery question` credential. The user must authenticate through a trusted identity provider." + } + }, + "AuthenticationProviderTypeWritable": { + "description": "The type of authentication provider", + "enum": [ + "ACTIVE_DIRECTORY", + "FEDERATION", + "IMPORT", + "LDAP", + "OKTA", + "SOCIAL" + ], + "type": "string", + "x-enumDescriptions": { + "ACTIVE_DIRECTORY": "Specifies a Microsoft Active Directory instance name as the `name` property", + "FEDERATION": "Specifies a federated identity provider (such as a SAML IdP) that validates the user's password credentials. Doesn't support a `password` or `recovery question` credential. The user must authenticate through a trusted identity provider.", + "IMPORT": "Specifies a hashed password that was imported from an external source", + "LDAP": "Specifies the LDAP directory instance name as the `name` property", + "OKTA": "Specifies the Okta identity provider", + "SOCIAL": "Specifies an OIDC or third-party social identity provider. Doesn't support a `password` or `recovery question` credential. The user must authenticate through a trusted identity provider." + } + }, + "AuthenticationProviderWritable": { + "description": "Specifies the authentication provider that validates the user password credential. The user's current provider is managed by the **Delegated Authentication** settings in your org. See [Create user with authentication provider](/openapi/okta-management/management/user/create-user-with-password-and-recovery-question#user/Create-user-with-authentication-provider).", + "properties": { + "name": { + "description": "The name of the authentication provider", + "example": "OKTA", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/AuthenticationProviderTypeWritable" + } + }, + "type": "object" + }, + "AuthenticatorBase": { + "discriminator": { + "mapping": { + "custom_app": "#/components/schemas/AuthenticatorKeyCustomApp", + "custom_otp": "#/components/schemas/AuthenticatorKeyCustomOtp", + "duo": "#/components/schemas/AuthenticatorKeyDuo", + "external_idp": "#/components/schemas/AuthenticatorKeyExternalIdp", + "google_otp": "#/components/schemas/AuthenticatorKeyGoogleOtp", + "okta_email": "#/components/schemas/AuthenticatorKeyEmail", + "okta_password": "#/components/schemas/AuthenticatorKeyPassword", + "okta_verify": "#/components/schemas/AuthenticatorKeyOktaVerify", + "onprem_mfa": "#/components/schemas/AuthenticatorKeyOnprem", + "phone_number": "#/components/schemas/AuthenticatorKeyPhone", + "security_key": "#/components/schemas/AuthenticatorKeySecurityKey", + "security_question": "#/components/schemas/AuthenticatorKeySecurityQuestion", + "smart_card_idp": "#/components/schemas/AuthenticatorKeySmartCard", + "symantec_vip": "#/components/schemas/AuthenticatorKeySymantecVip", + "tac": "#/components/schemas/AuthenticatorKeyTac", + "webauthn": "#/components/schemas/AuthenticatorKeyWebauthn", + "yubikey_token": "#/components/schemas/AuthenticatorKeyYubikey" + }, + "propertyName": "key" + }, + "properties": { + "_links": { + "$ref": "#/components/schemas/AuthenticatorLinks", + "description": "Link relations for this object" + }, + "created": { + "description": "Timestamp when the authenticator was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the authenticator. This setting is only available for the `webauthn` authenticator type (Passkeys).", + "type": "string", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "id": { + "description": "A unique identifier for the authenticator", + "readOnly": true, + "type": "string" + }, + "key": { + "$ref": "#/components/schemas/AuthenticatorKeyEnum" + }, + "lastUpdated": { + "description": "Timestamp when the authenticator was last modified", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Display name of the authenticator", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "Status of the authenticator" + } + ] + }, + "type": { + "$ref": "#/components/schemas/AuthenticatorType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorEnrollment": { + "properties": { + "_links": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentLinks" + }, + "created": { + "description": "Timestamp when the authenticator enrollment was created", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The unique identifier of the authenticator enrollment", + "type": "string" + }, + "key": { + "description": "A human-readable string that identifies the authenticator", + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the authenticator enrollment was last updated", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The authenticator display name", + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/AuthenticatorProfile" + }, + "status": { + "description": "Status of the enrollment", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/AuthenticatorType" + } + }, + "type": "object" + }, + "AuthenticatorEnrollmentCreateRequest": { + "properties": { + "authenticatorId": { + "description": "Unique identifier of the `phone` authenticator", + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/AuthenticatorProfile" + } + }, + "required": [ + "authenticatorId", + "profile" + ], + "type": "object" + }, + "AuthenticatorEnrollmentCreateRequestTac": { + "properties": { + "authenticatorId": { + "description": "Unique identifier of the TAC authenticator", + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/AuthenticatorProfileTacRequest" + } + }, + "required": [ + "authenticatorId" + ], + "type": "object" + }, + "AuthenticatorEnrollmentLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "$ref": "#/components/schemas/LinksUserAuthenticators" + }, + { + "$ref": "#/components/schemas/LinksAuthenticator" + } + ], + "readOnly": true + }, + "AuthenticatorEnrollmentPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "conditions": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentPolicyConditions" + }, + "settings": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentPolicySettings" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorEnrollmentPolicyAuthenticatorSettings": { + "properties": { + "constraints": { + "description": "Constraints for the authenticator", + "minimum": 0, + "nullable": true, + "properties": { + "aaguidGroups": { + "description": "The list of Passkey (FIDO2 WebAuthn) authenticator groups allowed for enrollment. The authenticators in the group are based on FIDO Alliance Metadata Service that's identified by name or the Authenticator Attestation Global Unique Identifier ([AAGUID](https://support.yubico.com/hc/en-us/articles/360016648959-YubiKey-Hardware-FIDO2-AAGUIDs)) number.\nThese groups are defined in the [Passkey (FIDO2 WebAuthn) authenticator method settings](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Authenticator/#tag/Authenticator/operation/listAuthenticatorMethods).", + "items": { + "type": "string", + "uniqueItems": true + }, + "type": "array" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "enroll": { + "description": "Enrollment requirements for the authenticator", + "properties": { + "autoEnroll": { + "description": " Controls whether the email authenticator is automatically enrolled for users during sign-up, user account creation, or if the user's profile email address is changed or updated. \n\n* `true` or `null`: The email authenticator is auto-enrolled. This is the default behavior for the email authenticator in Identity Engine. \n* `false`: The email authenticator auto-enrollment is skipped. Users see email as an optional authenticator during enrollment and can choose to skip it. \n\n> **Note:** `autoEnroll` can only be set to `false` when [`self`](/openapi/okta-management/management/tags/policy/other/createpolicy#other/createpolicy/t=request&path=&d=1/settings/authenticators/enroll/self) is `OPTIONAL` or `NOT_ALLOWED`. This property is only available if the Email auto-enrollment and recovery control [self-service EA](/openapi/okta-management/guides/release-lifecycle/#early-access-ea) feature is enabled. ", + "nullable": true, + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "gracePeriod": { + "$ref": "#/components/schemas/EnrollmentPolicyAuthenticatorGracePeriod" + }, + "self": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentPolicyAuthenticatorStatus" + } + }, + "type": "object" + }, + "id": { + "description": "The authenticator ID for `custom_app`, `custom_otp` or `external_idp`. Use this property to select a specific `custom_app`, `custom_otp` or `external_idp` authenticator.", + "type": "string" + }, + "key": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentPolicyAuthenticatorType" + } + }, + "type": "object" + }, + "AuthenticatorEnrollmentPolicyAuthenticatorStatus": { + "default": "NOT_ALLOWED", + "description": "Requirements for the user-initiated enrollment", + "enum": [ + "NOT_ALLOWED", + "OPTIONAL", + "REQUIRED" + ], + "type": "string" + }, + "AuthenticatorEnrollmentPolicyAuthenticatorType": { + "description": "A label that identifies the authenticator", + "enum": [ + "custom_app", + "custom_otp", + "duo", + "external_idp", + "google_otp", + "okta_email", + "okta_password", + "okta_verify", + "onprem_mfa", + "phone_number", + "rsa_token", + "security_question", + "symantec_vip", + "webauthn", + "yubikey_token" + ], + "type": "string" + }, + "AuthenticatorEnrollmentPolicyConditions": { + "allOf": [ + { + "type": "object" + }, + { + "description": "Specifies the conditions that must be met during policy evaluation to apply the policy" + }, + { + "properties": { + "people": { + "description": "Identifies users and groups that are used together", + "properties": { + "groups": { + "description": "Specifies a set of groups whose users are to be included or excluded", + "properties": { + "include": { + "description": "Groups to be included", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorEnrollmentPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentPolicyRuleActions" + }, + "conditions": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentPolicyRuleConditions" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorEnrollmentPolicyRuleActionEnroll": { + "description": "Specifies when or if the user is prompted to enroll an authenticator\n> **Note:** The `CHALLENGE` and `LOGIN` options have identical behaviors in Identity Engine. `LOGIN` is primarily used in authenticator enrollment policies created in Classic Engine orgs.", + "properties": { + "self": { + "enum": [ + "CHALLENGE", + "LOGIN", + "NEVER", + "NEVER_INCLUDING_RECOVERY" + ], + "type": "string", + "x-enumDescription": { + "CHALLENGE": "The user is prompted to enroll the authenticator the next time they're challenged during sign-in", + "LOGIN": "The user is prompted to enroll the authenticator the next time they're challenged during sign-in. Used primarily in Classic Engine orgs.", + "NEVER": "The user isn't prompted to enroll the authenticator during sign-in. Authenticators that are enabled for legacy recovery are still available for enrollment during account recovery.", + "NEVER_INCLUDING_RECOVERY": "The user isn't prompted to enroll the authenticator during sign-in or account recovery" + } + } + }, + "type": "object" + }, + "AuthenticatorEnrollmentPolicyRuleActions": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRuleActions" + }, + { + "type": "object" + }, + { + "description": "Specifies actions to be taken, or operations that may be allowed, if the rule conditions are satisfied", + "properties": { + "enroll": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentPolicyRuleActionEnroll" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorEnrollmentPolicyRuleConditions": { + "description": "Specifies conditions that must be met during policy evaluation to apply the rule. All policy conditions and conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule.", + "properties": { + "app": { + "$ref": "#/components/schemas/AppAndInstancePolicyRuleCondition" + }, + "network": { + "$ref": "#/components/schemas/PolicyNetworkCondition" + }, + "people": { + "description": "Identifies users and groups that are used together", + "properties": { + "users": { + "description": "Specifies a set of users to be included or excluded", + "properties": { + "exclude": { + "description": "Users to be excluded", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorEnrollmentPolicySettings": { + "description": "Specifies the policy level settings\n\n> **Note:** In Identity Engine, the Multifactor (MFA) Enrollment policy name has changed to authenticator enrollment policy. The policy type of `MFA_ENROLL` remains unchanged. However, the `settings` data is updated for authenticators. Policy `settings` are included only for those authenticators that are enabled.", + "properties": { + "authenticators": { + "description": "List of authenticator policy settings\n\n For orgs with the Authenticator enrollment policy feature enabled, the new default authenticator enrollment policy created by Okta contains the `authenticators` property in the policy settings. Existing default authenticator enrollment policies from a migrated Classic Engine org remain unchanged. The policies still use the `factors` property in their settings. The `authenticators` parameter allows you to configure all available authenticators, including authentication and recovery. The `factors` parameter only allows you to configure multifactor authentication.\n", + "items": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentPolicyAuthenticatorSettings" + }, + "type": "array" + }, + "type": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentPolicySettingsType" + } + }, + "type": "object" + }, + "AuthenticatorEnrollmentPolicySettingsType": { + "default": "FACTORS", + "description": "Type of policy configuration object\n\n The `type` property in the policy `settings` is only applicable to the authenticator enrollment policy available in Identity Engine.\n", + "enum": [ + "AUTHENTICATORS", + "FACTORS" + ], + "type": "string" + }, + "AuthenticatorIdentity": { + "description": "Represents a particular authenticator serving as a constraint on a method", + "properties": { + "key": { + "type": "string" + } + }, + "type": "object" + }, + "AuthenticatorKeyCustomApp": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + }, + { + "properties": { + "agreeToTerms": { + "description": "A value of `true` indicates that the administrator accepts the [terms](https://www.okta.com/privacy-policy/) for creating a new authenticator. Okta requires that you accept the terms when creating a new `custom_app` authenticator. Other authenticators don't require this field.", + "type": "boolean" + }, + "provider": { + "properties": { + "configuration": { + "description": "The configuration of the provider", + "properties": { + "apns": { + "properties": { + "appBundleId": { + "description": "AppBundleId of the APNs (Apple Push Notification Service) [configurations](https://developer.okta.com/docs/reference/api/push-providers/)", + "type": "string" + }, + "debugAppBundleId": { + "description": "DebugAppBundleId of the APNs (Apple Push Notification Service) [configurations](https://developer.okta.com/docs/reference/api/push-providers/)", + "type": "string" + }, + "id": { + "description": "ID of the APNs (Apple Push Notification Service) [configurations](https://developer.okta.com/docs/reference/api/push-providers/)", + "type": "string" + } + }, + "type": "object" + }, + "fcm": { + "properties": { + "id": { + "description": "ID of the FCM (Firebase Cloud Messaging Service) [configurations](https://developer.okta.com/docs/reference/api/push-providers/)", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Provider type", + "enum": [ + "PUSH" + ], + "type": "string" + } + }, + "type": "object" + }, + "settings": { + "properties": { + "appInstanceId": { + "description": "The application instance ID. For custom_app, you need to create an OIDC native app using the [Apps API](https://developer.okta.com/docs/reference/api/apps/) with `Authorization Code` and `Refresh Token` grant types. You can leave both `Sign-in redirect URIs` and `Sign-out redirect URIs` as the default values.", + "type": "string" + }, + "userVerification": { + "$ref": "#/components/schemas/CustomAppUserVerificationEnum" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeyCustomOtp": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeyDuo": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + }, + { + "properties": { + "provider": { + "properties": { + "configuration": { + "properties": { + "host": { + "description": "The Duo Security API hostname", + "type": "string" + }, + "integrationKey": { + "description": "The Duo Security integration key", + "type": "string" + }, + "secretKey": { + "description": "The Duo Security secret key", + "type": "string" + }, + "userNameTemplate": { + "properties": { + "template": { + "description": "The Duo Security user template name", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Provider type", + "enum": [ + "DUO" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorKeyEmail": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + }, + { + "properties": { + "settings": { + "properties": { + "allowedFor": { + "$ref": "#/components/schemas/AllowedForEnum" + }, + "tokenLifetimeInMinutes": { + "default": 5, + "description": "Specifies the lifetime of an email token. Default value is 5 minutes.", + "type": "number" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorKeyEnum": { + "description": "A human-readable string that identifies the authenticator", + "enum": [ + "custom_app", + "duo", + "external_idp", + "google_otp", + "okta_email", + "okta_password", + "okta_verify", + "onprem_mfa", + "phone_number", + "security_key", + "security_question", + "smart_card_idp", + "symantec_vip", + "webauthn", + "yubikey_token", + "tac" + ], + "type": "string" + }, + "AuthenticatorKeyExternalIdp": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeyGoogleOtp": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeyOktaVerify": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + }, + { + "properties": { + "settings": { + "properties": { + "appInstanceId": { + "description": "The application instance ID", + "type": "string" + }, + "channelBinding": { + "$ref": "#/components/schemas/ChannelBinding" + }, + "compliance": { + "$ref": "#/components/schemas/Compliance" + }, + "userVerification": { + "$ref": "#/components/schemas/UserVerificationEnum" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeyOnprem": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeyPassword": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeyPhone": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + }, + { + "properties": { + "settings": { + "properties": { + "allowedFor": { + "$ref": "#/components/schemas/AllowedForEnum" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorKeySecurityKey": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeySecurityQuestion": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + }, + { + "properties": { + "settings": { + "properties": { + "allowedFor": { + "$ref": "#/components/schemas/AllowedForEnum" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorKeySmartCard": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeySymantecVip": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeyTac": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + }, + { + "properties": { + "provider": { + "description": "Settings for the TAC authenticator", + "properties": { + "configuration": { + "description": "Define the configuration settings of the TAC", + "properties": { + "complexity": { + "description": "Define the complexity of the TAC", + "properties": { + "letters": { + "description": "Use letters in the TAC", + "type": "boolean" + }, + "numbers": { + "description": "Use numbers in the TAC. `numbers` is always `true` for the TAC authenticator.", + "type": "boolean" + }, + "specialCharacters": { + "description": "Use special characters in the TAC", + "type": "boolean" + } + }, + "type": "object" + }, + "defaultTtl": { + "default": 120, + "description": "The default TTL in minutes when you create a TAC. The `defaultTtl` indicates the actual amount of time that a TAC is valid before it expires. The `defaultTtl` must be greater than the `minTtl` and less than the `maxTtl`.", + "maximum": 14400, + "minimum": 10, + "type": "number" + }, + "length": { + "description": "Defines the number of characters in a TAC. For example, a `length` of `16` means that the TAC is 16 characters.", + "maximum": 64, + "minimum": 8, + "type": "number" + }, + "maxTtl": { + "description": "Maximum TTL of the TAC in minutes. The `maxTtl` indicates the maximum amount of time that a TAC is valid. The `maxTtl` must be greater than the `minTtl`.", + "maximum": 14400, + "minimum": 10, + "type": "number" + }, + "minTtl": { + "description": "Minimum time-to-live (TTL) of the TAC in minutes. The `minTtl` indicates the minimum amount of time that a TAC is valid. The `minTtl` must be less than the `maxTtl`.", + "maximum": 14400, + "minimum": 10, + "type": "number" + }, + "multiUseAllowed": { + "description": "Indicates whether a TAC can be used multiple times. If set to `true`, the TAC can be used multiple times until it expires.", + "type": "boolean" + } + }, + "required": [ + "minTtl", + "maxTtl", + "defaultTtl", + "length", + "complexity" + ], + "type": "object" + }, + "type": { + "description": "Provider type", + "enum": [ + "tac" + ], + "type": "string" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "AuthenticatorKeyWebauthn": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorKeyYubikey": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorSimple" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + }, + { + "properties": { + "methods": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "Link to authenticator methods" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorMethodAlgorithm": { + "enum": [ + "ES256", + "RS256" + ], + "type": "string" + }, + "AuthenticatorMethodBase": { + "discriminator": { + "mapping": { + "cert": "#/components/schemas/AuthenticatorMethodWithVerifiableProperties", + "duo": "#/components/schemas/AuthenticatorMethodWithVerifiableProperties", + "email": "#/components/schemas/AuthenticatorMethodSimple", + "idp": "#/components/schemas/AuthenticatorMethodWithVerifiableProperties", + "otp": "#/components/schemas/AuthenticatorMethodOtp", + "password": "#/components/schemas/AuthenticatorMethodSimple", + "push": "#/components/schemas/AuthenticatorMethodPush", + "security_question": "#/components/schemas/AuthenticatorMethodSimple", + "signed_nonce": "#/components/schemas/AuthenticatorMethodSignedNonce", + "sms": "#/components/schemas/AuthenticatorMethodSimple", + "tac": "#/components/schemas/AuthenticatorMethodTac", + "totp": "#/components/schemas/AuthenticatorMethodTotp", + "voice": "#/components/schemas/AuthenticatorMethodSimple", + "webauthn": "#/components/schemas/AuthenticatorMethodWebAuthn" + }, + "propertyName": "type" + }, + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + }, + "status": { + "allOf": [ + { + "description": "The status of the authenticator method" + }, + { + "$ref": "#/components/schemas/LifecycleStatus" + } + ] + }, + "type": { + "$ref": "#/components/schemas/AuthenticatorMethodType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorMethodConstraint": { + "description": "Limits the authenticators that can be used for a given method. Currently, only the `otp` method supports constraints, and Google authenticator (key : 'google_otp') is the only allowed authenticator.", + "properties": { + "allowedAuthenticators": { + "items": { + "$ref": "#/components/schemas/AuthenticatorIdentity" + }, + "type": "array" + }, + "method": { + "enum": [ + "otp" + ] + } + }, + "type": "object" + }, + "AuthenticatorMethodOtp": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorMethodWithVerifiableProperties" + }, + { + "properties": { + "acceptableAdjacentIntervals": { + "description": "The number of acceptable adjacent intervals, also known as the clock drift interval. This setting allows you to build in tolerance for any time difference between the token and the server. For example, with a `timeIntervalInSeconds` of 60 seconds and an `acceptableAdjacentIntervals` value of 5, Okta accepts passcodes within 300 seconds (60 * 5) before or after the end user enters their code.", + "maximum": 10, + "minimum": 0, + "type": "integer" + }, + "algorithm": { + "$ref": "#/components/schemas/OtpTotpAlgorithm" + }, + "encoding": { + "$ref": "#/components/schemas/OtpTotpEncoding" + }, + "factorProfileId": { + "description": "The `id` value of the factor profile", + "example": "aut1nd8PQhGcQtSxB0g4", + "type": "string" + }, + "passCodeLength": { + "$ref": "#/components/schemas/OtpTotpPassCodeLength" + }, + "protocol": { + "$ref": "#/components/schemas/OtpProtocol" + }, + "timeIntervalInSeconds": { + "$ref": "#/components/schemas/OtpTotpTimeIntervalInSeconds" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorMethodProperty": { + "enum": [ + "DEVICE_BOUND", + "HARDWARE_PROTECTED", + "PHISHING_RESISTANT", + "USER_PRESENCE", + "USER_VERIFYING" + ], + "type": "string" + }, + "AuthenticatorMethodPush": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + }, + { + "properties": { + "settings": { + "properties": { + "algorithms": { + "items": { + "$ref": "#/components/schemas/AuthenticatorMethodAlgorithm" + }, + "type": "array" + }, + "keyProtection": { + "$ref": "#/components/schemas/PushMethodKeyProtection" + }, + "transactionTypes": { + "items": { + "$ref": "#/components/schemas/AuthenticatorMethodTransactionType" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorMethodSignedNonce": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + }, + { + "properties": { + "settings": { + "properties": { + "algorithms": { + "items": { + "$ref": "#/components/schemas/AuthenticatorMethodAlgorithm" + }, + "type": "array" + }, + "keyProtection": { + "$ref": "#/components/schemas/PushMethodKeyProtection" + }, + "showSignInWithOV": { + "$ref": "#/components/schemas/ShowSignInWithOV" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorMethodSimple": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorMethodTac": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + }, + "status": { + "allOf": [ + { + "description": "The status of the authenticator method" + }, + { + "$ref": "#/components/schemas/LifecycleStatus" + } + ] + }, + "type": { + "$ref": "#/components/schemas/AuthenticatorMethodType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "AuthenticatorMethodTotp": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + }, + { + "properties": { + "settings": { + "properties": { + "algorithm": { + "$ref": "#/components/schemas/OtpTotpAlgorithm" + }, + "encoding": { + "$ref": "#/components/schemas/OtpTotpEncoding" + }, + "passCodeLength": { + "$ref": "#/components/schemas/OtpTotpPassCodeLength" + }, + "timeIntervalInSeconds": { + "$ref": "#/components/schemas/OtpTotpTimeIntervalInSeconds" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorMethodTransactionType": { + "enum": [ + "CIBA", + "LOGIN" + ], + "type": "string" + }, + "AuthenticatorMethodType": { + "description": "The type of authenticator method", + "enum": [ + "cert", + "duo", + "email", + "idp", + "otp", + "password", + "push", + "security_question", + "signed_nonce", + "sms", + "totp", + "voice", + "webauthn", + "tac" + ], + "type": "string" + }, + "AuthenticatorMethodTypeWebAuthn": { + "description": "The type of authenticator method", + "enum": [ + "webauthn" + ], + "type": "string" + }, + "AuthenticatorMethodWebAuthn": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + }, + { + "properties": { + "settings": { + "description": "The settings for the Passkey (FIDO2 WebAuthn) authenticator method", + "properties": { + "aaguidGroups": { + "description": "The FIDO2 Authenticator Attestation Global Unique Identifiers (AAGUID) groups available to the Passkey (FIDO2 WebAuthn) authenticator", + "items": { + "$ref": "#/components/schemas/AAGUIDGroupObject" + }, + "type": "array" + }, + "allowSyncablePasskeys": { + "$ref": "#/components/schemas/WebAuthnSettingAllowSyncablePasskeys" + }, + "attachment": { + "$ref": "#/components/schemas/WebAuthnAttachmentEnum" + }, + "certBasedAttestationValidation": { + "$ref": "#/components/schemas/WebAuthnSettingCertBasedAttestationValidation" + }, + "enableAutofillUI": { + "$ref": "#/components/schemas/WebAuthnSettingEnableAutofillUI" + }, + "fipsCompliant": { + "$ref": "#/components/schemas/WebAuthnSettingFipsCompliant" + }, + "hardwareProtected": { + "$ref": "#/components/schemas/WebAuthnSettingHardwareProtected" + }, + "residentKeyRequirement": { + "$ref": "#/components/schemas/WebAuthnSettingResidentKeyRequirement" + }, + "rpId": { + "$ref": "#/components/schemas/WebAuthnRpId" + }, + "showSignInWithAPasskeyButton": { + "$ref": "#/components/schemas/WebAuthnSettingShowSignInWithAPasskeyButton" + }, + "userVerification": { + "$ref": "#/components/schemas/UserVerificationEnumEnrollment" + }, + "userVerificationForVerify": { + "$ref": "#/components/schemas/UserVerificationEnumForVerify" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorMethodWithVerifiableProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + }, + { + "properties": { + "verifiableProperties": { + "items": { + "$ref": "#/components/schemas/AuthenticatorMethodProperty" + }, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "AuthenticatorProfile": { + "description": "Defines the authenticator specific parameters", + "properties": { + "phoneNumber": { + "description": "The phone number for a `call` or `sms` authenticator enrollment.", + "type": "string" + } + }, + "required": [ + "phoneNumber" + ], + "type": "object" + }, + "AuthenticatorProfileTacRequest": { + "description": "Defines the authenticator specific parameters", + "properties": { + "multiUse": { + "description": "Determines whether the enrollment can be used more than once. To enable multi-use, the org-level authenticator\u2019s configuration must allow multi-use.", + "type": "boolean", + "writeOnly": true + }, + "ttl": { + "description": "Time-to-live (TTL) in minutes.\n\nSpecifies how long the TAC enrollment is valid after it's created and activated.\nThe configured value must be between 10 minutes (`10`) and 10 days (`14400`), inclusive.\nThe actual allowed range depends on the org-level authenticator configuration.", + "type": "string", + "writeOnly": true + } + }, + "type": "object" + }, + "AuthenticatorProfileTacResponsePost": { + "description": "Defines the authenticator specific parameters", + "properties": { + "expiresAt": { + "description": "The time when the TAC enrollment expires in the UTC timezone", + "format": "date-time", + "type": "string" + }, + "multiUse": { + "description": "Determines whether an enrollment can be used more than once", + "type": "boolean" + }, + "tac": { + "description": "A temporary access code used for authentication. It can be used one or more times and is valid for a defined period specified by the `ttl` property.\nThe `tac` is returned in the response when the enrollment is created. It is not returned when the enrollment is retrieved.\nIssuing a new TAC invalidates any existing TAC for this user.", + "type": "string" + } + }, + "type": "object" + }, + "AuthenticatorSimple": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthenticatorBase" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthenticatorType": { + "description": "The type of authenticator", + "enum": [ + "app", + "email", + "federated", + "password", + "phone", + "security_key", + "security_question", + "tac" + ], + "type": "string" + }, + "AuthorizationServer": { + "properties": { + "_links": { + "$ref": "#/components/schemas/AuthServerLinks" + }, + "accessTokenEncryptedResponseAlgorithm": { + "$ref": "#/components/schemas/AccessTokenKeyEncryptionAlgorithm" + }, + "audiences": { + "description": "The recipients that the tokens are intended for. This becomes the `aud` claim in an access token. Okta currently supports only one audience.", + "items": { + "type": "string" + }, + "type": "array" + }, + "created": { + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "credentials": { + "$ref": "#/components/schemas/AuthorizationServerCredentials" + }, + "description": { + "description": "The description of the custom authorization server", + "type": "string" + }, + "id": { + "description": "The ID of the custom authorization server", + "readOnly": true, + "type": "string" + }, + "issuer": { + "description": "The complete URL for the custom authorization server. This becomes the `iss` claim in an access token.", + "type": "string" + }, + "issuerMode": { + "description": "Indicates which value is specified in the issuer of the tokens that a custom authorization server returns: the Okta org domain URL or a custom domain URL.\n\n`issuerMode` is visible if you have a custom URL domain configured or the Dynamic Issuer Mode feature enabled. If you have a custom URL domain configured, you can set a custom domain URL in a custom authorization server, and this property is returned in the appropriate responses.\n\nWhen set to `ORG_URL`, then in responses, `issuer` is the Okta org domain URL: `https://${yourOktaDomain}`.\n\nWhen set to `CUSTOM_URL`, then in responses, `issuer` is the custom domain URL configured in the administration user interface.\n\nWhen set to `DYNAMIC`, then in responses, `issuer` is the custom domain URL if the OAuth 2.0 request was sent to the custom domain, or is the Okta org's domain URL if the OAuth 2.0 request was sent to the original Okta org domain.\n\nAfter you configure a custom URL domain, all new custom authorization servers use `CUSTOM_URL` by default. If the Dynamic Issuer Mode feature is enabled, then all new custom authorization servers use `DYNAMIC` by default. All existing custom authorization servers continue to use the original value until they're changed using the Admin Console or the API. This way, existing integrations with the client and resource server continue to work after the feature is enabled.", + "type": "string" + }, + "jwks": { + "$ref": "#/components/schemas/ResourceServerJsonWebKeys" + }, + "jwks_uri": { + "description": "URL string that references a JSON Web Key Set for encrypting JWTs minted by the custom authorization server", + "type": "string", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "lastUpdated": { + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the custom authorization server", + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/LifecycleStatus" + } + }, + "type": "object" + }, + "AuthorizationServerCredentials": { + "properties": { + "signing": { + "$ref": "#/components/schemas/AuthorizationServerCredentialsSigningConfig" + } + }, + "type": "object" + }, + "AuthorizationServerCredentialsRotationMode": { + "description": "The Key rotation mode for the authorization server", + "enum": [ + "AUTO", + "MANUAL" + ], + "type": "string" + }, + "AuthorizationServerCredentialsSigningConfig": { + "properties": { + "kid": { + "description": "The ID of the JSON Web Key used for signing tokens issued by the authorization server", + "readOnly": true, + "type": "string" + }, + "lastRotated": { + "description": "The timestamp when the authorization server started using the `kid` for signing tokens", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "nextRotation": { + "description": "The timestamp when the authorization server changes the Key for signing tokens. This is only returned when `rotationMode` is set to `AUTO`.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "rotationMode": { + "$ref": "#/components/schemas/AuthorizationServerCredentialsRotationMode" + }, + "use": { + "$ref": "#/components/schemas/AuthorizationServerCredentialsUse" + } + }, + "type": "object" + }, + "AuthorizationServerCredentialsUse": { + "description": "How the key is used", + "enum": [ + "sig" + ], + "type": "string" + }, + "AuthorizationServerJsonWebKey": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "alg": { + "description": "The algorithm used with the Key. Valid value: `RS256`", + "type": "string" + }, + "e": { + "description": "RSA key value (public exponent) for Key binding", + "readOnly": true, + "type": "string" + }, + "kid": { + "description": "Unique identifier for the key", + "readOnly": true, + "type": "string" + }, + "kty": { + "description": "Cryptographic algorithm family for the certificate's keypair. Valid value: `RSA`", + "readOnly": true, + "type": "string" + }, + "n": { + "description": "RSA modulus value that is used by both the public and private keys and provides a link between them", + "type": "string" + }, + "status": { + "description": "An `ACTIVE` Key is used to sign tokens issued by the authorization server. Supported values: `ACTIVE`, `NEXT`, or `EXPIRED`
\nA `NEXT` Key is the next Key that the authorization server uses to sign tokens when Keys are rotated. The `NEXT` Key might not be listed if it hasn't been generated.\nAn `EXPIRED` Key is the previous Key that the authorization server used to sign tokens. The `EXPIRED` Key might not be listed if no Key has expired or the expired Key was deleted.", + "type": "string" + }, + "use": { + "description": "Acceptable use of the key. Valid value: `sig`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AuthorizationServerPolicy": { + "allOf": [ + { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + }, + { + "properties": { + "rules": { + "allOf": [ + { + "description": "Link to the authorization server policy's rules" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "type": "object" + } + ] + }, + "conditions": { + "$ref": "#/components/schemas/AuthorizationServerPolicyConditions" + }, + "created": { + "description": "Timestamp when the Policy was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of the Policy", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "ID of the Policy", + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the Policy was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the Policy", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Specifies the order in which this Policy is evaluated in relation to the other Policies in a custom authorization server", + "type": "integer" + }, + "status": { + "description": "Specifies whether requests have access to this Policy", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "system": { + "description": "Specifies whether Okta created this Policy", + "type": "boolean" + }, + "type": { + "description": "Indicates that the Policy is an authorization server Policy", + "enum": [ + "OAUTH_AUTHORIZATION_POLICY" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthorizationServerPolicyConditions": { + "properties": { + "clients": { + "$ref": "#/components/schemas/ClientPolicyCondition" + } + }, + "type": "object" + }, + "AuthorizationServerPolicyPeopleCondition": { + "description": "Identifies Users and Groups that are used together", + "properties": { + "groups": { + "$ref": "#/components/schemas/AuthorizationServerPolicyRuleGroupCondition" + }, + "users": { + "$ref": "#/components/schemas/AuthorizationServerPolicyRuleUserCondition" + } + }, + "type": "object" + }, + "AuthorizationServerPolicyRule": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + } + ] + }, + "actions": { + "$ref": "#/components/schemas/AuthorizationServerPolicyRuleActions" + }, + "conditions": { + "$ref": "#/components/schemas/AuthorizationServerPolicyRuleConditions" + }, + "created": { + "description": "Timestamp when the rule was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Identifier of the rule", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the rule was last modified", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the rule", + "type": "string" + }, + "priority": { + "description": "Priority of the rule", + "type": "integer" + }, + "status": { + "description": "Status of the rule", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "system": { + "description": "Set to `true` for system rules. You can't delete system rules.", + "type": "boolean" + }, + "type": { + "description": "Rule type", + "enum": [ + "RESOURCE_ACCESS" + ], + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthorizationServerPolicyRuleActions": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRuleActions" + }, + { + "properties": { + "token": { + "$ref": "#/components/schemas/TokenAuthorizationServerPolicyRuleAction" + } + }, + "type": "object" + } + ] + }, + "AuthorizationServerPolicyRuleConditions": { + "properties": { + "grantTypes": { + "$ref": "#/components/schemas/GrantTypePolicyRuleCondition" + }, + "people": { + "$ref": "#/components/schemas/AuthorizationServerPolicyPeopleCondition" + }, + "scopes": { + "$ref": "#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition" + } + }, + "type": "object" + }, + "AuthorizationServerPolicyRuleGroupCondition": { + "description": "Specifies a set of Groups whose Users are to be included", + "properties": { + "include": { + "description": "Groups to be included", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthorizationServerPolicyRuleRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthorizationServerPolicyRule" + }, + { + "required": [ + "name", + "conditions", + "type" + ], + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "AuthorizationServerPolicyRuleUserCondition": { + "description": "Specifies a set of Users to be included", + "properties": { + "include": { + "description": "Users to be included", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthorizationServerResourceHrefObject": { + "properties": { + "href": { + "description": "Link URI", + "example": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7", + "type": "string" + }, + "title": { + "description": "Link name", + "example": "Example Authorization Server", + "type": "string" + } + }, + "type": "object" + }, + "AutoAssignAdminAppSetting": { + "description": "The org setting that automatically assigns the Okta Admin Console when an admin role is assigned", + "properties": { + "autoAssignAdminAppSetting": { + "description": "Automatically assigns the Okta Admin Console to the user when an admin role is assigned", + "type": "boolean" + } + }, + "type": "object" + }, + "AutoLoginApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/Application" + }, + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/SchemeApplicationCredentials" + }, + "name": { + "description": "A unique key is generated for the custom SWA app instance when you use AUTO_LOGIN `signOnMode`.", + "readOnly": true, + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/AutoLoginApplicationSettings" + } + }, + "type": "object" + } + ] + }, + "AutoLoginApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "properties": { + "signOn": { + "$ref": "#/components/schemas/AutoLoginApplicationSettingsSignOn" + } + }, + "type": "object" + } + ] + }, + "AutoLoginApplicationSettingsSignOn": { + "properties": { + "loginUrl": { + "description": "Primary URL of the sign-in page for this app", + "type": "string" + }, + "redirectUrl": { + "description": "Secondary URL of the sign-in page for this app", + "type": "string" + } + }, + "required": [ + "loginUrl" + ], + "type": "object" + }, + "AutoUpdateSchedule": { + "description": "The schedule of auto-update configured by the admin", + "properties": { + "cron": { + "description": "The schedule of the update in cron format. The cron settings are limited to only the day of the month or the nth-day-of-the-week configurations. For example, `0 8 ? * 6#3` indicates every third Saturday at 8:00 AM.", + "example": "0 8 ? * 6#3", + "type": "string" + }, + "delay": { + "description": "Delay in days", + "type": "integer" + }, + "duration": { + "description": "Duration in minutes", + "example": 120, + "type": "integer" + }, + "lastUpdated": { + "description": "Timestamp when the update finished (only for a successful or failed update, not for a cancelled update). Null is returned if the job hasn't finished once yet.", + "format": "date-time", + "type": "string" + }, + "timezone": { + "description": "Timezone of where the scheduled job takes place", + "example": "America/New_York", + "type": "string" + } + }, + "type": "object" + }, + "AvailableAction": { + "properties": { + "id": { + "description": "Action identifier", + "example": "okta:action1", + "type": "string" + }, + "provider": { + "$ref": "#/components/schemas/WorkflowAvailableActionProvider" + } + }, + "required": [ + "id", + "provider" + ], + "type": "object" + }, + "AvailableActionProvider": { + "discriminator": { + "mapping": { + "WORKFLOWS": "#/components/schemas/WorkflowAvailableActionProvider" + }, + "propertyName": "type" + }, + "properties": { + "actionName": { + "description": "The name of the action flow", + "type": "string" + }, + "externalId": { + "description": "The unique identifier of the action flow in the provider system", + "type": "string" + }, + "link": { + "description": "The URL to the action flow interface in Workflows platform", + "format": "uri", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ActionProviderPayloadType" + } + }, + "required": [ + "actionName", + "link", + "externalId", + "type" + ], + "type": "object" + }, + "AvailableActions": { + "properties": { + "actions": { + "items": { + "$ref": "#/components/schemas/AvailableAction" + }, + "type": "array" + } + }, + "type": "object" + }, + "AwsAccountId": { + "description": "Your AWS account ID", + "example": 123456789012, + "maxLength": 12, + "minLength": 12, + "type": "string" + }, + "AwsEventSourceName": { + "description": "An alphanumeric name (no spaces) to identify this event source in AWS EventBridge", + "example": "your-event-source-name", + "maxLength": 75, + "minLength": 1, + "pattern": "^[a-zA-Z0-9.\\-_]$", + "type": "string" + }, + "AwsRegion": { + "description": "The destination AWS region where your event source is located", + "enum": [ + "ap-northeast-1", + "ap-northeast-2", + "ap-northeast-3", + "ap-south-1", + "ap-southeast-1", + "ap-southeast-2", + "ca-central-1", + "eu-central-1", + "eu-north-1", + "eu-west-1", + "eu-west-2", + "eu-west-3", + "sa-east-1", + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2" + ], + "type": "string" + }, + "BASIC_SMTP_AUTH": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseEmailServer" + }, + { + "properties": { + "password": { + "description": "The password of the user account that's used to sign in to your SMTP server", + "type": "string" + } + }, + "type": "object" + } + ], + "title": "BASIC_SMTP_AUTH" + }, + "BASIC_SMTP_AUTH_CREATE": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseEmailServerCreate" + }, + { + "properties": { + "password": { + "description": "The password of the user account that's used to sign in to your SMTP server", + "type": "string" + } + }, + "required": [ + "password" + ], + "type": "object" + } + ], + "title": "BASIC_SMTP_AUTH" + }, + "BaseContext": { + "description": "This object contains a number of sub-objects, each of which provide some type of contextual information.", + "properties": { + "request": { + "$ref": "#/components/schemas/InlineHookRequestObject" + }, + "session": { + "description": "Details of the user session", + "properties": { + "amr": { + "description": "The authentication method reference", + "items": { + "example": [ + "PASSWORD" + ], + "type": "string" + }, + "type": "array" + }, + "createdAt": { + "description": "Timestamp of when the session was created", + "example": "2019-03-28T16:45:55.000Z", + "format": "date-time", + "type": "string" + }, + "expiresAt": { + "description": "Timestamp of when the session expires", + "example": "2019-03-28T21:15:23.000Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The unique identifier for the user's session", + "example": "102LN9Bnuc4S_ewfc9BYwageA", + "type": "string" + }, + "idp": { + "$ref": "#/components/schemas/SessionIdentityProvider" + }, + "lastPasswordVerification": { + "description": "Timestamp of when the user was last authenticated", + "example": "2019-03-28T16:45:55.000Z", + "format": "date-time", + "type": "string" + }, + "login": { + "description": "The username used to identify the user. This is often the user's email address.", + "example": "user@example.com", + "type": "string" + }, + "mfaActive": { + "description": "Describes whether multifactor authentication was enabled", + "example": false, + "type": "boolean" + }, + "status": { + "description": "Represents the current status of the user's session", + "example": "ACTIVE", + "type": "string" + }, + "userId": { + "description": "The unique identifier for the user", + "example": "00uq8tMo3zV0OfJON0g3", + "type": "string" + } + }, + "type": "object" + }, + "user": { + "description": "Identifies the Okta user that the token was generated to authenticate and provides details of their Okta user profile", + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of the user. These links are used to discover what groups the user is a part of and what factors they have enrolled.", + "properties": { + "factors": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to retrieve individual user's factor enrollments" + }, + "groups": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to retrieve the individual user's group memberships" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier for the user", + "example": "00uq8tMo3zV0OfJON0g3", + "type": "string" + }, + "passwordChanged": { + "description": "The timestamp when the user's password was last updated", + "example": "2018-09-11T23:19:12.000Z", + "format": "date-time", + "type": "string" + }, + "profile": { + "properties": { + "firstName": { + "description": "The first name of the user", + "example": "John", + "type": "string" + }, + "lastName": { + "description": "The last name of the user", + "example": "Smith", + "type": "string" + }, + "locale": { + "description": "The user's default location for purposes of localizing items such as currency, date time format, numerical representations, and so on.\nA locale value is a concatenation of the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) two-letter language code, an underscore, and the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) two-letter country code. For example, `en_US` specifies the language English and country US. This value is `en_US` by default.", + "example": "en_US", + "type": "string" + }, + "login": { + "description": "The username used to identify the user. This is often the user's email address.", + "example": "user@example.com", + "type": "string" + }, + "timeZone": { + "description": "The user's timezone", + "example": "America/Los_Angeles", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "BaseEmailDomain": { + "properties": { + "displayName": { + "type": "string" + }, + "userName": { + "type": "string" + } + }, + "required": [ + "displayName", + "userName" + ], + "type": "object" + }, + "BaseEmailServer": { + "discriminator": { + "mapping": { + "BASIC_SMTP_AUTH": "#/components/schemas/BASIC_SMTP_AUTH", + "OAUTH2_CLIENT_CREDENTIALS": "#/components/schemas/OAUTH2_CLIENT_CREDENTIALS", + "OAUTH2_JWT_BEARER_GRANT": "#/components/schemas/OAUTH2_JWT_BEARER_GRANT" + }, + "propertyName": "authType" + }, + "properties": { + "alias": { + "description": "Human-readable name for your SMTP server", + "example": "CustomServer1", + "type": "string" + }, + "authType": { + "$ref": "#/components/schemas/SmtpAuthType" + }, + "enabled": { + "description": "If `true`, all email traffic is routed through your SMTP server", + "type": "boolean" + }, + "host": { + "description": "Hostname or IP address of your SMTP server", + "example": "192.168.160.1", + "type": "string" + }, + "id": { + "description": "ID of your SMTP server", + "readOnly": true, + "type": "string" + }, + "port": { + "description": "Port number of your SMTP server", + "example": 587, + "type": "integer" + }, + "username": { + "description": "Username that's used to access your SMTP server", + "example": "some_user@domain.com", + "type": "string" + } + }, + "required": [ + "authType" + ], + "type": "object" + }, + "BaseEmailServerCreate": { + "discriminator": { + "mapping": { + "BASIC_SMTP_AUTH": "#/components/schemas/BASIC_SMTP_AUTH_CREATE", + "OAUTH2_CLIENT_CREDENTIALS": "#/components/schemas/OAUTH2_CLIENT_CREDENTIALS_CREATE", + "OAUTH2_JWT_BEARER_GRANT": "#/components/schemas/OAUTH2_JWT_BEARER_GRANT_CREATE" + }, + "propertyName": "authType" + }, + "properties": { + "alias": { + "description": "Human-readable name for your SMTP server", + "example": "CustomServer1", + "type": "string" + }, + "authType": { + "$ref": "#/components/schemas/SmtpAuthType" + }, + "enabled": { + "description": "If `true`, all email traffic is routed through your SMTP server", + "type": "boolean" + }, + "host": { + "description": "Hostname or IP address of your SMTP server", + "example": "192.168.160.1", + "type": "string" + }, + "id": { + "description": "ID of your SMTP server", + "readOnly": true, + "type": "string" + }, + "port": { + "description": "Port number of your SMTP server", + "example": 587, + "type": "integer" + }, + "username": { + "description": "Username that's used to access your SMTP server", + "example": "some_user@domain.com", + "type": "string" + } + }, + "required": [ + "alias", + "enabled", + "host", + "port", + "username", + "authType" + ], + "type": "object" + }, + "BaseToken": { + "properties": { + "claims": { + "description": "Claims included in the token. Consists of name-value pairs for each included claim. For descriptions of the claims that you can include, see the Okta [OpenID Connect and OAuth 2.0 API reference](/openapi/okta-oauth/guides/overview/#claims).", + "type": "object" + }, + "token": { + "description": "The token", + "properties": { + "lifetime": { + "description": "Lifetime of the token", + "properties": { + "expiration": { + "description": "Time in seconds until the token expires", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "BasicApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/BasicApplicationSettingsApplication" + } + }, + "type": "object" + } + ] + }, + "BasicApplicationSettingsApplication": { + "properties": { + "authURL": { + "description": "The URL of the authenticating site for this app", + "type": "string" + }, + "url": { + "description": "The URL of the sign-in page for this app", + "type": "string" + } + }, + "required": [ + "authURL", + "url" + ], + "type": "object" + }, + "BasicAuthApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/Application" + }, + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/SchemeApplicationCredentials" + }, + "name": { + "description": "`template_basic_auth` is the key name for a Basic Authentication scheme app instance", + "enum": [ + "template_basic_auth" + ], + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/BasicApplicationSettings" + } + }, + "required": [ + "name", + "settings" + ], + "type": "object" + } + ], + "x-okta-defined-as": { + "name": "template_basic_auth" + } + }, + "BeforeScheduledActionPolicyRuleCondition": { + "properties": { + "duration": { + "$ref": "#/components/schemas/Duration" + }, + "lifecycleAction": { + "$ref": "#/components/schemas/ScheduledUserLifecycleAction" + } + }, + "type": "object" + }, + "BehaviorRule": { + "discriminator": { + "mapping": { + "ANOMALOUS_ASN": "#/components/schemas/BehaviorRuleASN", + "ANOMALOUS_DEVICE": "#/components/schemas/BehaviorRuleAnomalousDevice", + "ANOMALOUS_IP": "#/components/schemas/BehaviorRuleAnomalousIP", + "ANOMALOUS_LOCATION": "#/components/schemas/BehaviorRuleAnomalousLocation", + "VELOCITY": "#/components/schemas/BehaviorRuleVelocity" + }, + "propertyName": "type" + }, + "properties": { + "_link": { + "$ref": "#/components/schemas/LinksSelf" + }, + "created": { + "description": "Timestamp when the Behavior Detection Rule was created", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "ID of the Behavior Detection Rule", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the Behavior Detection Rule was last modified", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the Behavior Detection Rule", + "maxLength": 128, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/LifecycleStatus" + }, + "type": { + "$ref": "#/components/schemas/BehaviorRuleType" + } + }, + "required": [ + "name", + "type" + ], + "title": "Behavior Detection Rule", + "type": "object" + }, + "BehaviorRuleASN": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRule" + }, + { + "properties": { + "settings": { + "$ref": "#/components/schemas/BehaviorRuleSettingsAnomalousASN" + } + }, + "type": "object" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "BehaviorRuleAnomalousDevice": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRule" + }, + { + "properties": { + "settings": { + "$ref": "#/components/schemas/BehaviorRuleSettingsAnomalousDevice" + } + }, + "type": "object" + } + ] + }, + "BehaviorRuleAnomalousIP": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRule" + }, + { + "properties": { + "settings": { + "$ref": "#/components/schemas/BehaviorRuleSettingsAnomalousIP" + } + }, + "type": "object" + } + ] + }, + "BehaviorRuleAnomalousLocation": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRule" + }, + { + "properties": { + "settings": { + "$ref": "#/components/schemas/BehaviorRuleSettingsAnomalousLocation" + } + }, + "type": "object" + } + ] + }, + "BehaviorRuleSettings": { + "title": "Behavior Detection Rule Settings", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "BehaviorRuleSettingsAnomalousASN": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRuleSettingsHistoryBased" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "BehaviorRuleSettingsAnomalousDevice": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRuleSettingsHistoryBased" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "BehaviorRuleSettingsAnomalousIP": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRuleSettingsHistoryBased" + }, + { + "properties": { + "maxEventsUsedForEvaluation": { + "default": 50, + "maximum": 100, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + } + ] + }, + "BehaviorRuleSettingsAnomalousLocation": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRuleSettingsHistoryBased" + }, + { + "properties": { + "granularity": { + "$ref": "#/components/schemas/LocationGranularity" + }, + "radiusKilometers": { + "description": "Required when `granularity` is `LAT_LONG`. Radius from the provided coordinates in kilometers.", + "type": "integer" + } + }, + "required": [ + "granularity" + ], + "type": "object" + } + ] + }, + "BehaviorRuleSettingsHistoryBased": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRuleSettings" + }, + { + "properties": { + "maxEventsUsedForEvaluation": { + "default": 20, + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "minEventsNeededForEvaluation": { + "default": 0, + "maximum": 10, + "minimum": 0, + "type": "integer" + } + }, + "title": "Behavior Detection Rule Settings based on Event History", + "type": "object" + } + ] + }, + "BehaviorRuleSettingsVelocity": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRuleSettings" + }, + { + "properties": { + "velocityKph": { + "default": 805, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "velocityKph" + ], + "title": "Behavior Detection Rule Settings based on device velocity in kilometers per hour.", + "type": "object" + } + ] + }, + "BehaviorRuleType": { + "enum": [ + "ANOMALOUS_DEVICE", + "ANOMALOUS_IP", + "ANOMALOUS_LOCATION", + "VELOCITY", + "ANOMALOUS_ASN" + ], + "type": "string" + }, + "BehaviorRuleVelocity": { + "allOf": [ + { + "$ref": "#/components/schemas/BehaviorRule" + }, + { + "properties": { + "settings": { + "$ref": "#/components/schemas/BehaviorRuleSettingsVelocity" + } + }, + "type": "object" + } + ] + }, + "BindingMethod": { + "description": "The method used to bind the out-of-band channel with the primary channel.", + "enum": [ + "none", + "prompt", + "transfer" + ], + "type": "string" + }, + "BookmarkApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/Application" + }, + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/ApplicationCredentials" + }, + "name": { + "description": "`bookmark` is the key name for a Bookmark app", + "enum": [ + "bookmark" + ], + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/BookmarkApplicationSettings" + } + }, + "required": [ + "name", + "settings" + ], + "type": "object" + } + ], + "x-okta-defined-as": { + "name": "bookmark" + } + }, + "BookmarkApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/BookmarkApplicationSettingsApplication" + } + }, + "type": "object" + } + ] + }, + "BookmarkApplicationSettingsApplication": { + "properties": { + "requestIntegration": { + "default": false, + "description": "Would you like Okta to add an integration for this app?", + "type": "boolean" + }, + "url": { + "description": "The URL of the launch page for this app", + "type": "string" + } + }, + "required": [ + "url" + ], + "type": "object" + }, + "BotProtectionConfiguration": { + "description": "Bot protection configuration for the org", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "enforcementType": { + "$ref": "#/components/schemas/BotProtectionEnforcementType" + }, + "level": { + "$ref": "#/components/schemas/BotProtectionLevel" + }, + "mode": { + "$ref": "#/components/schemas/BotProtectionMode" + }, + "supportedFlows": { + "description": "An array of authentication flows that have bot protection enabled", + "items": { + "$ref": "#/components/schemas/BotProtectionSupportedFlow" + }, + "type": "array" + } + }, + "required": [ + "level", + "mode" + ], + "title": "BotProtectionConfiguration", + "type": "object" + }, + "BotProtectionEnforcementType": { + "description": "The type of enforcement to trigger when a bot is detected", + "enum": [ + "OKTA_CHALLENGE" + ], + "type": "string", + "x-enumDescriptions": { + "OKTA_CHALLENGE": "The Okta built-in challenge mechanism" + } + }, + "BotProtectionLevel": { + "description": "The sensitivity level of bot detection", + "enum": [ + "ANY", + "HIGH", + "LOW", + "MEDIUM" + ], + "type": "string", + "x-enumDescriptions": { + "ANY": "Always flag all requests to trigger enforcement settings, regardless of bot likeliness confidence level.", + "HIGH": "High - Flags only high-confidence bot requests. Prioritizes a frictionless user experience.", + "LOW": "Low and above - Flags low-confidence bot requests. Prioritizes a rigorous security.", + "MEDIUM": "Medium and above - Flags moderate and high-confidence bot requests. Provides a balanced experience and security." + } + }, + "BotProtectionMode": { + "description": "The enforcement mode for bot protection", + "enum": [ + "DISABLED", + "ENFORCED", + "LOG_ONLY" + ], + "type": "string", + "x-enumDescriptions": { + "DISABLED": "Bot protection is disabled", + "ENFORCED": "Enforcement is applied to events where bots are detected", + "LOG_ONLY": "Bot detection events are logged but not enforced" + } + }, + "BotProtectionSupportedFlow": { + "description": "Authentication flows that support bot protection", + "enum": [ + "SIGN_IN", + "SSPR", + "SSR" + ], + "type": "string", + "x-enumDescriptions": { + "SIGN_IN": "User sign-in page", + "SSPR": "Self-Service Password Recovery page", + "SSR": "Self-Service Registration page" + } + }, + "BouncesRemoveListError": { + "properties": { + "emailAddress": { + "description": "An email address with a validation error", + "type": "string" + }, + "reason": { + "description": "Validation error reason", + "type": "string" + } + }, + "type": "object" + }, + "BouncesRemoveListObj": { + "properties": { + "emailAddresses": { + "description": "A list of email addresses to remove from the email-service bounce list", + "items": { + "description": "Email address", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BouncesRemoveListResult": { + "properties": { + "errors": { + "description": "A list of emails that wasn't added to the email-bounced remove list and the error reason", + "items": { + "$ref": "#/components/schemas/BouncesRemoveListError" + }, + "type": "array" + } + }, + "type": "object" + }, + "Brand": { + "properties": { + "agreeToCustomPrivacyPolicy": { + "description": "Consent for updating the custom privacy URL. Not required when resetting the URL.", + "type": "boolean" + }, + "customPrivacyPolicyUrl": { + "default": null, + "description": "Custom privacy policy URL", + "type": "string" + }, + "defaultApp": { + "$ref": "#/components/schemas/DefaultApp" + }, + "emailDomainId": { + "description": "The ID of the email domain", + "type": "string" + }, + "id": { + "description": "The Brand ID", + "readOnly": true, + "type": "string" + }, + "isDefault": { + "description": "If `true`, the Brand is used for the Okta subdomain", + "readOnly": true, + "type": "boolean" + }, + "locale": { + "$ref": "#/components/schemas/Language" + }, + "name": { + "description": "The name of the Brand", + "type": "string" + }, + "removePoweredByOkta": { + "default": false, + "description": "Removes \"Powered by Okta\" from the sign-in page in redirect authentication deployments, and \"\u00a9 [current year] Okta, Inc.\" from the Okta End-User Dashboard", + "type": "boolean" + } + }, + "type": "object" + }, + "BrandDomains": { + "description": "Defines a list of domains with a subset of the properties for each domain", + "properties": { + "domains": { + "description": "Each element of the array defines an individual domain", + "items": { + "$ref": "#/components/schemas/DomainResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "BrandRequest": { + "properties": { + "agreeToCustomPrivacyPolicy": { + "description": "Consent for updating the custom privacy URL. Not required when resetting the URL.", + "type": "boolean" + }, + "customPrivacyPolicyUrl": { + "description": "Custom privacy policy URL", + "type": "string" + }, + "defaultApp": { + "$ref": "#/components/schemas/DefaultApp" + }, + "emailDomainId": { + "description": "The ID of the email domain", + "type": "string" + }, + "locale": { + "$ref": "#/components/schemas/Language" + }, + "name": { + "description": "The name of the brand\n\n> **Note:** You can't use the reserved `DRAPP_DOMAIN_BRAND` name.", + "type": "string" + }, + "removePoweredByOkta": { + "default": false, + "description": "Removes \"Powered by Okta\" from the sign-in page in redirect authentication deployments, and \"\u00a9 [current year] Okta, Inc.\" from the Okta End-User Dashboard", + "type": "boolean" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "BrandWithEmbedded": { + "allOf": [ + { + "$ref": "#/components/schemas/Brand" + } + ], + "properties": { + "_embedded": { + "properties": { + "domains": { + "items": { + "$ref": "#/components/schemas/DomainResponse" + }, + "type": "array" + }, + "emailDomain": { + "$ref": "#/components/schemas/EmailDomainResponse" + }, + "themes": { + "items": { + "$ref": "#/components/schemas/ThemeResponse" + }, + "type": "array" + } + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "themes": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "BrowserPluginApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/Application" + }, + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/SchemeApplicationCredentials" + }, + "name": { + "description": "The key name for the app definition", + "enum": [ + "template_swa", + "template_swa3field" + ], + "type": "string", + "x-enumDescriptions": { + "template_swa": "The key name for a SWA app instance that requires a browser plugin", + "template_swa3field": "The key name for a SWA app instance that requires a browser plugin and supports three CSS selectors" + } + }, + "settings": { + "$ref": "#/components/schemas/SwaApplicationSettings" + } + }, + "required": [ + "name", + "settings" + ], + "type": "object" + } + ] + }, + "BulkDeleteRequestBody": { + "properties": { + "entityType": { + "description": "The type of data to bulk delete in a session. Currently, only `USERS` is supported.", + "enum": [ + "USERS" + ], + "type": "string" + }, + "profiles": { + "description": "Array of profiles to be deleted", + "items": { + "$ref": "#/components/schemas/IdentitySourceUserProfileForDelete" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkGroupDeleteRequestBody": { + "properties": { + "externalIds": { + "description": "Array of external IDs of groups that need to be deleted in Okta", + "items": { + "maxLength": 255, + "type": "string" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "BulkGroupMembershipsDeleteRequestBody": { + "properties": { + "memberships": { + "$ref": "#/components/schemas/IdentitySourceGroupMembershipsDeleteProfile" + } + }, + "type": "object" + }, + "BulkGroupMembershipsUpsertRequestBody": { + "properties": { + "memberships": { + "$ref": "#/components/schemas/IdentitySourceGroupMembershipsUpsertProfile" + } + }, + "type": "object" + }, + "BulkGroupUpsertRequestBody": { + "properties": { + "profiles": { + "description": "Array of group profiles that needs to be inserted or updated in Okta", + "items": { + "properties": { + "externalId": { + "description": "The external ID of the group that needs to be created or updated in Okta", + "maxLength": 255, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/IdentitySourceGroupProfileForUpsert" + } + }, + "type": "object" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "BulkUpsertRequestBody": { + "properties": { + "entityType": { + "description": "The type of data to upsert into the session. Currently, only `USERS` is supported.", + "enum": [ + "USERS" + ], + "type": "string" + }, + "profiles": { + "description": "Array of user profiles to be uploaded", + "items": { + "properties": { + "externalId": { + "description": "The external ID of the entity that needs to be created or updated in Okta", + "maxLength": 512, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/IdentitySourceUserProfileForUpsert" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "BundleEntitlement": { + "description": "An entitlement in a governance bundle", + "properties": { + "_links": { + "description": "Link relations available", + "properties": { + "values": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the entitlement values resource" + } + ] + } + }, + "type": "object" + }, + "description": { + "description": "The description of the role", + "type": "string" + }, + "id": { + "description": "Entitlement ID", + "type": "string" + }, + "name": { + "description": "The name of the role", + "type": "string" + }, + "role": { + "description": "The role key", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "BundleEntitlementsResponse": { + "description": "Entitlement list for a governance bundle", + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "readOnly": true + }, + { + "properties": { + "bundle": { + "$ref": "#/components/schemas/BundleLink" + }, + "next": { + "$ref": "#/components/schemas/HrefObjectNextLink" + } + } + } + ] + }, + "entitlements": { + "description": "List of bundle entitlements", + "items": { + "$ref": "#/components/schemas/BundleEntitlement" + }, + "type": "array" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "BundleLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the bundle resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ByDateTimeAuthenticatorGracePeriodExpiry": { + "allOf": [ + { + "$ref": "#/components/schemas/EnrollmentPolicyAuthenticatorGracePeriod" + }, + { + "properties": { + "expiry": { + "description": "The expiry date for a `BY_DATE_TIME` grace period type. Valid format: `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`\n\nFor example, `2025-01-01T18:30:45.000Z`", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "BySkipCountAuthenticatorGracePeriod": { + "allOf": [ + { + "$ref": "#/components/schemas/EnrollmentPolicyAuthenticatorGracePeriod" + }, + { + "properties": { + "skipCount": { + "description": "The number of times the user can skip enrolling the corresponding authenticator before it becomes mandatory", + "maximum": 10, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "CAPTCHAInstance": { + "description": "", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "id": { + "description": "The unique key for the CAPTCHA instance", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the CAPTCHA instance", + "type": "string" + }, + "secretKey": { + "description": "The secret key issued from the CAPTCHA provider to perform server-side validation for a CAPTCHA token", + "type": "string", + "writeOnly": true + }, + "siteKey": { + "description": "The site key issued from the CAPTCHA provider to render a CAPTCHA on a page", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CAPTCHAType" + } + }, + "title": "CAPTCHAInstance", + "type": "object" + }, + "CAPTCHAType": { + "description": "The type of CAPTCHA provider", + "enum": [ + "HCAPTCHA", + "RECAPTCHA_V2" + ], + "type": "string" + }, + "CSRLinks": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of a CSR object using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.", + "properties": { + "publish": { + "$ref": "#/components/schemas/HrefCsrPublishLink" + }, + "self": { + "$ref": "#/components/schemas/HrefCsrSelfLink" + } + }, + "readOnly": true + }, + "CaepCredentialChangeEvent": { + "description": "The credential was created, changed, revoked or deleted", + "properties": { + "change_type": { + "description": "The type of action done towards the credential", + "enum": [ + "create", + "revoke", + "update", + "delete" + ], + "type": "string" + }, + "credential_type": { + "description": "The credential type of the changed credential. It's one of the supported enum values or any other credential type supported mutually by the transmitter and the receiver.", + "enum": [ + "password", + "pin", + "x509", + "fido2-platform", + "fido2-roaming", + "fido-u2f", + "verifiable-credential", + "phone-voice", + "phone-sms", + "app", + "SECURITY_QUESTION", + "SOFT_TOKEN", + "OKTA_SOFT_TOKEN", + "VIP_FACTOR", + "EMAIL_FACTOR", + "SECUREID_FACTOR", + "DUO_SECURITY", + "OKTA_VERIFY_PUSH", + "YUBIKEY_OTP_FACTOR", + "FIDO_WEBAUTHN", + "CUSTOM_APP_PUSH", + "CLAIMS_AS_FACTOR", + "HOTP_FACTOR", + "SIGNED_NONCE", + "ALL_FACTORS", + "TOTP" + ], + "type": "string" + }, + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "fido2_aaguid": { + "description": "FIDO2 Authenticator Attestation GUID", + "example": "accced6a-63f5-490a-9eea-e59bc1896cfc", + "type": "string" + }, + "friendly_name": { + "description": "Credential friendly name", + "example": "John's FIDO authenticator", + "type": "string" + }, + "initiating_entity": { + "description": "The entity that initiated the event", + "enum": [ + "admin", + "user", + "policy", + "system" + ], + "type": "string" + }, + "reason_admin": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized administrative message intended for logging and auditing", + "type": "object" + } + ] + }, + "reason_user": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized message intended for the end user", + "type": "object" + } + ] + }, + "subject": { + "$ref": "#/components/schemas/SsfTransmitterSecurityEventSubject" + } + }, + "required": [ + "credential_type", + "change_type" + ], + "type": "object" + }, + "CaepDeviceComplianceChangeEvent": { + "description": "The subject's device compliance was revoked", + "properties": { + "current_status": { + "description": "Current device compliance status", + "enum": [ + "compliant", + "not-compliant" + ], + "example": "non-compliant", + "type": "string" + }, + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "initiating_entity": { + "description": "The entity that initiated the event", + "enum": [ + "admin", + "user", + "policy", + "system" + ], + "type": "string" + }, + "previous_status": { + "description": "Previous device compliance status", + "enum": [ + "compliant", + "not-compliant" + ], + "type": "string" + }, + "reason_admin": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized administrative message intended for logging and auditing.
Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "reason_user": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized message intended for the end user.
Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "subject": { + "$ref": "#/components/schemas/SecurityEventSubject" + } + }, + "required": [ + "event_timestamp", + "subject", + "current_status", + "previous_status" + ], + "type": "object" + }, + "CaepEvent": { + "properties": { + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "reason_admin": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized administrative message intended for logging and auditing", + "type": "object" + } + ] + }, + "reason_user": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized message intended for the end user", + "type": "object" + } + ] + }, + "subject": { + "$ref": "#/components/schemas/SsfTransmitterSecurityEventSubject" + } + }, + "type": "object" + }, + "CaepSecurityEvent": { + "properties": { + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "initiating_entity": { + "description": "The entity that initiated the event", + "enum": [ + "admin", + "user", + "policy", + "system" + ], + "type": "string" + }, + "reason_admin": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized administrative message intended for logging and auditing.
Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "reason_user": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized message intended for the end user.
Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "subject": { + "$ref": "#/components/schemas/SecurityEventSubject" + } + }, + "required": [ + "event_timestamp", + "subject" + ], + "type": "object" + }, + "CaepSessionRevokedEvent": { + "description": "The session of the subject was revoked", + "properties": { + "current_ip": { + "description": "Current IP of the session", + "example": "123.4.5.6", + "type": "string" + }, + "current_user_agent": { + "description": "Current user agent of the session", + "example": "CurrentUserAgent", + "type": "string" + }, + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "initiating_entity": { + "description": "The entity that initiated the event", + "enum": [ + "admin", + "user", + "policy", + "system" + ], + "type": "string" + }, + "last_known_ip": { + "description": "Last known IP of the session", + "example": "123.4.5.6", + "type": "string" + }, + "last_known_user_agent": { + "description": "Last known user agent of the session", + "example": "LastUserAgent", + "type": "string" + }, + "reason_admin": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized administrative message intended for logging and auditing.
Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "reason_user": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized message intended for the end user.
Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "subject": { + "$ref": "#/components/schemas/SecurityEventSubject" + } + }, + "required": [ + "event_timestamp", + "subject" + ], + "type": "object" + }, + "CallerContext": { + "properties": { + "managedApp": { + "description": "Indicates whether the calling application is managed. This condition can only be applied to ANDROID device assurance policies and requires its parent rule to include both the `registered` and `managed` conditions.", + "enum": [ + true + ], + "type": "boolean" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "CapabilitiesCreateObject": { + "description": "Determines whether Okta assigns a new app account to each user managed by Okta.\n\nOkta doesn't create a new account if it detects that the username specified in Okta already exists in the app.\nThe user's Okta username is assigned by default.\n", + "properties": { + "lifecycleCreate": { + "$ref": "#/components/schemas/LifecycleCreateSettingObject" + } + }, + "type": "object" + }, + "CapabilitiesImportRulesObject": { + "description": "Defines user import rules", + "properties": { + "userCreateAndMatch": { + "$ref": "#/components/schemas/CapabilitiesImportRulesUserCreateAndMatchObject" + } + }, + "type": "object" + }, + "CapabilitiesImportRulesUserCreateAndMatchObject": { + "description": "Rules for matching and creating users", + "properties": { + "allowPartialMatch": { + "description": "Allows user import upon partial matching. Partial matching occurs when the first and last names of an imported user match those of an existing Okta user, even if the username or email attributes don't match.", + "type": "boolean" + }, + "autoActivateNewUsers": { + "description": "If set to `true`, imported new users are automatically activated.", + "type": "boolean" + }, + "autoConfirmExactMatch": { + "description": "If set to `true`, exact-matched users are automatically confirmed on activation. If set to `false`, exact-matched users need to be confirmed manually.", + "type": "boolean" + }, + "autoConfirmNewUsers": { + "description": "If set to `true`, imported new users are automatically confirmed on activation. This doesn't apply to imported users that already exist in Okta.", + "type": "boolean" + }, + "autoConfirmPartialMatch": { + "description": "If set to `true`, partially matched users are automatically confirmed on activation. If set to `false`, partially matched users need to be confirmed manually.", + "type": "boolean" + }, + "exactMatchCriteria": { + "description": "Determines the attribute to match users", + "enum": [ + "EMAIL", + "USERNAME" + ], + "type": "string" + } + }, + "type": "object" + }, + "CapabilitiesImportSettingsObject": { + "description": "Defines import settings", + "properties": { + "schedule": { + "$ref": "#/components/schemas/ImportScheduleObject" + }, + "username": { + "$ref": "#/components/schemas/ImportUsernameObject" + } + }, + "type": "object" + }, + "CapabilitiesInboundProvisioningObject": { + "description": "Defines the configuration for the INBOUND_PROVISIONING feature", + "properties": { + "importRules": { + "$ref": "#/components/schemas/CapabilitiesImportRulesObject" + }, + "importSettings": { + "$ref": "#/components/schemas/CapabilitiesImportSettingsObject" + } + }, + "required": [ + "importSettings", + "importRules" + ], + "title": "INBOUND_PROVISIONING", + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "CapabilitiesObject": { + "description": "Defines the configurations for the USER_PROVISIONING feature", + "properties": { + "create": { + "$ref": "#/components/schemas/CapabilitiesCreateObject" + }, + "update": { + "$ref": "#/components/schemas/CapabilitiesUpdateObject" + } + }, + "title": "USER_PROVISIONING", + "type": "object" + }, + "CapabilitiesUpdateObject": { + "description": "Determines whether updates to a user's profile are pushed to the app", + "properties": { + "lifecycleDeactivate": { + "$ref": "#/components/schemas/LifecycleDeactivateSettingObject" + }, + "password": { + "$ref": "#/components/schemas/PasswordSettingObject" + }, + "profile": { + "$ref": "#/components/schemas/ProfileSettingObject" + } + }, + "type": "object" + }, + "Capability": { + "enum": [ + "API_SERVICE", + "ENTITLEMENTS", + "IDV", + "PROVISIONING", + "SSO", + "UNIVERSAL_LOGOUT" + ], + "type": "string" + }, + "CatalogApplication": { + "description": "An app in the OIN catalog", + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "properties": { + "logo": { + "description": "List of app logo resources", + "items": { + "$ref": "#/components/schemas/HrefObjectLogoLink" + }, + "type": "array" + }, + "self": { + "$ref": "#/components/schemas/HrefObjectSelfLink" + } + }, + "readOnly": true, + "type": "object" + }, + "category": { + "description": "Category for the app in the OIN catalog", + "example": "SOCIAL", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of the app in the OIN catalog", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "OIN catalog app display name", + "readOnly": true, + "type": "string" + }, + "features": { + "description": "Features supported by the app. See app [features](/openapi/okta-management/management/application/listapplications#application/listapplications/t=response&c=200&path=&d=0/features).", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "id": { + "description": "ID of the app instance. Okta returns this property only for apps not in the OIN catalog.", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the object was last updated", + "example": "2024-09-19T23:37:37.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "App key name. For OIN catalog apps, this is a unique key for the app definition.", + "type": "string" + }, + "signOnModes": { + "description": "Authentication mode for the app. See app [signOnMode](/openapi/okta-management/management/application/listapplications#application/listapplications/t=response&c=200&path=&d=0/signonmode).", + "items": { + "type": "string" + }, + "type": "array" + }, + "status": { + "$ref": "#/components/schemas/CatalogApplicationStatus" + }, + "verificationStatus": { + "description": "OIN verification status of the catalog app", + "example": "OKTA_VERIFIED", + "type": "string" + }, + "website": { + "description": "Website of the OIN catalog app", + "type": "string" + } + }, + "type": "object" + }, + "CatalogApplicationStatus": { + "description": "App status", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "ChallengeType": { + "enum": [ + "http://auth0.com/oauth/grant-type/mfa-oob", + "http://auth0.com/oauth/grant-type/mfa-otp" + ], + "type": "string" + }, + "ChangeEnum": { + "default": "KEEP_EXISTING", + "description": "Determines whether a change in a user's password also updates the user's password in the app", + "enum": [ + "CHANGE", + "KEEP_EXISTING" + ], + "example": "CHANGE", + "type": "string" + }, + "ChangePasswordRequest": { + "properties": { + "newPassword": { + "$ref": "#/components/schemas/PasswordCredential" + }, + "oldPassword": { + "$ref": "#/components/schemas/PasswordCredential" + }, + "revokeSessions": { + "default": false, + "description": "When set to `true`, revokes all user sessions, except for the current session", + "type": "boolean" + } + }, + "type": "object" + }, + "Channel": { + "description": "The out-of-band channel for use with authentication. Required for all `/oob-authenticate` requests and any `/challenge` request with an out-of-band authenticator.", + "enum": [ + "push", + "sms", + "voice" + ], + "type": "string" + }, + "ChannelBinding": { + "properties": { + "required": { + "$ref": "#/components/schemas/RequiredEnum" + }, + "style": { + "enum": [ + "NUMBER_CHALLENGE" + ], + "type": "string" + } + }, + "type": "object" + }, + "ChildOrg": { + "properties": { + "_links": { + "additionalProperties": true, + "description": "Specifies available link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "readOnly": true, + "type": "object" + }, + "admin": { + "$ref": "#/components/schemas/OrgCreationAdmin" + }, + "created": { + "description": "Timestamp when the org was created", + "example": "2022-08-25T00:05:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "edition": { + "description": "Edition for the org. `SKU` is the only supported value.", + "enum": [ + "SKU" + ], + "example": "SKU", + "type": "string" + }, + "id": { + "description": "Org ID", + "example": "00o1n8sbwArJ7OQRw406", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the org was last updated", + "example": "2022-08-25T00:05:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Unique name of the org.\nThis name appears in the HTML `` tag of the new org sign-in page.\nOnly less than 4-width UTF-8 encoded characters are allowed.", + "example": "My Child Org 1", + "format": "utf-8", + "maximum": 100, + "minimum": 1, + "type": "string" + }, + "settings": { + "additionalProperties": true, + "description": "Settings associated with the created org", + "readOnly": true, + "type": "object" + }, + "status": { + "description": "Status of the org. `ACTIVE` is returned after the org is created.", + "enum": [ + "ACTIVE" + ], + "readOnly": true, + "type": "string" + }, + "subdomain": { + "description": "Subdomain of the org. Must be unique and include no spaces.", + "example": "my-child-org-1", + "maximum": 57, + "minimum": 1, + "type": "string" + }, + "token": { + "description": "API token associated with the child org super admin account.\nUse this API token to provision resources (such as policies, apps, and groups) on the newly created child org.\nThis token is revoked if the super admin account is deactivated.\n> **Note:** If this API token expires, sign in to the Admin Console as the super admin user and create a new API token. See [Create an API token](https://developer.okta.com/docs/guides/create-an-api-token/).", + "readOnly": true, + "type": "string" + }, + "tokenType": { + "description": "Type of returned `token`. See [Okta API tokens](https://developer.okta.com/docs/guides/create-an-api-token/main/#okta-api-tokens).", + "enum": [ + "SSWS" + ], + "example": "SSWS", + "readOnly": true, + "type": "string" + }, + "website": { + "description": "Default website for the org", + "example": "https://www.okta.com", + "type": "string" + } + }, + "required": [ + "admin", + "edition", + "name", + "subdomain" + ], + "type": "object" + }, + "ChromeBrowserVersion": { + "description": "Current version of the Chrome Browser", + "properties": { + "minimum": { + "type": "string" + } + }, + "type": "object" + }, + "Claim": { + "type": "string" + }, + "ClassificationType": { + "description": "The type of user classification", + "enum": [ + "LITE", + "STANDARD" + ], + "type": "string", + "x-enumDescriptions": { + "LITE": "Lite", + "STANDARD": "Standard" + } + }, + "Client": { + "properties": { + "application_type": { + "$ref": "#/components/schemas/ApplicationType" + }, + "client_id": { + "description": "Unique key for the client application. The `client_id` is immutable. When you create a client Application, you can't specify the `client_id` because Okta uses the application ID for the `client_id`.", + "readOnly": true, + "type": "string" + }, + "client_id_issued_at": { + "description": "Time at which the `client_id` was issued (measured in unix seconds)", + "readOnly": true, + "type": "integer" + }, + "client_name": { + "description": "Human-readable string name of the client application", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 client secret string (used for confidential clients). The `client_secret` is shown only on the response of the creation or update of a client Application (and only if the `token_endpoint_auth_method` is one that requires a client secret). You can't specify the `client_secret`. If the `token_endpoint_auth_method` requires one, Okta generates a random `client_secret` for the client Application.", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "client_secret_expires_at": { + "description": "Time at which the `client_secret` expires or 0 if it doesn't expire (measured in unix seconds)", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + }, + "frontchannel_logout_session_required": { + "description": "Include user session details", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "URL where Okta sends the logout request", + "nullable": true, + "type": "string" + }, + "grant_types": { + "description": "Array of OAuth 2.0 grant type strings. Default value: `[authorization_code]`", + "items": { + "$ref": "#/components/schemas/GrantType" + }, + "type": "array" + }, + "initiate_login_uri": { + "description": "URL that a third party can use to initiate a login by the client", + "type": "string" + }, + "jwks_uri": { + "description": "URL string that references a [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) for validating JWTs presented to Okta", + "type": "string" + }, + "logo_uri": { + "description": "URL string that references a logo for the client consent dialog (not the sign-in dialog)", + "nullable": true, + "type": "string" + }, + "policy_uri": { + "description": "URL string of a web page providing the client's policy document", + "nullable": true, + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Array of redirection URI strings for use for relying party initiated logouts", + "items": { + "type": "string" + }, + "type": "string" + }, + "redirect_uris": { + "description": "Array of redirection URI strings for use in redirect-based flows. All redirect URIs must be absolute URIs and must not include a fragment component. At least one redirect URI and response type is required for all client types, with the following exceptions: If the client uses the Resource Owner Password flow (if `grant_type` contains the value password) or the Client Credentials flow (if `grant_type` contains the value `client_credentials`), then no redirect URI or response type is necessary. In these cases, you can pass either null or an empty array for these attributes.", + "items": { + "type": "string" + }, + "type": "array" + }, + "request_object_signing_alg": { + "description": "The type of [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) algorithm that must be used for signing request objects", + "items": { + "$ref": "#/components/schemas/SigningAlgorithm" + }, + "type": "array" + }, + "response_types": { + "description": "Array of OAuth 2.0 response type strings. Default value: `[code]`", + "items": { + "$ref": "#/components/schemas/ResponseType" + }, + "type": "array" + }, + "token_endpoint_auth_method": { + "$ref": "#/components/schemas/EndpointAuthMethod" + }, + "tos_uri": { + "description": "URL string of a web page providing the client's terms of service document", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "ClientPolicyCondition": { + "description": "Specifies which clients are included in the policy", + "properties": { + "include": { + "description": "Which clients are included in the policy", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ClientPrivilegesSetting": { + "description": "The org setting that assigns the super admin role by default to a public client app", + "properties": { + "clientPrivilegesSetting": { + "description": "If true, assigns the super admin role by default to new public client apps", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "ClientUpdatePolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "conditions": { + "default": null, + "description": "Policy conditions aren't supported for this policy type.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "ClientUpdatePolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "description": "The action to take based on the risk event", + "properties": { + "updateControls": { + "description": "The object that contains the `actions` array", + "properties": { + "actions": { + "description": "The `updateControls` object's `actions` array supports one action type that determines if an Okta Verify client version update is allowed.", + "items": { + "$ref": "#/components/schemas/ClientUpdatePolicyRuleActionsObject" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "conditions": { + "default": {}, + "description": "Rule conditions aren't supported for this policy type.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "ClientUpdatePolicyRuleActionsObject": { + "properties": { + "action": { + "enum": [ + "OKTA_VERIFY_UPDATE" + ], + "type": "string" + }, + "value": { + "enum": [ + "ALLOW", + "HOTFIX_ONLY", + "DENY" + ], + "type": "string" + } + }, + "type": "object" + }, + "CodeChallengeMethod": { + "enum": [ + "S256" + ], + "type": "string" + }, + "Compliance": { + "properties": { + "fips": { + "$ref": "#/components/schemas/FipsEnum" + } + }, + "type": "object" + }, + "Conditions": { + "description": "Conditions of applying realm assignment", + "properties": { + "expression": { + "$ref": "#/components/schemas/Expression" + }, + "profileSourceId": { + "description": "ID of the profile source", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionsSigningRotationMode": { + "description": "The signing key rotation setting for the provisioning connection", + "enum": [ + "AUTO", + "MANUAL" + ], + "type": "string", + "x-enumDescriptions": { + "AUTO": "Okta manages key rotation for the provisioning connection. Use the [Retrieve a JWKS for the default provisioning connection](/openapi/okta-management/management/applicationconnections/getuserprovisioningconnectionjwks) endpoint for the latest key credentials.", + "MANUAL": "You need to rotate the keys for your provisioning connection manually based on your own schedule. See [Key rotation](https://developer.okta.com/docs/concepts/key-rotation/)." + } + }, + "ContentSecurityPolicySetting": { + "properties": { + "mode": { + "enum": [ + "enforced", + "report_only" + ], + "type": "string" + }, + "reportUri": { + "type": "string" + }, + "srcList": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ContextPolicyRuleCondition": { + "allOf": [ + { + "$ref": "#/components/schemas/DevicePolicyRuleCondition" + }, + { + "properties": { + "expression": { + "type": "string" + } + }, + "type": "object" + } + ] + }, + "CreateBrandRequest": { + "properties": { + "name": { + "description": "The name of the brand\n\n> **Note:** You can't use the reserved `DRAPP_DOMAIN_BRAND` name.", + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "CreateBrandRequest", + "type": "object" + }, + "CreateGroupPushMappingRequest": { + "properties": { + "appConfig": { + "$ref": "#/components/schemas/AppConfig" + }, + "sourceGroupId": { + "description": "The ID of the source group for the group push mapping", + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/GroupPushMappingStatusUpsert", + "type": "string" + }, + "targetGroupId": { + "description": "The ID of the existing target group for the group push mapping. This is used to link to an existing group. Required if `targetGroupName` is not provided.", + "type": "string" + }, + "targetGroupName": { + "description": "The name of the target group for the group push mapping. This is used when creating a new downstream group. If the group already exists, it links to the existing group. Required if `targetGroupId` is not provided.", + "type": "string" + } + }, + "required": [ + "sourceGroupId" + ], + "type": "object" + }, + "CreateGroupRuleRequest": { + "properties": { + "actions": { + "$ref": "#/components/schemas/GroupRuleAction" + }, + "conditions": { + "$ref": "#/components/schemas/GroupRuleConditions" + }, + "name": { + "description": "Name of the group rule", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "type": { + "enum": [ + "group_rule" + ], + "type": "string" + } + }, + "type": "object" + }, + "CreateIamRoleRequest": { + "properties": { + "description": { + "description": "Description of the role", + "type": "string" + }, + "label": { + "description": "Unique label for the role", + "type": "string" + }, + "permissions": { + "description": "Array of permissions that the role grants. See [Permissions](/openapi/okta-management/guides/permissions).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "label", + "description", + "permissions" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "CreateOrUpdatePolicy": { + "discriminator": { + "mapping": { + "ACCESS_POLICY": "#/components/schemas/AccessPolicy", + "DEVICE_SIGNAL_COLLECTION": "#/components/schemas/DeviceSignalCollectionPolicy", + "MFA_ENROLL": "#/components/schemas/AuthenticatorEnrollmentPolicy", + "OKTA_SIGN_ON": "#/components/schemas/OktaSignOnPolicy", + "PASSWORD": "#/components/schemas/PasswordPolicy", + "PROFILE_ENROLLMENT": "#/components/schemas/ProfileEnrollmentPolicy" + }, + "propertyName": "type" + }, + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/PolicyLinks" + }, + "created": { + "default": "Assigned", + "description": "Timestamp when the policy was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "default": null, + "description": "Description of the policy", + "type": "string" + }, + "id": { + "default": "Assigned", + "description": "Identifier of the policy", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "default": "Assigned", + "description": "Timestamp when the policy was last modified", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the policy", + "type": "string" + }, + "priority": { + "default": "Last / Lowest Priority, for example `1`", + "description": "Specifies the order in which this policy is evaluated in relation to the other policies", + "type": "integer" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "Whether or not the policy is active. Use the `activate` query parameter to set the status of a policy." + } + ] + }, + "system": { + "default": false, + "description": "Specifies whether Okta created the policy", + "type": "boolean" + }, + "type": { + "$ref": "#/components/schemas/PolicyType" + } + }, + "required": [ + "name", + "type" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "CreateRealmAssignmentRequest": { + "properties": { + "actions": { + "$ref": "#/components/schemas/Actions" + }, + "conditions": { + "$ref": "#/components/schemas/Conditions" + }, + "name": { + "description": "Name of the realm", + "type": "string" + }, + "priority": { + "description": "The priority of the realm assignment. The lower the number, the higher the priority. This helps resolve conflicts between realm assignments.\n> **Note:** When you create realm assignments in bulk, realm assignment priorities must be unique.", + "type": "integer" + } + }, + "type": "object" + }, + "CreateRealmRequest": { + "properties": { + "profile": { + "$ref": "#/components/schemas/RealmProfile" + } + }, + "type": "object" + }, + "CreateResourceSetRequest": { + "properties": { + "description": { + "description": "Description of the resource set", + "type": "string" + }, + "label": { + "description": "Unique name for the resource set", + "type": "string" + }, + "resources": { + "description": "The endpoint (URL) that references all resource objects included in the resource set. Resources are identified by either an Okta Resource Name (ORN) or by a REST URL format. See [Okta Resource Name](/openapi/okta-management/guides/roles/#okta-resource-name-orn).", + "items": { + "type": "string" + }, + "maximum": 1000, + "type": "array" + } + }, + "required": [ + "description", + "label", + "resources" + ], + "type": "object" + }, + "CreateSessionRequest": { + "properties": { + "sessionToken": { + "description": "The session token obtained during authentication", + "type": "string" + } + }, + "type": "object" + }, + "CreateUISchema": { + "description": "The request body properties for the new UI Schema", + "properties": { + "uiSchema": { + "$ref": "#/components/schemas/UISchemaObject" + } + }, + "type": "object" + }, + "CreateUpdateIamRolePermissionRequest": { + "properties": { + "conditions": { + "$ref": "#/components/schemas/PermissionConditions" + } + }, + "type": "object" + }, + "CreateUserRequest": { + "properties": { + "credentials": { + "$ref": "#/components/schemas/UserCredentialsWritable" + }, + "groupIds": { + "description": "The list of group IDs of groups that the user is added to at the time of creation", + "items": { + "type": "string" + }, + "type": "array" + }, + "profile": { + "$ref": "#/components/schemas/UserProfile" + }, + "realmId": { + "description": "The ID of the realm in which the user is residing. See [Realms](/openapi/okta-management/management/tags/realm).", + "example": "guo1bfiNtSnZYILxO0g4", + "type": "string" + }, + "type": { + "description": "The ID of the user type. Add this value if you want to create a user with a non-default [User Type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/).\nThe user type determines which [schema](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/) applies to that user. After a user has been created, the user can\nonly be assigned a different user type by an administrator through a full replacement (`PUT`) operation.", + "properties": { + "id": { + "description": "The ID of the user type", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "profile" + ], + "type": "object" + }, + "Created": { + "description": "Timestamp when the object was created", + "example": "2016-01-03T18:15:47.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "CredentialSyncInfo": { + "properties": { + "errorCode": { + "description": "The error code for the type of error", + "readOnly": true, + "type": "string" + }, + "errorReason": { + "description": "A short description of the error", + "readOnly": true, + "type": "string" + }, + "secretVersionId": { + "description": "The version ID of the password secret from the OPA vault.", + "example": "9f8400-e29b-41d4-a716-926655440034", + "maxLength": 36, + "minLength": 1, + "type": "string" + }, + "syncState": { + "$ref": "#/components/schemas/CredentialSyncState" + }, + "syncTime": { + "description": "Timestamp when the credential was changed", + "example": "2024-06-10T11:30:01.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CredentialSyncState": { + "description": "Current credential sync status of the privileged resource", + "enum": [ + "NOT_SYNCED", + "SYNCED", + "SYNCING", + "SYNC_FAILED" + ], + "readOnly": true, + "type": "string", + "x-enumDescriptions": { + "NOT_SYNCED": "Credentials are not yet synced", + "SYNCED": "Credentials are successfully synced", + "SYNCING": "Credentials are currently being synced", + "SYNC_FAILED": "Credential sync failed" + } + }, + "Csr": { + "properties": { + "_links": { + "$ref": "#/components/schemas/CSRLinks", + "nullable": false, + "readOnly": true + }, + "created": { + "$ref": "#/components/schemas/createdProperty" + }, + "csr": { + "example": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9/tKvvbFN59T4raoCs/78KRm4fSefHQOv1TKLXo4wTLbsqYWRWc5u0sd5orUMQgPQOyj3i6qh13mALY4BzrT057EG1BUNjGg29QgYlnOk2iX890e5BIDMQQEIKFrvOi2V8cLUkLvE2ydRn0VO1Q1frbUkYeStJYC5Api2JQsYRwa+1ZeDH1ITnIzUaugWhW2WB2lSnwZkenne5KtffxMPYVu+IhNRHoKaRA6Z51YNhMJIx17JM2hs/H4Ka3drk6kzDf7ofk/yBpb9yBWyU7CTSQhdoHidxqFprMDaT66W928t3AeOENHBuwn8c2K9WeGG+bELNyQRJVmawIDAQABoCowKAYJKoZIhvcNAQkOMRswGTAXBgNVHREEEDAOggxkZXYub2t0YS5jb20wDQYJKoZIhvcNAQELBQADggEBAA2hsVJRVM+A83X9MekjTnIbt19UNT8wX7wlE9jUKirWsxceLiZBpVGn9qfKhhVIpvdaIRSeoFYS2Kg/m1G6bCvjmZLcrQ5FcEBjZH2NKfNppGVnfC2ugtUkBtCB+UUzOhKhRKJtGugenKbP33zRWWIqnd2waF6Cy8TIuqQVPbwEDN9bCbAs7ND6CFYNguY7KYjWzQOeAR716eqpEEXuPYAS4nx/ty4ylonR8cv+gpq51rvq80A4k/36aoeM0Y6I4w64vhTfuvWW2UYFUD+/+y2FA2CSP4JfctySrf1s525v6fzTFZ3qZbB5OZQtP2b8xYWktMzywsxGKDoVDB4wkH4=", + "readOnly": true, + "type": "string" + }, + "id": { + "example": "h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50", + "readOnly": true, + "type": "string" + }, + "kty": { + "example": "RSA", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CsrMetadata": { + "properties": { + "subject": { + "$ref": "#/components/schemas/CsrMetadataSubject" + }, + "subjectAltNames": { + "$ref": "#/components/schemas/CsrMetadataSubjectAltNames" + } + }, + "type": "object" + }, + "CsrMetadataSubject": { + "properties": { + "commonName": { + "description": "Common name of the subject", + "example": "SP Issuer", + "type": "string" + }, + "countryName": { + "description": "Country name or code", + "example": "US", + "type": "string" + }, + "localityName": { + "description": "Locality (city) name", + "example": "San Francisco", + "type": "string" + }, + "organizationName": { + "description": "Large organization name", + "example": "Okta, Inc.", + "type": "string" + }, + "organizationalUnitName": { + "description": "Name of the smaller organization, for example, the department or the division", + "example": "Dev", + "type": "string" + }, + "stateOrProvinceName": { + "description": "State or province name", + "example": "California", + "type": "string" + } + }, + "type": "object" + }, + "CsrMetadataSubjectAltNames": { + "properties": { + "dnsNames": { + "description": "DNS names of the subject", + "items": { + "example": "dev.okta.com", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CsrPublishHrefHints": { + "description": "Describes allowed HTTP verbs for the `href`", + "properties": { + "allow": { + "items": { + "enum": [ + "POST" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CsrSelfHrefHints": { + "description": "Describes allowed HTTP verbs for the `href`", + "properties": { + "allow": { + "items": { + "enum": [ + "GET", + "DELETE" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomAAGUIDCreateRequestObject": { + "properties": { + "aaguid": { + "description": "An Authenticator Attestation Global Unique Identifier (AAGUID) is a 128-bit identifier indicating the model.", + "type": "string" + }, + "attestationRootCertificates": { + "$ref": "#/components/schemas/AttestationRootCertificatesRequest" + }, + "authenticatorCharacteristics": { + "$ref": "#/components/schemas/AAGUIDAuthenticatorCharacteristics" + } + }, + "type": "object" + }, + "CustomAAGUIDResponseObject": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "aaguid": { + "description": "A unique 128-bit identifier that's assigned to a specific model of security key or authenticator", + "type": "string" + }, + "attestationRootCertificates": { + "$ref": "#/components/schemas/AttestationRootCertificatesResponse" + }, + "authenticatorCharacteristics": { + "$ref": "#/components/schemas/AAGUIDAuthenticatorCharacteristics" + }, + "name": { + "description": "The product name associated with the AAGUID", + "type": "string" + } + }, + "type": "object" + }, + "CustomAAGUIDUpdateRequestObject": { + "properties": { + "attestationRootCertificates": { + "$ref": "#/components/schemas/AttestationRootCertificatesRequest" + }, + "authenticatorCharacteristics": { + "$ref": "#/components/schemas/AAGUIDAuthenticatorCharacteristics" + }, + "name": { + "description": "The product name associated with this AAGUID.", + "type": "string" + } + }, + "type": "object" + }, + "CustomAppUserVerificationEnum": { + "description": "User verification setting", + "enum": [ + "PREFERRED", + "REQUIRED" + ], + "type": "string" + }, + "CustomAuthSettings": { + "description": "Set of AIPs used for authType `CUSTOM`", + "properties": { + "appInstanceProperties": { + "items": { + "$ref": "#/components/schemas/AppInstanceProperty" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomRole": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksCustomRoleResponse" + }, + "assignmentType": { + "$ref": "#/components/schemas/RoleAssignmentType" + }, + "created": { + "description": "Timestamp when the object was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Binding object ID", + "readOnly": true, + "type": "string" + }, + "label": { + "description": "Label for the role assignment", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the object was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resource-set": { + "description": "Resource set ID", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role ID", + "readOnly": true, + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "Status of the role assignment" + } + ] + }, + "type": { + "$ref": "#/components/schemas/RoleType" + } + }, + "required": [ + "type" + ], + "title": "Custom role assignment", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "CustomRoleAssignmentSchema": { + "properties": { + "resource-set": { + "description": "Resource set ID", + "type": "string" + }, + "role": { + "description": "Custom role ID", + "type": "string" + }, + "type": { + "description": "Specify a [standard admin role](/openapi/okta-management/guides/roles/#standard-roles), an [IAM-based standard role](/openapi/okta-management/guides/roles/#iam-based-standard-roles), or `CUSTOM` for a custom role type:", + "enum": [ + "CUSTOM" + ], + "type": "string" + } + }, + "required": [ + "type", + "role", + "resource-set" + ], + "title": "Custom Role", + "type": "object" + }, + "CustomTelephonyProviderCredentialCreateRequest": { + "description": "Create custom telephony provider credentials", + "properties": { + "providerAuthToken": { + "description": "The authentication token that's used to authenticate requests to the telephony provider. Your telephony provider gives you this token.", + "type": "string" + }, + "providerCapability": { + "description": "The types of telephony operations (SMS or Voice) that you use with your telephony provider.\n\n`ALL` is the only valid value. It indicates that your provider can handle both SMS messages and voice calls. You're not required to use both types of telephony operations, but your provider can support both.", + "enum": [ + "ALL" + ], + "type": "string" + }, + "providerName": { + "description": "The name of the telephony provider", + "enum": [ + "TWILIO", + "TELESIGN" + ], + "type": "string" + }, + "providerSettings": { + "$ref": "#/components/schemas/CustomTelephonyProviderSettings" + }, + "providerSid": { + "description": "The account string identifier (SID) for your telephony provider account. Your telephony provider gives you this SID.", + "type": "string" + } + } + }, + "CustomTelephonyProviderCredentialResponse": { + "properties": { + "enabled": { + "description": "Indicates whether the provider is enabled and can be used", + "type": "boolean" + }, + "id": { + "description": "ID of the custom telephony provider", + "type": "string" + }, + "isPrimaryProvider": { + "description": "Indicates whether the provider is the primary telephony provider", + "type": "boolean" + }, + "providerCapability": { + "description": "The types of telephony operations (SMS or Voice) that you use with your telephony provider.\n\n`ALL` is the only valid value. It indicates that your provider can handle both SMS messages and voice calls. You're not required to use both types of telephony operations, but your provider can support both.", + "enum": [ + "ALL" + ], + "type": "string" + }, + "providerName": { + "description": "Name of the telephony provider", + "enum": [ + "TWILIO", + "TELESIGN" + ], + "type": "string" + }, + "providerSettings": { + "$ref": "#/components/schemas/CustomTelephonyProviderSettings" + }, + "providerSid": { + "description": "The account string identifier (SID) for your telephony provider account. Your telephony provider gives you this SID.", + "type": "string" + } + }, + "type": "object" + }, + "CustomTelephonyProviderCredentialSendTestRequest": { + "properties": { + "countryCodeIso2": { + "description": "The country code for the phone number.\nUse the [Alpha-2 code from ISO 3166-1](https://www.iso.org/obp/ui/#search) for country codes.", + "type": "string" + }, + "factor": { + "description": "The type of test message to send", + "enum": [ + "SMS", + "CALL" + ], + "type": "string" + }, + "phoneNumber": { + "description": "The phone number to which the test message or call is sent", + "type": "string" + } + }, + "type": "object" + }, + "CustomTelephonyProviderCredentialUpdateRequest": { + "description": "Update custom telephony provider credentials", + "properties": { + "id": { + "description": "ID of the custom telephony provider", + "type": "string" + }, + "providerAuthToken": { + "description": "The authentication token that's used to authenticate requests to the telephony provider. Your telephony provider gives you this token.", + "type": "string" + }, + "providerSettings": { + "$ref": "#/components/schemas/CustomTelephonyProviderSettings" + }, + "providerSid": { + "description": "The account string identifier (SID) for your telephony provider account. Your telephony provider gives you this SID.", + "type": "string" + } + }, + "type": "object" + }, + "CustomTelephonyProviderCredentialsResponse": { + "description": "Response for credentials of multiple custom telephony providers", + "items": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialResponse" + }, + "type": "array" + }, + "CustomTelephonyProviderSettings": { + "description": "Settings for custom telephony provider.\n\nThese settings vary based on the telephony provider and the type of telephony operation (SMS or Voice). For `sms` and `call`, you can select one method per telephony operation (`sms` and `call`) for sending messages or voice calls.\n\n> **Note:** Configure your telephony provider settings before selecting the methods for sending SMS messages or making voice calls. For example, if you select Twilio as your telephony provider, and you want to send SMS messages using Twilio's Verify Service, ensure that you have the Verify Service set up in your Twilio account. You can then use the `twilioVerifySid` field under `sms` to provide the necessary SID.", + "properties": { + "call": { + "description": "Method for making voice calls. Choose one method for making voice calls based on your telephony provider setup.", + "oneOf": [ + { + "$ref": "#/components/schemas/CustomTelephonyProviderSettingsTwilioVerify" + }, + { + "$ref": "#/components/schemas/CustomTelephonyProviderSettingsTwilioPhoneNumber" + }, + { + "$ref": "#/components/schemas/CustomTelephonyProviderSettingsTwilioCallerId" + }, + { + "$ref": "#/components/schemas/CustomTelephonyProviderSettingsTelesignServiceCall" + } + ] + }, + "sms": { + "description": "Method for sending SMS messages. Choose one method for sending SMS messages based on your telephony provider setup.", + "oneOf": [ + { + "$ref": "#/components/schemas/CustomTelephonyProviderSettingsTwilioVerify" + }, + { + "$ref": "#/components/schemas/CustomTelephonyProviderSettingsTwilioPhoneNumber" + }, + { + "$ref": "#/components/schemas/CustomTelephonyProviderSettingsTwilioMessagingService" + }, + { + "$ref": "#/components/schemas/CustomTelephonyProviderSettingsTelesignServiceSms" + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "CustomTelephonyProviderSettingsTelesignServiceCall": { + "properties": { + "telesignService": { + "description": "The Telesign service identifier used for sending making calls. You can find this value in your Telesign console.\n\nThe `telesignVerifyService` method uses Telesign's [Verify API](https://developer.telesign.com/enterprise/docs/verify-api-overview). And the `telesignVoiceService` method uses Telesign's [Voice API](https://developer.telesign.com/enterprise/docs/voice-overview).", + "enum": [ + "telesignVoiceService", + "telesignVerifyService" + ], + "type": "string" + } + }, + "title": "Telesign Service", + "type": "object" + }, + "CustomTelephonyProviderSettingsTelesignServiceSms": { + "properties": { + "telesignService": { + "description": "The Telesign service identifier used for sending SMS messages. You can find this value in your Telesign console.\n\nThe `telesignVerifyService` method uses Telesign's [Verify API](https://developer.telesign.com/enterprise/docs/verify-api-overview). And the `telesignMessagingService` method uses Telesign's [SMS](https://developer.telesign.com/enterprise/docs/voice-overview) and [Messaging](https://developer.telesign.com/enterprise/docs/messaging-overview) APIs.", + "enum": [ + "telesignMessagingService", + "telesignVerifyService" + ], + "type": "string" + } + }, + "title": "Telesign Service", + "type": "object" + }, + "CustomTelephonyProviderSettingsTwilioCallerId": { + "properties": { + "twilioCallerId": { + "description": "The Twilio caller ID that's used for making calls. You can find this value in your Twilio console.\n\nThis method uses Twilio's [Programmable Voice API](https://www.twilio.com/docs/voice).", + "type": "string" + } + }, + "title": "Twilio Caller ID", + "type": "object" + }, + "CustomTelephonyProviderSettingsTwilioMessagingService": { + "properties": { + "twilioMessageSid": { + "description": "The Twilio Messaging Service SID used for sending SMS messages. You can find this value in your Twilio console.\n\nThis method uses Twilio's [Programmable Messaging API](https://www.twilio.com/docs/messaging).", + "type": "string" + } + }, + "title": "Twilio Message SID", + "type": "object" + }, + "CustomTelephonyProviderSettingsTwilioPhoneNumber": { + "properties": { + "twilioPhoneNumber": { + "description": "The Twilio phone number that's used for sending SMS messages or voice calls. You can find this value in your Twilio console.\n\nThis method uses Twilio's [Programmable Messaging API](https://www.twilio.com/docs/messaging).", + "type": "string" + } + }, + "title": "Twilio Phone Number", + "type": "object" + }, + "CustomTelephonyProviderSettingsTwilioVerify": { + "properties": { + "twilioVerifySid": { + "description": "The Twilio Verify Service SID used for sending verification messages or calls. You can find this value in your Twilio console.\n\nThis method uses Twilio's [Verify API](https://www.twilio.com/docs/verify/api).", + "type": "string" + } + }, + "title": "Twilio Verify SID", + "type": "object" + }, + "CustomizablePage": { + "properties": { + "pageContent": { + "description": "The HTML for the page", + "type": "string" + } + }, + "type": "object" + }, + "DNSRecordAuthenticators": { + "description": "DNS TXT record that must be registered for an RP ID domain that requires verification. This is used to verify the domain ownership for the WebAuthn RP ID configuration. After the domain ownership is verified, the `DNSRecord` isn't returned in the response.", + "properties": { + "fqdn": { + "description": "The DNS record name", + "example": "_oktaverification.mycustomdomain.com", + "type": "string" + }, + "recordType": { + "$ref": "#/components/schemas/DNSRecordTypeAuthenticators" + }, + "verificationValue": { + "description": "The DNS record verification value", + "example": [ + "79496f234c814638b1cc44f51a782781" + ], + "type": "string" + } + }, + "type": "object" + }, + "DNSRecordDomains": { + "description": "DNS records to be registered for the domain", + "properties": { + "expiration": { + "description": "DNS TXT record expiration", + "type": "string" + }, + "fqdn": { + "description": "DNS record name", + "example": "_oktaverification.login.example.com", + "type": "string" + }, + "recordType": { + "$ref": "#/components/schemas/DNSRecordTypeDomains" + }, + "values": { + "description": "DNS record value", + "example": [ + "79496f234c814638b1cc44f51a782781" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DNSRecordTypeAuthenticators": { + "enum": [ + "TXT" + ], + "example": "TXT", + "type": "string" + }, + "DNSRecordTypeDomains": { + "enum": [ + "CAA", + "CNAME", + "TXT" + ], + "example": "TXT", + "type": "string" + }, + "DRStatusItem": { + "description": "Status whether a domain has been failed over or not", + "properties": { + "domain": { + "description": "Domain for your org", + "type": "string" + }, + "isFailedOver": { + "description": "Indicates if the domain has been failed over", + "nullable": false, + "type": "boolean" + } + }, + "type": "object" + }, + "DTCChromeOS": { + "description": "Google Chrome Device Trust Connector provider", + "properties": { + "allowScreenLock": { + "description": "Indicates whether the AllowScreenLock enterprise policy is enabled", + "type": "boolean" + }, + "browserVersion": { + "$ref": "#/components/schemas/ChromeBrowserVersion" + }, + "builtInDnsClientEnabled": { + "description": "Indicates if a software stack is used to communicate with the DNS server", + "type": "boolean" + }, + "chromeRemoteDesktopAppBlocked": { + "description": "Indicates whether access to the Chrome Remote Desktop application is blocked through a policy", + "type": "boolean" + }, + "deviceEnrollmentDomain": { + "description": "Enrollment domain of the customer that is currently managing the device", + "type": "string" + }, + "diskEncrypted": { + "description": "Indicates whether the main disk is encrypted", + "type": "boolean" + }, + "keyTrustLevel": { + "$ref": "#/components/schemas/KeyTrustLevelOSMode" + }, + "managedDevice": { + "description": "Indicates whether the device is enrolled in ChromeOS device management", + "type": "boolean" + }, + "osFirewall": { + "description": "Indicates whether a firewall is enabled at the OS-level on the device", + "type": "boolean" + }, + "osVersion": { + "$ref": "#/components/schemas/OSVersionFourComponents" + }, + "passwordProtectionWarningTrigger": { + "$ref": "#/components/schemas/PasswordProtectionWarningTrigger" + }, + "realtimeUrlCheckMode": { + "description": "Indicates whether enterprise-grade (custom) unsafe URL scanning is enabled", + "type": "boolean" + }, + "safeBrowsingProtectionLevel": { + "$ref": "#/components/schemas/SafeBrowsingProtectionLevel" + }, + "screenLockSecured": { + "description": "Indicates whether the device is password-protected", + "type": "boolean" + }, + "siteIsolationEnabled": { + "description": "Indicates whether the Site Isolation (also known as **Site Per Process**) setting is enabled", + "type": "boolean" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DTCMacOS": { + "description": "Google Chrome Device Trust Connector provider", + "properties": { + "browserVersion": { + "$ref": "#/components/schemas/ChromeBrowserVersion" + }, + "builtInDnsClientEnabled": { + "description": "Indicates if a software stack is used to communicate with the DNS server", + "type": "boolean" + }, + "chromeRemoteDesktopAppBlocked": { + "description": "Indicates whether access to the Chrome Remote Desktop application is blocked through a policy", + "type": "boolean" + }, + "deviceEnrollmentDomain": { + "description": "Enrollment domain of the customer that is currently managing the device", + "type": "string" + }, + "diskEncrypted": { + "description": "Indicates whether the main disk is encrypted", + "type": "boolean" + }, + "keyTrustLevel": { + "$ref": "#/components/schemas/KeyTrustLevelBrowserKey" + }, + "osFirewall": { + "description": "Indicates whether a firewall is enabled at the OS-level on the device", + "type": "boolean" + }, + "osVersion": { + "$ref": "#/components/schemas/OSVersionThreeComponents" + }, + "passwordProtectionWarningTrigger": { + "$ref": "#/components/schemas/PasswordProtectionWarningTrigger" + }, + "realtimeUrlCheckMode": { + "description": "Indicates whether enterprise-grade (custom) unsafe URL scanning is enabled", + "type": "boolean" + }, + "safeBrowsingProtectionLevel": { + "$ref": "#/components/schemas/SafeBrowsingProtectionLevel" + }, + "screenLockSecured": { + "description": "Indicates whether the device is password-protected", + "type": "boolean" + }, + "siteIsolationEnabled": { + "description": "Indicates whether the Site Isolation (also known as **Site Per Process**) setting is enabled", + "type": "boolean" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DTCWindows": { + "description": "Google Chrome Device Trust Connector provider", + "properties": { + "antivirusEnabled": { + "description": "Indicates whether antivirus software is enabled", + "type": "boolean" + }, + "browserVersion": { + "$ref": "#/components/schemas/ChromeBrowserVersion" + }, + "builtInDnsClientEnabled": { + "description": "Indicates if a software stack is used to communicate with the DNS server", + "type": "boolean" + }, + "chromeRemoteDesktopAppBlocked": { + "description": "Indicates whether access to the Chrome Remote Desktop application is blocked through a policy", + "type": "boolean" + }, + "crowdStrikeAgentId": { + "description": "Agent ID of an installed CrowdStrike agent", + "type": "string" + }, + "crowdStrikeCustomerId": { + "description": "Customer ID of an installed CrowdStrike agent", + "type": "string" + }, + "deviceEnrollmentDomain": { + "description": "Enrollment domain of the customer that is currently managing the device", + "type": "string" + }, + "diskEncrypted": { + "description": "Indicates whether the main disk is encrypted", + "type": "boolean" + }, + "keyTrustLevel": { + "$ref": "#/components/schemas/KeyTrustLevelBrowserKey" + }, + "osFirewall": { + "description": "Indicates whether a firewall is enabled at the OS-level on the device", + "type": "boolean" + }, + "osVersion": { + "$ref": "#/components/schemas/OSVersionFourComponents" + }, + "passwordProtectionWarningTrigger": { + "$ref": "#/components/schemas/PasswordProtectionWarningTrigger" + }, + "realtimeUrlCheckMode": { + "description": "Indicates whether enterprise-grade (custom) unsafe URL scanning is enabled", + "type": "boolean" + }, + "safeBrowsingProtectionLevel": { + "$ref": "#/components/schemas/SafeBrowsingProtectionLevel" + }, + "screenLockSecured": { + "description": "Indicates whether the device is password-protected", + "type": "boolean" + }, + "secureBootEnabled": { + "description": "Indicates whether the device's startup software has its Secure Boot feature enabled", + "type": "boolean" + }, + "siteIsolationEnabled": { + "description": "Indicates whether the Site Isolation (also known as **Site Per Process**) setting is enabled", + "type": "boolean" + }, + "thirdPartyBlockingEnabled": { + "deprecated": true, + "description": "Indicates whether Chrome is blocking third-party software injection", + "type": "boolean" + }, + "windowsMachineDomain": { + "description": "Windows domain that the current machine has joined", + "type": "string" + }, + "windowsUserDomain": { + "description": "Windows domain for the current OS user", + "type": "string" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "DateTime": { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) formatted date and time.", + "example": "2024-12-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "DbscCredential": { + "properties": { + "attributes": { + "description": "Cookie attributes", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Cookie name", + "enum": [ + "dbsc" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Credential type", + "enum": [ + "cookie" + ], + "readOnly": true, + "type": "string" + } + }, + "required": [ + "type", + "name", + "attributes" + ], + "type": "object" + }, + "DbscRefreshResponse": { + "properties": { + "credentials": { + "items": { + "$ref": "#/components/schemas/DbscCredential" + }, + "readOnly": true, + "type": "array" + }, + "refresh_url": { + "description": "URL to call for cookie refresh", + "example": "/idp/dbsc/refresh", + "readOnly": true, + "type": "string" + }, + "scope": { + "$ref": "#/components/schemas/DbscScope" + }, + "session_identifier": { + "description": "The session identifier for this DBSC binding", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "session_identifier", + "refresh_url", + "scope", + "credentials" + ], + "type": "object" + }, + "DbscScope": { + "properties": { + "include_site": { + "description": "Whether to include subdomains in the binding scope (`false` = exact origin only, `true` = includes subdomains)", + "readOnly": true, + "type": "boolean" + }, + "origin": { + "description": "The origin URL for which the DBSC binding is valid", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "origin", + "include_site" + ], + "type": "object" + }, + "DbscStartResponse": { + "properties": { + "credentials": { + "items": { + "$ref": "#/components/schemas/DbscCredential" + }, + "readOnly": true, + "type": "array" + }, + "refresh_url": { + "description": "URL to call for cookie refresh", + "readOnly": true, + "type": "string" + }, + "scope": { + "$ref": "#/components/schemas/DbscScope" + }, + "session_identifier": { + "description": "The session identifier for this DBSC binding. Use this value in the `Sec-Secure-Session-Id` header for refresh requests.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "session_identifier", + "refresh_url", + "scope", + "credentials" + ], + "type": "object" + }, + "DefaultApp": { + "properties": { + "appInstanceId": { + "description": "ID for the App instance", + "type": "string" + }, + "appLinkName": { + "description": "Name for the app instance", + "type": "string" + }, + "classicApplicationUri": { + "description": "Application URI for classic Orgs", + "type": "string" + } + }, + "type": "object" + }, + "DesktopMFAEnforceNumberMatchingChallengeOrgSetting": { + "properties": { + "desktopMFAEnforceNumberMatchingChallengeEnabled": { + "default": false, + "description": "Indicates whether or not the Desktop MFA Enforce Number Matching Challenge push notifications feature is enabled", + "type": "boolean" + } + }, + "type": "object" + }, + "DesktopMFARecoveryPinOrgSetting": { + "properties": { + "desktopMFARecoveryPinEnabled": { + "default": false, + "description": "Indicates whether or not the Desktop MFA Recovery PIN feature is enabled", + "type": "boolean" + } + }, + "type": "object" + }, + "DetailedHookKeyInstance": { + "description": "A key object with public key details", + "properties": { + "_embedded": { + "$ref": "#/components/schemas/_embedded" + }, + "created": { + "description": "Timestamp when the key was created", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The unique Okta ID of this key record", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "isUsed": { + "description": "Whether this key is currently in use by other applications", + "format": "boolean", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "keyId": { + "description": "The alias of the public key", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the key was updated", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Display name of the key", + "maxLength": 255, + "minLength": 1, + "nullable": false, + "readOnly": false, + "type": "string" + } + }, + "title": "DetailedHookKeyInstance", + "type": "object" + }, + "DetectedRiskEvents": { + "enum": [ + "ADMIN_REPORTED_USER_RISK", + "BRUTE_FORCE_ATTACK", + "ENTITY_CRITICAL_ACTION_FROM_HIGH_THREAT_IP", + "OKTA_THREAT_INTELLIGENCE", + "SECURITY_EVENTS_PROVIDER_REPORTED_RISK", + "SESSION_INFLUENCED_USER_RISK", + "SUSPICIOUS_APP_ACCESS", + "USER_REPORTED_SUSPICIOUS_ACTIVITY" + ], + "type": "string" + }, + "Device": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelfAndFullUsersLifecycle" + }, + "created": { + "description": "Timestamp when the device was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique key for the device", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the device record was last updated. Updates occur when Okta collects and saves device signals during authentication, and when the lifecycle state of the device changes.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/DeviceProfile" + }, + "resourceAlternateId": { + "readOnly": true, + "type": "string" + }, + "resourceDisplayName": { + "$ref": "#/components/schemas/DeviceDisplayName" + }, + "resourceId": { + "description": "Alternate key for the `id`", + "readOnly": true, + "type": "string" + }, + "resourceType": { + "default": "UDDevice", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/DeviceStatus" + } + }, + "type": "object" + }, + "DeviceAccessPolicyRuleCondition": { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle> Specifies the device condition to match on", + "properties": { + "assurance": { + "$ref": "#/components/schemas/DevicePolicyRuleConditionAssurance" + }, + "managed": { + "description": "Indicates if the device is managed. A device is considered managed if it's part of a device management system.", + "type": "boolean" + }, + "registered": { + "description": "Indicates if the device is registered. A device is registered if the User enrolls with Okta Verify that's installed on the device.\nWhen the `managed` property is passed, you must also include the `registered` property and set it to `true`.\n", + "type": "boolean" + } + }, + "type": "object" + }, + "DeviceAssurance": { + "discriminator": { + "mapping": { + "ANDROID": "#/components/schemas/DeviceAssuranceAndroidPlatform", + "CHROMEOS": "#/components/schemas/DeviceAssuranceChromeOSPlatform", + "IOS": "#/components/schemas/DeviceAssuranceIOSPlatform", + "MACOS": "#/components/schemas/DeviceAssuranceMacOSPlatform", + "WINDOWS": "#/components/schemas/DeviceAssuranceWindowsPlatform" + }, + "propertyName": "platform" + }, + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "createdBy": { + "readOnly": true, + "type": "string" + }, + "createdDate": { + "readOnly": true, + "type": "string" + }, + "devicePostureChecks": { + "$ref": "#/components/schemas/DevicePostureChecks" + }, + "displayRemediationMode": { + "description": "Represents the remediation mode of this device assurance policy when users are denied access due to device noncompliance", + "enum": [ + "HIDE", + "SHOW" + ], + "example": "SHOW", + "type": "string", + "x-enumDescriptions": { + "HIDE": "Hide remediation instructions in the Sign-In Widget", + "SHOW": "Display remediation instructions in the Sign-In Widget" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "gracePeriod": { + "$ref": "#/components/schemas/GracePeriod" + }, + "id": { + "readOnly": true, + "type": "string" + }, + "lastUpdate": { + "readOnly": true, + "type": "string" + }, + "lastUpdatedBy": { + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Display name of the device assurance policy", + "type": "string" + }, + "platform": { + "$ref": "#/components/schemas/Platform" + } + }, + "title": "DeviceAssurance", + "type": "object" + }, + "DeviceAssuranceAndroidPlatform": { + "allOf": [ + { + "$ref": "#/components/schemas/DeviceAssurance" + }, + { + "properties": { + "callerContext": { + "$ref": "#/components/schemas/CallerContext" + }, + "diskEncryptionType": { + "properties": { + "include": { + "items": { + "$ref": "#/components/schemas/DiskEncryptionTypeAndroid" + }, + "type": "array" + } + }, + "type": "object" + }, + "jailbreak": { + "type": "boolean" + }, + "osVersion": { + "$ref": "#/components/schemas/OSVersion" + }, + "screenLockType": { + "properties": { + "include": { + "items": { + "$ref": "#/components/schemas/ScreenLockType" + }, + "type": "array" + } + }, + "type": "object" + }, + "secureHardwarePresent": { + "type": "boolean" + }, + "thirdPartySignalProviders": { + "description": "Settings for third-party signal providers (based on the `ANDROID` platform)", + "properties": { + "androidDeviceTrust": { + "$ref": "#/components/schemas/AndroidDeviceTrust" + }, + "devicePostureIdP": { + "$ref": "#/components/schemas/DevicePostureIdP" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DeviceAssuranceChromeOSPlatform": { + "allOf": [ + { + "$ref": "#/components/schemas/DeviceAssurance" + }, + { + "properties": { + "thirdPartySignalProviders": { + "description": "Settings for third-party signal providers (based on the `CHROMEOS` platform)", + "properties": { + "devicePostureIdP": { + "$ref": "#/components/schemas/DevicePostureIdP" + }, + "dtc": { + "$ref": "#/components/schemas/DTCChromeOS" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DeviceAssuranceIOSPlatform": { + "allOf": [ + { + "$ref": "#/components/schemas/DeviceAssurance" + }, + { + "properties": { + "jailbreak": { + "type": "boolean" + }, + "osVersion": { + "$ref": "#/components/schemas/OSVersion" + }, + "screenLockType": { + "properties": { + "include": { + "items": { + "$ref": "#/components/schemas/ScreenLockType" + }, + "type": "array" + } + }, + "type": "object" + }, + "thirdPartySignalProviders": { + "description": "Settings for third-party signal providers (based on the `IOS` platform)", + "properties": { + "devicePostureIdP": { + "$ref": "#/components/schemas/DevicePostureIdP" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DeviceAssuranceMacOSPlatform": { + "allOf": [ + { + "$ref": "#/components/schemas/DeviceAssurance" + }, + { + "properties": { + "diskEncryptionType": { + "properties": { + "include": { + "items": { + "$ref": "#/components/schemas/DiskEncryptionTypeDesktop" + }, + "type": "array" + } + }, + "type": "object" + }, + "osVersion": { + "$ref": "#/components/schemas/OSVersion" + }, + "screenLockType": { + "properties": { + "include": { + "items": { + "$ref": "#/components/schemas/ScreenLockType" + }, + "type": "array" + } + }, + "type": "object" + }, + "secureHardwarePresent": { + "type": "boolean" + }, + "thirdPartySignalProviders": { + "description": "Settings for third-party signal providers (based on the `MACOS` platform)", + "properties": { + "devicePostureIdP": { + "$ref": "#/components/schemas/DevicePostureIdP" + }, + "dtc": { + "$ref": "#/components/schemas/DTCMacOS" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DeviceAssuranceWindowsPlatform": { + "allOf": [ + { + "$ref": "#/components/schemas/DeviceAssurance" + }, + { + "properties": { + "diskEncryptionType": { + "properties": { + "include": { + "items": { + "$ref": "#/components/schemas/DiskEncryptionTypeDesktop" + }, + "type": "array" + } + }, + "type": "object" + }, + "osVersion": { + "$ref": "#/components/schemas/OSVersionFourComponents" + }, + "osVersionConstraints": { + "description": "Specifies the Windows version requirements for the assurance policy. Each requirement must correspond to a different major version (Windows 11 or Windows 10). If a requirement isn't specified for a major version, then devices on that major version satisfy the condition.\n\nThere are two types of OS requirements:\n* **Static**: A specific Windows version requirement that doesn't change until you update the policy. A static OS Windows requirement is specified with `majorVersionConstraint` and `minimum`.\n* **Dynamic**: A Windows version requirement that is relative to the latest major release and security patch. A dynamic OS Windows requirement is specified with `majorVersionConstraint` and `dynamicVersionRequirement`.\n\n> **Note:** Dynamic OS requirements are available only if the **Dynamic OS version compliance** [self-service EA](/openapi/okta-management/guides/release-lifecycle/#early-access-ea) feature is enabled. The `osVersionConstraints` property is only supported for the Windows platform. You can't specify both `osVersion.minimum` and `osVersionConstraints` properties at the same time.\n", + "items": { + "$ref": "#/components/schemas/OSVersionConstraint" + }, + "maxItems": 2, + "minItems": 1, + "type": "array", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "screenLockType": { + "properties": { + "include": { + "items": { + "$ref": "#/components/schemas/ScreenLockType" + }, + "type": "array" + } + }, + "type": "object" + }, + "secureHardwarePresent": { + "type": "boolean" + }, + "thirdPartySignalProviders": { + "description": "Settings for third-party signal providers (based on the `WINDOWS` platform)", + "properties": { + "devicePostureIdP": { + "$ref": "#/components/schemas/DevicePostureIdP" + }, + "dtc": { + "$ref": "#/components/schemas/DTCWindows" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DeviceContextProvider": { + "properties": { + "id": { + "description": "Unique identifier for the device context provider", + "type": "string" + }, + "key": { + "description": "Identifies the type of device context provider", + "enum": [ + "OKTA_VERIFY", + "CHROME_DEVICE_TRUST", + "DEVICE_POSTURE_IDP" + ], + "type": "string" + }, + "userIdentification": { + "description": "Whether or not the device context provider is used to identify the user. `IGNORE` prevents the device context provider from being used to authenticate the user. Identification of the device and device context collection happens regardless of this setting.", + "enum": [ + "ALLOW", + "IGNORE" + ], + "type": "string" + } + }, + "required": [ + "key" + ], + "type": "object" + }, + "DeviceDisplayName": { + "description": "Display name of the device", + "properties": { + "sensitive": { + "default": false, + "description": "Indicates whether the associated value is Personal Identifiable Information (PII) and requires masking", + "type": "boolean" + }, + "value": { + "description": "Display name of the device", + "type": "string" + } + }, + "type": "object" + }, + "DeviceIntegrations": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + }, + "displayName": { + "description": "The display name of the device integration", + "type": "string" + }, + "id": { + "description": "The ID of the device integration", + "readOnly": true, + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/DeviceIntegrationsMetadata" + }, + "name": { + "$ref": "#/components/schemas/DeviceIntegrationsName" + }, + "platform": { + "$ref": "#/components/schemas/DeviceIntegrationsPlatform" + }, + "status": { + "$ref": "#/components/schemas/DeviceIntegrationsStatus" + } + }, + "title": "DeviceIntegrations", + "type": "object" + }, + "DeviceIntegrationsMetadata": { + "description": "The metadata of the device integration", + "oneOf": [ + { + "properties": { + "serviceAccountEmail": { + "type": "string" + }, + "serviceAccountName": { + "type": "string" + }, + "type": { + "enum": [ + "CHROME" + ], + "type": "string" + } + }, + "required": [ + "type", + "serviceAccountName", + "serviceAccountEmail" + ], + "type": "object" + }, + { + "properties": { + "enrollmentUrl": { + "type": "string" + }, + "idpId": { + "type": "string" + }, + "provider": { + "type": "string" + }, + "type": { + "enum": [ + "WORKSPACE_ONE" + ], + "type": "string" + } + }, + "required": [ + "type", + "provider", + "enrollmentUrl", + "idpId" + ], + "type": "object" + }, + { + "properties": { + "idpId": { + "type": "string" + }, + "type": { + "enum": [ + "DEVICE_IDP" + ], + "type": "string" + } + }, + "required": [ + "type", + "idpId" + ], + "type": "object" + } + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "DeviceIntegrationsName": { + "description": "The namespace of the device integration", + "enum": [ + "com.android.zero.trust", + "com.crowdstrike.zta", + "com.google.dtc", + "com.okta.device.osquery", + "com.okta.deviceidp", + "com.okta.windowssecuritycenter", + "com.okta.workspaceone" + ], + "type": "string" + }, + "DeviceIntegrationsPlatform": { + "enum": [ + "ANDROID", + "CHROMEOS", + "IOS", + "MACOS", + "WINDOWS" + ], + "type": "string" + }, + "DeviceIntegrationsStatus": { + "description": "The status of the device integration", + "enum": [ + "ACTIVE", + "DEACTIVATED" + ], + "type": "string" + }, + "DeviceIntegrity": { + "description": "Indicates how well a device can enforce app integrity", + "enum": [ + "MEETS_BASIC_INTEGRITY", + "MEETS_DEVICE_INTEGRITY", + "MEETS_STRONG_INTEGRITY" + ], + "type": "string", + "x-enumDescriptions": { + "MEETS_BASIC_INTEGRITY": "The app is running on a device that passes basic system integrity checks. The device may not meet Android compatibility requirements and may not be approved to run Google Play services.", + "MEETS_DEVICE_INTEGRITY": "The app is running on an Android-powered device with Google Play services. The device passes system integrity checks and meets Android compatibility requirements.", + "MEETS_STRONG_INTEGRITY": "The app is running on an Android-powered device with Google Play services. It has a strong guarantee of system integrity such as a hardware-backed proof of boot integrity. The device passes system integrity checks and meets Android compatibility requirements." + } + }, + "DeviceList": { + "allOf": [ + { + "$ref": "#/components/schemas/Device" + }, + { + "properties": { + "_embedded": { + "description": "List of associated users for the device if the `expand=user` query parameter is specified in the request. Use `expand=userSummary` to get only a summary of each associated user for the device.", + "properties": { + "users": { + "description": "Users for the device", + "items": { + "$ref": "#/components/schemas/DeviceUser" + }, + "type": "array" + } + }, + "readOnly": true, + "type": "object" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "DevicePlatform": { + "description": "OS platform of the device", + "enum": [ + "ANDROID", + "IOS", + "MACOS", + "WINDOWS" + ], + "type": "string" + }, + "DevicePolicyMDMFramework": { + "enum": [ + "AFW", + "NATIVE", + "SAFE" + ], + "type": "string" + }, + "DevicePolicyPlatformType": { + "enum": [ + "ANDROID", + "IOS", + "OSX", + "WINDOWS" + ], + "type": "string" + }, + "DevicePolicyRuleCondition": { + "properties": { + "migrated": { + "type": "boolean" + }, + "platform": { + "$ref": "#/components/schemas/DevicePolicyRuleConditionPlatform" + }, + "rooted": { + "type": "boolean" + }, + "trustLevel": { + "$ref": "#/components/schemas/DevicePolicyTrustLevel" + } + }, + "type": "object" + }, + "DevicePolicyRuleConditionAssurance": { + "description": "Specifies [device assurance policies](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/DeviceAssurance/) in the policy rule", + "properties": { + "include": { + "description": "Specifies the device assurance policy ID", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DevicePolicyRuleConditionPlatform": { + "properties": { + "supportedMDMFrameworks": { + "items": { + "$ref": "#/components/schemas/DevicePolicyMDMFramework" + }, + "type": "array" + }, + "types": { + "items": { + "$ref": "#/components/schemas/DevicePolicyPlatformType" + }, + "type": "array" + } + }, + "type": "object" + }, + "DevicePolicyTrustLevel": { + "enum": [ + "ANY", + "TRUSTED" + ], + "type": "string" + }, + "DevicePostureCheck": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "createdBy": { + "description": "User who created the device posture check", + "example": "00u217pyf72CdUrBt1c5", + "readOnly": true, + "type": "string" + }, + "createdDate": { + "description": "Time the device posture check was created", + "example": "2019-10-02T18:03:07.000Z", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of the device posture check", + "example": "Query macOS devices to check if firewall is enabled", + "type": "string" + }, + "id": { + "description": "The ID of the device posture check", + "example": "dch3m8o4rWhwReDeM1c5", + "readOnly": true, + "type": "string" + }, + "lastUpdate": { + "description": "Time the device posture check was updated", + "example": "2019-10-02T18:03:07.000Z", + "readOnly": true, + "type": "string" + }, + "lastUpdatedBy": { + "description": "User who updated the device posture check", + "example": "00u217pyf72CdUrBt1c5", + "readOnly": true, + "type": "string" + }, + "mappingType": { + "$ref": "#/components/schemas/DevicePostureChecksMappingType" + }, + "name": { + "description": "Display name of the device posture check", + "example": "Device posture check macOS", + "type": "string" + }, + "platform": { + "$ref": "#/components/schemas/DevicePostureChecksPlatform" + }, + "query": { + "description": "OSQuery for the device posture check", + "example": "SELECT CASE WHEN global_state = 0 THEN 0 ELSE 1 END AS firewall_enabled FROM alf;", + "type": "string" + }, + "remediationSettings": { + "$ref": "#/components/schemas/DevicePostureChecksRemediationSettings" + }, + "type": { + "$ref": "#/components/schemas/DevicePostureChecksType" + }, + "variableName": { + "description": "Unique name of the device posture check", + "example": "macOSFirewall", + "type": "string" + } + }, + "title": "DevicePostureCheck", + "type": "object" + }, + "DevicePostureChecks": { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle></x-lifecycle-container>Represents the Device Posture Checks configuration for the device assurance policy", + "properties": { + "include": { + "description": "An array of key-value pairs that include the device posture check `variableName` key", + "example": [ + { + "value": "1", + "variableName": "macOSFirewall" + }, + { + "value": "1", + "variableName": "windowsFirewall" + } + ], + "items": { + "properties": { + "value": { + "description": "The device posture check value", + "type": "string" + }, + "variableName": { + "description": "The device posture check key", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "DevicePostureChecksMappingType": { + "description": "Represents how the device posture check is rendered in device assurance policies", + "enum": [ + "CHECKBOX", + "TEXTBOX" + ], + "type": "string" + }, + "DevicePostureChecksPlatform": { + "enum": [ + "MACOS", + "WINDOWS" + ], + "type": "string" + }, + "DevicePostureChecksRemediationSettings": { + "description": "Represents the remediation instructions shown to the end user when the device posture check fails", + "properties": { + "link": { + "properties": { + "customUrl": { + "description": "Custom URL for the link", + "example": "example.myremediationurl.com/docs", + "type": "string" + }, + "defaultUrl": { + "description": "Default URL for the link. This property is only relevant if type is set to `BUILTIN`. If type is set to `CUSTOM`, this field is ignored.", + "example": "https://help.okta.com/eu/en-us/content/topics/end-user/ov-device-health-macos.htm", + "type": "string" + } + }, + "type": "object" + }, + "message": { + "properties": { + "customText": { + "description": "Custom text for the message", + "example": "It is our company policy that all devices must have a firewall enabled.", + "type": "string" + }, + "defaultI18nKey": { + "description": "Default i18n key for the message. This property is only relevant if type is set to `BUILTIN`. If type is set to `CUSTOM`, this field is ignored.", + "example": "macos.firewall.enabled.remediation.message", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "DevicePostureChecksType": { + "enum": [ + "BUILTIN", + "CUSTOM" + ], + "type": "string" + }, + "DevicePostureIdP": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Device Posture IdP provider", + "properties": { + "compliant": { + "description": "Indicates whether the device is compliant according to the custom IDP", + "type": "boolean" + }, + "managed": { + "description": "Indicates whether the device is managed according to the custom IDP", + "type": "boolean" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "DeviceProfile": { + "properties": { + "diskEncryptionType": { + "$ref": "#/components/schemas/DiskEncryptionTypeDef" + }, + "displayName": { + "description": "Display name of the device", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "imei": { + "description": "International Mobile Equipment Identity (IMEI) of the device", + "maxLength": 17, + "minLength": 14, + "type": "string" + }, + "integrityJailbreak": { + "description": "Indicates if the device is jailbroken or rooted. Only applicable to `IOS` and `ANDROID` platforms", + "type": "boolean" + }, + "managed": { + "description": "Indicates if the device is managed by mobile device management (MDM) software", + "type": "boolean" + }, + "manufacturer": { + "description": "Name of the manufacturer of the device", + "maxLength": 127, + "type": "string" + }, + "meid": { + "description": "Mobile equipment identifier of the device", + "maxLength": 14, + "type": "string" + }, + "model": { + "description": "Model of the device", + "maxLength": 127, + "type": "string" + }, + "osVersion": { + "description": "Version of the device OS", + "maxLength": 127, + "type": "string" + }, + "platform": { + "$ref": "#/components/schemas/DevicePlatform" + }, + "registered": { + "description": "Indicates if the device is registered at Okta", + "type": "boolean" + }, + "secureHardwarePresent": { + "description": "Indicates if the device contains a secure hardware functionality", + "type": "boolean" + }, + "serialNumber": { + "description": "Serial number of the device", + "maxLength": 127, + "type": "string" + }, + "sid": { + "description": "Windows Security identifier of the device", + "maxLength": 256, + "type": "string" + }, + "tpmPublicKeyHash": { + "description": "Windows Trusted Platform Module hash value", + "type": "string" + }, + "udid": { + "description": "macOS Unique device identifier of the device", + "maxLength": 47, + "type": "string" + } + }, + "required": [ + "displayName", + "platform", + "registered" + ], + "type": "object" + }, + "DeviceProvider": { + "properties": { + "payload": { + "$ref": "#/components/schemas/OktaVerifyPayload" + }, + "payloadVersion": { + "description": "The version of the payload schema", + "example": "1.0", + "type": "string" + }, + "provider": { + "description": "The name of the provider", + "example": "oktaVerify", + "type": "string" + } + }, + "type": "object" + }, + "DeviceSignalCollectionPlatformConditionEvaluatorPlatform": { + "properties": { + "os": { + "$ref": "#/components/schemas/DeviceSignalCollectionPlatformConditionEvaluatorPlatformOperatingSystem" + }, + "type": { + "$ref": "#/components/schemas/DeviceSignalCollectionPolicyPlatformType" + } + }, + "type": "object" + }, + "DeviceSignalCollectionPlatformConditionEvaluatorPlatformOperatingSystem": { + "properties": { + "expression": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/DeviceSignalCollectionPolicyPlatformOperatingSystemType" + }, + "version": { + "$ref": "#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystemVersion" + } + }, + "type": "object" + }, + "DeviceSignalCollectionPlatformPolicyRuleCondition": { + "description": "Specifies a particular platform or device to match on", + "properties": { + "exclude": { + "items": { + "$ref": "#/components/schemas/DeviceSignalCollectionPlatformConditionEvaluatorPlatform" + }, + "type": "array" + }, + "include": { + "items": { + "$ref": "#/components/schemas/DeviceSignalCollectionPlatformConditionEvaluatorPlatform" + }, + "type": "array" + } + }, + "type": "object" + }, + "DeviceSignalCollectionPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "properties": { + "resourceType": { + "description": "The resource that this policy controls. For the [Okta account management policy](https://developer.okta.com/docs/guides/okta-account-management-policy/main/#example-response), `END_USER_ACCOUNT_MANAGEMENT` is returned. For other policies, `APP` is returned.", + "type": "string" + } + }, + "type": "object" + }, + "conditions": { + "default": null, + "description": "Policy conditions aren't supported. Conditions are applied at the rule level for this policy type.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "DeviceSignalCollectionPolicyPlatformOperatingSystemType": { + "description": "The type of operating system", + "enum": [ + "ANDROID", + "CHROMEOS", + "IOS", + "MACOS", + "WINDOWS" + ], + "type": "string" + }, + "DeviceSignalCollectionPolicyPlatformType": { + "description": "The type of platform", + "enum": [ + "DESKTOP", + "MOBILE" + ], + "type": "string" + }, + "DeviceSignalCollectionPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "$ref": "#/components/schemas/DeviceSignalCollectionPolicyRuleActions" + }, + "conditions": { + "$ref": "#/components/schemas/DeviceSignalCollectionPolicyRuleConditions" + } + }, + "type": "object" + } + ] + }, + "DeviceSignalCollectionPolicyRuleActions": { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle></x-lifecycle-container>Specifies actions to be taken, or operations that may be allowed, if the rule conditions are satisfied", + "properties": { + "deviceSignalCollection": { + "$ref": "#/components/schemas/DeviceSignalCollectionPolicyRuleDeviceSignalCollection" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "DeviceSignalCollectionPolicyRuleConditions": { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle></x-lifecycle-container>Specifies conditions that must be met during policy evaluation to apply the rule. All policy conditions, as well as conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule.", + "properties": { + "network": { + "$ref": "#/components/schemas/PolicyNetworkCondition" + }, + "platform": { + "$ref": "#/components/schemas/DeviceSignalCollectionPlatformPolicyRuleCondition" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "DeviceSignalCollectionPolicyRuleDeviceSignalCollection": { + "description": "Specifies how device context is collected when a user attempts to sign in", + "properties": { + "deviceContextProviders": { + "description": "Contains the device context provider configuration", + "items": { + "$ref": "#/components/schemas/DeviceContextProvider" + }, + "type": "array" + } + }, + "type": "object" + }, + "DeviceStatus": { + "description": "The state object of the device", + "enum": [ + "ACTIVE", + "DEACTIVATED", + "SUSPENDED", + "UNSUSPENDED" + ], + "type": "string", + "x-enumDescriptions": { + "ACTIVE": "Use activated devices to create and delete device user links", + "DEACTIVATED": "Deactivation causes a device to lose all device user links. Set the device status to `DEACTIVATED` before deleting it.", + "SUSPENDED": "Use suspended devices to create and delete device user links. You can only unsuspend or deactivate suspended devices.", + "UNSUSPENDED": "Returns a suspended device to `ACTIVE`." + } + }, + "DeviceUser": { + "properties": { + "created": { + "description": "Timestamp when device was created", + "type": "string" + }, + "managementStatus": { + "description": "The management status of the device", + "enum": [ + "MANAGED", + "NOT_MANAGED" + ], + "type": "string", + "x-enumDescriptions": { + "MANAGED": "The device has management software installed", + "NOT_MANAGED": "The device doesn't have management software installed" + } + }, + "screenLockType": { + "description": "Screen lock type of the device", + "enum": [ + "NONE", + "PASSCODE", + "BIOMETRIC" + ], + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "DeviceWithProviders": { + "allOf": [ + { + "$ref": "#/components/schemas/Device" + }, + { + "properties": { + "providers": { + "description": "List of providers for the device when the `expand=providers` query parameter is specified", + "items": { + "$ref": "#/components/schemas/DeviceProvider" + }, + "readOnly": true, + "type": "array" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "DigestAlgorithm": { + "description": "Algorithm used to generate the key. Only required for the PBKDF2 algorithm.", + "enum": [ + "SHA256_HMAC", + "SHA512_HMAC" + ], + "type": "string" + }, + "DiskEncryptionTypeAndroid": { + "enum": [ + "FULL", + "USER" + ], + "type": "string" + }, + "DiskEncryptionTypeDef": { + "description": "Type of encryption used on the device\n> **Note:** The following values map to Disk Encryption ON: `FULL`, `USER`, `ALL_INTERNAL_VOLUMES`. All other values map to Disk Encryption OFF.", + "enum": [ + "ALL_INTERNAL_VOLUMES", + "FULL", + "NONE", + "SYSTEM_VOLUME", + "USER" + ], + "type": "string", + "x-enumDescriptions": { + "ALL_INTERNAL_VOLUMES": "All internal disks are encrypted. Only applicable to `WINDOWS` and `MACOS` platforms.", + "FULL": "Disk is fully encrypted. Only applicable to `IOS` and `ANDROID` platforms.", + "NONE": "No encryption has been set.", + "SYSTEM_VOLUME": "Only the system volume is encrypted. Only applicable to `WINDOWS` and `MACOS` platforms.", + "USER": "Encryption key is tied to the user or profile. Only applicable to `ANDROID` platform." + } + }, + "DiskEncryptionTypeDesktop": { + "enum": [ + "ALL_INTERNAL_VOLUMES" + ], + "type": "string" + }, + "DomainCertificate": { + "description": "Defines the properties of the certificate", + "properties": { + "certificate": { + "description": "Certificate content", + "example": "\"-----BEGIN CERTIFICATE-----\\nMIIFNzCCBB+gAwIBAgHTAAXomJWRama3ypu8TIxdA9wzMA0GCSqGSIb3DQEBCwUA\\nMDIzCzAJCgNVBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MQswCQYDVQQD\\nEwJSMzAeFw0yMTAyMTAwNTEzMDVaFw0yMTA1MTEwNTEzMDVaMCQxIjAgBgNVBAMT\\nGWFuaXRhdGVzdC5zaWdtYW5ldGNvcnAudXMwggEiMA0GCSqGSIb3DQEBAQUAA4IB\\nDwAwggEKAoIBAQC5cyk6x63iBJSWvtgsOBqIxfO8euPHcRnyWsL9dsvnbNyOnyvc\\nqFWxdiW3sh2cItzYtoN1Zfgj5lWGOVXbHxP0VaNG9fHVX3+NHP6LFHQz92BzAYQm\\npqi9zaP/aKJklk6LdPFbVLGhuZfm34+ijW9YsgLTKR2WTaZJK5QtamVVmP+VsSCl\\na2ifFzjz2FCkMMEc/Y0zUyP+en/mbL71K+VnpZdlEC1s38EvjRTFKFZTKVw5wpWg\\nCZQq/AZYj9RxR23IIuRcUJ8TQ2pyoc3kIXPWjiIarSgBlA8G9kCsxgzXP2RyLwKr\\nIBIo+qyHweifpPYW28ipdSbPjiypAMdpbGLDAgMBAAGjggJTMIICTzAOBgNVHQ8B\\nAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYBBQUHAwEGCCsGAQUFBwMCMAwGA1UdEwEB\\n/wQCMAAwHQYDVR0OBBYEFPVZKiovtIK4Av/IBUQeLUs29pT6MB8GA1UdIwQYMBaA\\nFBQusxe3WFbLrlAJQOYfr52LFMLGMFUGCCsGAQUFBwEBBEkwRzAhBggrBgEFBQcw\\nAYYVaHR0cDovL3IzLm8ubGVuY3Iub3JnMCIGCCsGAQUFBzAChhZodHRwOi8vcjMu\\naS5sZW5jci5vcmcvMCQGA1UdEQQdMBuCGWFuaXRhdGVzdC5zaWdtYW5ldGNvcnAu\\ndXMwTAYDVR0gBEUwQzAIBgZngQwBAgEwNwYLKwYBBAGC3xMBAQEwKDAmBggrBgEF\\nBQcCARYaaHR0cDovL2Nwcy5sZXRzZW5jcnlwdC5vcmcwggEDBgorBgEEAdZ5AgQC\\nBIH0BIHxAO8AdgBc3EOS/uarRUSxXprUVuYQN/vV+kfcoXOUsl7m9scOygAAAXeK\\nkmOsAAAEAwBHMEUCIQDSudPEWXk969BT8yz3ag6BJWCMRU5tefEw9nXEQMsh5gIg\\nUmfGIuUlcNNI5PydVIHj+zns+SR8P7zfd3FIxW4gK0QAdQD2XJQv0XcwIhRUGAgw\\nlFaO400TGTO/3wwvIAvMTvFk4wAAAXeKkmOlAAAEAwBGMEQCIHQkr2qOGuInvonv\\nW4vvdI61nraax5V6SC3E0D2JSO91AiBVhpX4BBafRAh36r7l8LrxAfxBM3CjBmAC\\nq8fUrWfIWDANBgkqhkiG9w0BAQsFAAOCAQEAgGDMKXofKpDdv5kkID3s5GrKdzaj\\njFmb/6kyqd1E6eGXZAewCP1EF5BVvR6lBP2aRXiZ6sJVZktoIfztZnbxBGgbPHfv\\nR3iXIG6fxkklzR9Y8puPMBFadANE/QV78tIRAlyaqeSNsoxHi7ssQjHTP111B2lf\\n3KmuTpsruut1UesEJcPReLk/1xTkRx262wAncach5Wp+6GWWduTZYJbsNFyrK1RP\\nYQ0qYpP9wt2qR+DGaRUBG8i1XLnZS8pkyxtKhVw/a5Fowt+NqCpEBjjJiWJRSGnG\\nNSgRtSXq11j8O4JONi8EXe7cEtvzUiLR5PL3itsK2svtrZ9jIwQ95wOPaA==\\n-----END CERTIFICATE-----\",", + "type": "string" + }, + "certificateChain": { + "description": "Certificate chain", + "example": "\"-----BEGIN CERTIFICATE-----\\nMIIFPjCCBCbjAwIBAgISA7RikMltj36DkLk1DUzjwfYBMA0GCSqGSIb3DQEBCwUA\\nMDIxCzAJBgNVBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MQswCQYDVQQD\\nEwJSMzAeFw0yMTEwMTExOTQ3MjRaFw0yMjAxMDkxOTQ3MjNaMCgxJjAkBgNVBAMT\\nHWFuaXRhdGVzdHJhaW4uc2lnbWFuZXRjb3JwLnVzMIIBIjANBgkqhkiG9w0BAQEF\\nAAOCAQ8AMIIBCgKCAQEA40EsG7YrFlsH3XdZKirdKKOC7/cca5g9L4rwyA/PlfeU\\nB7mJhbQI/a3yZbtY+GjHmedBx15aPtyq+NFZLOkiRCXx0k2zNIJB4yC6Jr/Yp8C2\\nrXO6mrCcuqpX7SuDPBtrfdYcIg8G6m0wjj1V1p2/XR8G//CBe8I2XTaTpHsx/VC8\\nMNOAA27aSbeX4Nz6TQ69rFuxRG+neUbcz2hQKwroCsCHi6iBmqRkg19Uh8315Cx2\\nBUqY0JecpP42KMiktzIoSlqS9yZSuNQh1kP1tPwkEzbs/t3FrfCnnRx5RDr2pJpV\\nnonL3sB3TVotS3nFgPNHCfp65O0Bg/3ZpU9IvUpcdQIDAQABo4ICVjCCAlIwDgYD\\nVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNV\\nHRMBAf8EAjAAMB0GA1UdDgQWBBSzWt3Dvp71cKA2Z54ESjjyM4dp+jAfBgNVHSME\\nGDAWgBQULrMXt1hWy65QCUDmH6+dixTCxjBVBggrBgEFBQcBAQRJMEcwIQYIKwYB\\nBQUHMAGGFWh0dHA6Ly9yMy5vLmxlbmNyLm9yZzAiBggrBgEFBQcwAoYWaHR0cDov\\nL3IzLmkubGVuY3Iub3JnLzAoBgNVHREEITAfgh1hbml0YXRlc3RyYWluLnNpZ21h\\nbmV0Y29ycC51czBMBgNVHSAERTBDMAgGBmeBDAECATA3BgsrBgEEAYLfEwEBATAo\\nMCYGCCsGAQUFBwIBFhpodHRwOi8vY3BzLmxldHNlbmNyeXB0Lm9yZzCCAQIGCisG\\nAQQB1nkCBAIEgfMEgfAA7gB1AG9Tdqwx8DEZ2JkApFEV/3cVHBHZAsEAKQaNsgia\\nN9kTAAABfHEcLqAAAAQDAEYwRAIgMlyQ61FjuIKDfATjz0wfkskChD0csVe0TStq\\nmC7NbLACICp3CYMvvDiWt1pr5pzCwTQO8F6v0/qNjmH4mjCutAgyAHUARqVV63X6\\nkSAwtaKJafTzfREsQXS+/Um4havy/HD+bUcAAAF8cRwvRAAABAMARjBEAiAZd6Vn\\n7MLXT7JeIxZrfbNARrf5oCM4UAVjjJeaUhB1MwIgSLW5cVAZvkiwbQW+vIutFjBz\\na8cNb/i+nM7RxFW+JPgwDQYJKoZIhvcNAQELBQADggEBAIlHZiHIuOvYFteqpwvR\\n0ElqinIpkYsfI+0O5FwHBXz7vMCPGtfdlcX5M10eW3aEBo9lR59mjDMsMufbTb60\\nJuSnguelkUoq4WzqjZI+2uy/FTztI5GPpXmXW3IyzbqmCWQt7u8N607g1TYLBaLL\\nrbFIhl+LbTJAa//mxI6bb4l/86j/kSjht6U0OIde7ylscb+3MHobbpIWJYp8Jr1D\\nubm/0glL46ExnuLbIKojLhDBnG/wHVunB0rJxGh1vPvwD75O1nSIdxuNlVcGwws+\\n7wsOyPA1s0VWzrMN1olLMyIPFCwPvfCm1E8Dje1AXMpmyDlqjEoQsoMUH//GKF0S\\nTgM=\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\nMIIFFjCCAv6gAwIBAgIRAJErCErPDBinU/bWLiWnX1owDQYJKoZIhvcNAQELBQAw\\nTzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh\\ncmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMjAwOTA0MDAwMDAw\\nWhcNMjUwOTE1MTYwMDAwWjAyMQswCQYDVQQGEwJVUzEWMBQGA1UEChMNTGV0J3Mg\\nRW5jcnlwdDELMAkGA1UEAxMCUjMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\\nAoIBAQC7AhUozPaglNMPEuyNVZLD+ILxmaZ6QoinXSaqtSu5xUyxr45r+XXIo9cP\\nR5QUVTVXjJ6oojkZ9YI8QqlObvU7wy7bjcCwXPNZOOftz2nwWgsbvsCUJCWH+jdx\\nsxPnHKzhm+/b5DtFUkWWqcFTzjTIUu61ru2P3mBw4qVUq7ZtDpelQDRrK9O8Zutm\\nNHz6a4uPVymZ+DAXXbpyb/uBxa3Shlg9F8fnCbvxK/eG3MHacV3URuPMrSXBiLxg\\nZ3Vms/EY96Jc5lP/Ooi2R6X/ExjqmAl3P51T+c8B5fWmcBcUr2Ok/5mzk53cU6cG\\n/kiFHaFpriV1uxPMUgP17VGhi9sVAgMBAAGjggEIMIIBBDAOBgNVHQ8BAf8EBAMC\\nAYYwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMBMBIGA1UdEwEB/wQIMAYB\\nAf8CAQAwHQYDVR0OBBYEFBQusxe3WFbLrlAJQOYfr52LFMLGMB8GA1UdIwQYMBaA\\nFHm0WeZ7tuXkAXOACIjIGlj26ZtuMDIGCCsGAQUFBwEBBCYwJDAiBggrBgEFBQcw\\nAoYWaHR0cDovL3gxLmkubGVuY3Iub3JnLzAnBgNVHR8EIDAeMBygGqAYhhZodHRw\\nOi8veDEuYy5sZW5jci5vcmcvMCIGA1UdIAQbMBkwCAYGZ4EMAQIBMA0GCysGAQQB\\ngt8TAQEBMA0GCSqGSIb3DQEBCwUAA4ICAQCFyk5HPqP3hUSFvNVneLKYY611TR6W\\nPTNlclQtgaDqw+34IL9fzLdwALduO/ZelN7kIJ+m74uyA+eitRY8kc607TkC53wl\\nikfmZW4/RvTZ8M6UK+5UzhK8jCdLuMGYL6KvzXGRSgi3yLgjewQtCPkIVz6D2QQz\\nCkcheAmCJ8MqyJu5zlzyZMjAvnnAT45tRAxekrsu94sQ4egdRCnbWSDtY7kh+BIm\\nlJNXoB1lBMEKIq4QDUOXoRgffuDghje1WrG9ML+Hbisq/yFOGwXD9RiX8F6sw6W4\\navAuvDszue5L3sz85K+EC4Y/wFVDNvZo4TYXao6Z0f+lQKc0t8DQYzk1OXVu8rp2\\nyJMC6alLbBfODALZvYH7n7do1AZls4I9d1P4jnkDrQoxB3UqQ9hVl3LEKQ73xF1O\\nyK5GhDDX8oVfGKF5u+decIsH4YaTw7mP3GFxJSqv3+0lUFJoi5Lc5da149p90Ids\\nhCExroL1+7mryIkXPeFM5TgO9r0rvZaBFOvV2z0gp35Z0+L4WPlbuEjN/lxPFin+\\nHlUjr8gRsI3qfJOQFy/9rKIJR0Y/8Omwt/8oTWgy1mdeHmmjk7j1nYsvC9JSQ6Zv\\nMldlTTKB3zhThV1+XWYp6rjd5JW1zbVWEkLNxE7GJThEUG3szgBVGP7pSWTUTsqX\\nnLRbwHOoq7hHwg==\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\nMIIFYDCCBEigAwIBAgIQQAF3ITfU6UK47naqPGQKtzANBgkqhkiG9w0BAQsFADA/\\nMSQwIgYDVQQKExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMT\\nDkRTVCBSb290IENBIFgzMB4XDTIxMDEyMDE5MTQwM1oXDTI0MDkzMDE4MTQwM1ow\\nTzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh\\ncmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwggIiMA0GCSqGSIb3DQEB\\nAQUAA4ICDwAwggIKAoICAQCt6CRz9BQ385ueK1coHIe+3LffOJCMbjzmV6B493XC\\nov71am72AE8o295ohmxEk7axY/0UEmu/H9LqMZshftEzPLpI9d1537O4/xLxIZpL\\nwYqGcWlKZmZsj348cL+tKSIG8+TA5oCu4kuPt5l+lAOf00eXfJlII1PoOK5PCm+D\\nLtFJV4yAdLbaL9A4jXsDcCEbdfIwPPqPrt3aY6vrFk/CjhFLfs8L6P+1dy70sntK\\n4EwSJQxwjQMpoOFTJOwT2e4ZvxCzSow/iaNhUd6shweU9GNx7C7ib1uYgeGJXDR5\\nbHbvO5BieebbpJovJsXQEOEO3tkQjhb7t/eo98flAgeYjzYIlefiN5YNNnWe+w5y\\nsR2bvAP5SQXYgd0FtCrWQemsAXaVCg/Y39W9Eh81LygXbNKYwagJZHduRze6zqxZ\\nXmidf3LWicUGQSk+WT7dJvUkyRGnWqNMQB9GoZm1pzpRboY7nn1ypxIFeFntPlF4\\nFQsDj43QLwWyPntKHEtzBRL8xurgUBN8Q5N0s8p0544fAQjQMNRbcTa0B7rBMDBc\\nSLeCO5imfWCKoqMpgsy6vYMEG6KDA0Gh1gXxG8K28Kh8hjtGqEgqiNx2mna/H2ql\\nPRmP6zjzZN7IKw0KKP/32+IVQtQi0Cdd4Xn+GOdwiK1O5tmLOsbdJ1Fu/7xk9TND\\nTwIDAQABo4IBRjCCAUIwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYw\\nSwYIKwYBBQUHAQEEPzA9MDsGCCsGAQUFBzAChi9odHRwOi8vYXBwcy5pZGVudHJ1\\nc3QuY29tL3Jvb3RzL2RzdHJvb3RjYXgzLnA3YzAfBgNVHSMEGDAWgBTEp7Gkeyxx\\n+tvhS5B1/8QVYIWJEDBUBgNVHSAETTBLMAgGBmeBDAECATA/BgsrBgEEAYLfEwEB\\nATAwMC4GCCsGAQUFBwIBFiJodHRwOi8vY3BzLnJvb3QteDEubGV0c2VuY3J5cHQu\\nb3JnMDwGA1UdHwQ1MDMwMaAvoC2GK2h0dHA6Ly9jcmwuaWRlbnRydXN0LmNvbS9E\\nU1RST09UQ0FYM0NSTC5jcmwwHQYDVR0OBBYEFHm0WeZ7tuXkAXOACIjIGlj26Ztu\\nMA0GCSqGSIb3DQEBCwUAA4IBAQAKcwBslm7/DlLQrt2M51oGrS+o44+/yQoDFVDC\\n5WxCu2+b9LRPwkSICHXM6webFGJueN7sJ7o5XPWioW5WlHAQU7G75K/QosMrAdSW\\n9MUgNTP52GE24HGNtLi1qoJFlcDyqSMo59ahy2cI2qBDLKobkx/J3vWraV0T9VuG\\nWCLKTVXkcGdtwlfFRjlBz4pYg1htmf5X6DYO8A4jqv2Il9DjXA6USbW1FzXSLr9O\\nhe8Y4IWS6wY7bCkjCWDcRQJMEhg76fsO3txE+FiYruq9RUWhiF1myv4Q6W+CyBFC\\nDfvp7OOGAN6dEOM4+qR9sdjoSYKEBpsr6GtPAQw4dy753ec5\\n-----END CERTIFICATE-----\"", + "type": "string" + }, + "privateKey": { + "description": "Certificate private key", + "example": "\"-----BEGIN PRIVATE KEY-----\\nMIIEvgIBADANBgkqhkiG9w0AAQEFAASCBKgwghSkAgEAAoIBAQC5cyk6y63iBJSW\\nstgsOBqIxfO8euPHcRnyWsL9dsvnbNyOnyvcqFWxdiW3sh2cItzYtoN1Zfgj5lWG\\nOVXbHxP0VaNG9fHVX3+NHP6LFHQz92BzAYQmpqi9zaP/aKJklk6LdPFbVLGhuZfm\\n34+ijW9YsgLTKR2WTaZJK5QtamVVmP+VsSCla2ifFzjz2FCkMMEc/Y0zUyP+en/m\\nbL71K+VnpZdlEC1s38EvjRTFKFZTKVw5wpWgCZQq/AZYj9RxR23IIuRcUJ8TQ2py\\noc3kIXPWjiIarSgBlA8G9kCsxgzXP2RyLwKrIBIo+qyHweifpPYW28ipdSbPjiyp\\nAMdpbGLDAgMBAAECggEAUXVfT91z6IqghhKwO8QtC5T/+fN06B8rCYSKj/FFoZL0\\n0oTiLFuYwImoCadoUDQUE/Efj0rKE2LSgFHg/44IItQXE01m+5WmHmL1ADxsyoLH\\nz9yDosKj7jNM7RyV8F8Bg0pL1hU+rU4rhhL/MaS0mx4eFYjC4UmcWBmXTdelSVJa\\nkvXvQLT5y86bqh7tqMjM/kALTWRz5CgNJFk/ONA1yo5RTX9S7SIXimBgAvuGqP8i\\nMPEhJou7U3DfzXVfvP8byqNdsZs6ZNhG3wXspl61mRyrY+51SOaNLA7Bkji7x4bH\\nNw6mJI0IJTAP9oc1Z8fYeMuxT1bfuD7VOupSP0mAMQKBgQDk+KuyQkmPymeP/Wwu\\nII4DUpleVzxTK9obMQQoCEEElbQ6+jTb+8ixP0bWLvBXg/rX734j7OWfn/bljWLH\\nXLrSoqQZF1+XMVeY4g4wx9UuTK/D2n791zdOgQivxbIPdWL3a4ap86ar8uyMgJu8\\nBLXfFBAOc+9myqUkbeO7wt0e6QKBgQDPV04jPtIJoMrggpQDNreGrANKOmsXWxj4\\nOHW13QNdJ2KGQpoTdoqQ8ZmlxuA8Bf2RjHsnB2kgGVTVQR74zRib4MByhvsdhvVm\\nF2LNsJoIDfqtv3c+oj13VonRUGuzUeJpwT/snyaL+jQ/ZZcYz0jDgDhIODTcFYj8\\nDMSD5SHgywKBgHH6MwWuJ44TNBAiF2qyu959jGjAxf+k0ZI9iRMgYLUWjDvbdtqW\\ncCWDGRDfFraJtSEuTz003GzkJPPJuIUC7OCTI1p2HxhU8ITi6itwHfdJJyk4J4TW\\nT+qdIqTUpTk6tsPw23zYE3x+lS+viVZDhgEArKl1HpOthh0nMnixnH6ZAoGBAKGn\\nV+xy1h9bldFk/TFkP8Jn6ki9MzGKfPVKT7vzDORcCJzU4Hu8OFy5gSmW3Mzvfrsz\\n4/CR/oxgM5vwoc0pWr5thJ3GT5K93iYypX3o6q7M91zvonDa3UFl3x2qrc2pUfVS\\nDhzWGJ+Z+5JSCnP1aK3EEh18dPoCcELTUYPj6X3xAoGBALAllTb3RCIaqIqk+s3Y\\n6KDzikgwGM6j9lmOI2MH4XmCVym4Z40YGK5nxulDh2Ihn/n9zm13Z7ul2DJwgQSO\\n0zBc7/CMOsMEBaNXuKL8Qj4enJXMtub4waQ/ywqHIdc50YaPI5Ax8dD/10h9M6Qc\\nnUFLNE8pXSnsqb0eOL74f3uQ\\n-----END PRIVATE KEY-----\"", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/DomainCertificateType" + } + }, + "required": [ + "certificate", + "certificateChain", + "privateKey", + "type" + ], + "type": "object" + }, + "DomainCertificateMetadata": { + "description": "Certificate metadata for the domain", + "properties": { + "expiration": { + "description": "Certificate expiration", + "example": "2021-05-11T05:13:05.000Z", + "type": "string" + }, + "fingerprint": { + "description": "Certificate fingerprint", + "example": "73:68:82:7B:83:2E:48:29:A5:5E:E8:40:41:80:B3:AA:03:C4:42:43:05:73:45:BC:AA:47:00:23:A3:70:E5:C4", + "type": "string" + }, + "subject": { + "description": "Certificate subject", + "example": "CN=login.example.com", + "type": "string" + } + }, + "type": "object" + }, + "DomainCertificateSourceType": { + "description": "Certificate source type that indicates whether the certificate is provided by the user or Okta.", + "enum": [ + "MANUAL", + "OKTA_MANAGED" + ], + "type": "string" + }, + "DomainCertificateType": { + "description": "Certificate type", + "enum": [ + "PEM" + ], + "type": "string" + }, + "DomainLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "brand": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "The associated brand" + } + ] + }, + "certificate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "The certificate link references the domain certificate" + } + ] + }, + "verify": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "The verify link verifies the domain and transitions the domain status to `VERIFIED`" + } + ] + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "DomainListResponse": { + "description": "Defines a list of domains with a subset of the properties for each domain", + "properties": { + "domains": { + "description": "Each element of the array defines an individual domain", + "items": { + "$ref": "#/components/schemas/DomainResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "DomainRequest": { + "properties": { + "certificateSourceType": { + "$ref": "#/components/schemas/DomainCertificateSourceType" + }, + "domain": { + "description": "Custom domain name\n\n> **Note:** You can't use the reserved `drapp.{yourOrgSubDomain}.okta.com` domain.", + "example": "login.example.com", + "type": "string" + } + }, + "required": [ + "certificateSourceType", + "domain" + ], + "type": "object" + }, + "DomainResponse": { + "description": "The properties that define an individual domain.", + "properties": { + "_links": { + "$ref": "#/components/schemas/DomainLinks" + }, + "brandId": { + "description": "The ID number of the brand", + "example": "bndul904tTZ6kWVhP0g3", + "type": "string" + }, + "certificateSourceType": { + "$ref": "#/components/schemas/DomainCertificateSourceType" + }, + "dnsRecords": { + "items": { + "$ref": "#/components/schemas/DNSRecordDomains" + }, + "type": "array" + }, + "domain": { + "description": "Custom domain name", + "example": "login.example.com", + "type": "string" + }, + "id": { + "description": "Unique ID of the domain", + "example": "OcDz6iRyjkaCTXkdo0g3", + "type": "string" + }, + "publicCertificate": { + "$ref": "#/components/schemas/DomainCertificateMetadata" + }, + "validationStatus": { + "$ref": "#/components/schemas/DomainValidationStatus" + } + }, + "type": "object" + }, + "DomainValidationStatus": { + "description": "Status of the domain", + "enum": [ + "COMPLETED", + "IN_PROGRESS", + "NOT_STARTED", + "VERIFIED" + ], + "example": "VERIFIED", + "type": "string" + }, + "Duration": { + "properties": { + "number": { + "type": "integer" + }, + "unit": { + "type": "string" + } + }, + "type": "object" + }, + "DynamicNetworkZone": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkZone" + }, + { + "title": "Dynamic Network Zone" + }, + { + "properties": { + "asns": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkZoneAsns" + }, + { + "description": "An array of ASNs for a Network Zone" + } + ] + }, + "locations": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkZoneLocationArray" + }, + { + "description": "An array of geolocations for a Dynamic Network Zone" + } + ] + }, + "proxyType": { + "description": "The proxy type used for a Dynamic Network Zone", + "enum": [ + "null", + "Any", + "Tor", + "NotTorAnonymizer" + ], + "type": "string", + "x-enumDescriptions": { + "Any": "Use any proxy type for the Dynamic Zone.", + "NotTorAnonymizer": "Use a non Tor Anonymizer proxy for the Dynamic Zone.", + "Tor": "Use Tor Anonymizer proxy for the Dynamic Zone.", + "null": "(Or `\"\"`) No proxy used" + } + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ECKeyJWK": { + "description": "Elliptic curve key in JSON Web Key (JWK) format. It's used during enrollment to encrypt fulfillment requests to Yubico, or during activation to verify Yubico's JWS (JSON Web Signature) objects in fulfillment responses. The currently agreed protocol uses P-384.", + "properties": { + "crv": { + "description": "The elliptic curve protocol", + "enum": [ + "P-384" + ], + "type": "string" + }, + "kid": { + "description": "The unique identifier of the key", + "type": "string" + }, + "kty": { + "description": "The type of public key", + "enum": [ + "EC" + ], + "type": "string" + }, + "use": { + "description": "The intended use for the key. This value is either `enc` (encryption) during enrollment, when Okta uses the ECKeyJWK to encrypt requests to Yubico. Or it's `sig` (signature) during activation, when Okta uses the ECKeyJWK to verify the responses from Yubico.", + "enum": [ + "enc", + "sig" + ], + "type": "string" + }, + "x": { + "description": "The public x coordinate for the elliptic curve point", + "type": "string" + }, + "y": { + "description": "The public y coordinate for the elliptic curve point", + "type": "string" + } + }, + "required": [ + "x", + "y", + "kty", + "crv", + "use", + "kid" + ], + "type": "object" + }, + "ETag": { + "description": "Header to track the completion time of the resource fetch job", + "type": "string" + }, + "EmailContent": { + "properties": { + "body": { + "description": "The HTML body of the email. May contain [variable references](https://velocity.apache.org/engine/1.7/user-guide.html#references). \n\n<x-lifecycle class=\"ea\"></x-lifecycle> Not required if Custom languages for Okta Email Templates is enabled. A `null` body is replaced with a default value from one of the following in priority order:\n\n1. An existing default email customization, if one exists\n2. Okta-provided translated content for the specified language, if one exists\n3. Okta-provided translated content for the brand locale, if it's set \n4. Okta-provided content in English\n", + "type": "string" + }, + "subject": { + "description": "The email subject. May contain [variable references](https://velocity.apache.org/engine/1.7/user-guide.html#references).\n\n<x-lifecycle class=\"ea\"></x-lifecycle> Not required if Custom languages for Okta Email Templates is enabled. A `null` subject is replaced with a default value from one of the following in priority order:\n\n1. An existing default email customization, if one exists\n2. Okta-provided translated content for the specified language, if one exists\n3. Okta-provided translated content for the brand locale, if it's set\n4. Okta-provided content in English\n", + "type": "string" + } + }, + "required": [ + "subject", + "body" + ], + "type": "object" + }, + "EmailCustomization": { + "allOf": [ + { + "$ref": "#/components/schemas/EmailContent" + }, + { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "preview": { + "$ref": "#/components/schemas/HrefObject" + }, + "self": { + "$ref": "#/components/schemas/HrefObject" + }, + "template": { + "$ref": "#/components/schemas/HrefObject" + }, + "test": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + }, + "created": { + "description": "The UTC time at which this email customization was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "A unique identifier for this email customization", + "readOnly": true, + "type": "string" + }, + "isDefault": { + "description": "Whether this is the default customization for the email template. Each customized email template must have exactly one default customization. Defaults to `true` for the first customization and `false` thereafter.", + "type": "boolean" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "lastUpdated": { + "description": "The UTC time at which this email customization was last updated.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "language" + ], + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EmailDefaultContent": { + "allOf": [ + { + "$ref": "#/components/schemas/EmailContent" + }, + { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "preview": { + "$ref": "#/components/schemas/HrefObject" + }, + "template": { + "$ref": "#/components/schemas/HrefObject" + }, + "test": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ], + "type": "object" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EmailDomain": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseEmailDomain" + } + ], + "properties": { + "brandId": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "validationSubdomain": { + "default": "mail", + "description": "Subdomain for the email sender's custom mail domain. Specify your subdomain when you configure a custom mail domain.", + "type": "string" + } + }, + "required": [ + "domain", + "brandId" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EmailDomainDNSRecord": { + "properties": { + "fqdn": { + "type": "string" + }, + "recordType": { + "$ref": "#/components/schemas/EmailDomainDNSRecordType" + }, + "verificationValue": { + "type": "string" + } + }, + "type": "object" + }, + "EmailDomainDNSRecordType": { + "enum": [ + "CNAME", + "TXT" + ], + "type": "string" + }, + "EmailDomainResponse": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseEmailDomain" + } + ], + "properties": { + "dnsValidationRecords": { + "items": { + "$ref": "#/components/schemas/EmailDomainDNSRecord" + }, + "type": "array" + }, + "domain": { + "type": "string" + }, + "id": { + "type": "string" + }, + "validationStatus": { + "$ref": "#/components/schemas/EmailDomainStatus" + }, + "validationSubdomain": { + "default": "mail", + "description": "The subdomain for the email sender's custom mail domain", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EmailDomainResponseWithEmbedded": { + "allOf": [ + { + "$ref": "#/components/schemas/EmailDomainResponse" + } + ], + "properties": { + "_embedded": { + "properties": { + "brands": { + "items": { + "$ref": "#/components/schemas/Brand" + }, + "type": "array" + } + }, + "readOnly": true, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EmailDomainStatus": { + "enum": [ + "DELETED", + "ERROR", + "NOT_STARTED", + "POLLING", + "VERIFIED" + ], + "type": "string", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EmailPreview": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "contentSource": { + "$ref": "#/components/schemas/HrefObject" + }, + "defaultContent": { + "$ref": "#/components/schemas/HrefObject" + }, + "template": { + "$ref": "#/components/schemas/HrefObject" + }, + "test": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + }, + "body": { + "description": "The email's HTML body", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The email's subject", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EmailServerListResponse": { + "properties": { + "email-servers": { + "description": "List of enrolled SMTP servers", + "items": { + "$ref": "#/components/schemas/BaseEmailServer" + }, + "type": "array" + } + }, + "type": "object" + }, + "EmailSettings": { + "properties": { + "recipients": { + "enum": [ + "ALL_USERS", + "ADMINS_ONLY", + "NO_USERS" + ], + "type": "string" + } + }, + "required": [ + "recipients" + ], + "type": "object" + }, + "EmailSettingsResponse": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "self": { + "$ref": "#/components/schemas/HrefObject" + }, + "template": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + }, + "recipients": { + "enum": [ + "ALL_USERS", + "ADMINS_ONLY", + "NO_USERS" + ], + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EmailTemplateResponse": { + "properties": { + "_embedded": { + "properties": { + "customizationCount": { + "type": "integer" + }, + "settings": { + "$ref": "#/components/schemas/EmailSettingsResponse" + } + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "customizations": { + "$ref": "#/components/schemas/HrefObject" + }, + "defaultContent": { + "$ref": "#/components/schemas/HrefObject" + }, + "settings": { + "$ref": "#/components/schemas/HrefObject" + }, + "test": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + }, + "name": { + "description": "The name of this email template", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EmailTemplateTouchPointVariant": { + "default": "OKTA_DEFAULT", + "description": "Variant for email templates. You can publish a theme for email templates with different combinations of assets. Variants are preset combinations of those assets.\n", + "enum": [ + "FULL_THEME", + "OKTA_DEFAULT" + ], + "type": "string", + "x-enumDescriptions": { + "FULL_THEME": "Uses the Okta logo and Okta colors in email templates", + "OKTA_DEFAULT": "Uses the logo from the theme. Uses `primaryColorHex` as the background color for buttons." + } + }, + "EmailTestAddresses": { + "properties": { + "fromAddress": { + "description": "Email address that sends test emails", + "example": "sender@host.com", + "type": "string" + }, + "toAddress": { + "description": "Email address that receives test emails", + "example": "receiver@host.com", + "type": "string" + } + }, + "required": [ + "fromAddress", + "toAddress" + ], + "type": "object" + }, + "EmptyRequestSchema": { + "additionalProperties": false, + "description": "Empty object payload", + "title": "Empty", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EnabledStatus": { + "description": "Setting status", + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "EndUserDashboardTouchPointVariant": { + "default": "OKTA_DEFAULT", + "description": "Variant for the Okta End-User Dashboard. You can publish a theme for end-user dashboard with different combinations of assets. Variants are preset combinations of those assets.\n", + "enum": [ + "FULL_THEME", + "LOGO_ON_FULL_WHITE_BACKGROUND", + "OKTA_DEFAULT", + "WHITE_LOGO_BACKGROUND" + ], + "type": "string", + "x-enumDescriptions": { + "FULL_THEME": "Uses the logo and favicon from the theme. Uses `primaryColorHex` for the logo and the side navigation bar background color.", + "LOGO_ON_FULL_WHITE_BACKGROUND": "Uses the logo and favicon from the theme. Uses white background color for the logo and the side navigation bar background color.", + "OKTA_DEFAULT": "Uses the Okta logo and favicon. Uses a white background color for the logo and the side navigation bar background color.", + "WHITE_LOGO_BACKGROUND": "Uses the logo and favicon from the theme, with a white background color for the logo. Uses `primaryColorHex` for the side navigation bar background color." + } + }, + "EndpointAuthMethod": { + "description": "Requested authentication method for OAuth 2.0 endpoints.", + "enum": [ + "client_secret_basic", + "client_secret_jwt", + "client_secret_post", + "none", + "private_key_jwt" + ], + "type": "string" + }, + "EnhancedDynamicNetworkZone": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkZone" + }, + { + "title": "Enhanced Dynamic Network Zone" + }, + { + "properties": { + "asns": { + "description": "The list of ASNs associated with an Enhanced Dynamic Network Zone", + "properties": { + "exclude": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkZoneAsns" + }, + { + "description": "An array of ASNs to exclude for an Enhanced Dynamic Network Zone" + } + ] + }, + "include": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkZoneAsns" + }, + { + "description": "An array of ASNs to include for an Enhanced Dynamic Network Zone" + } + ] + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "ipServiceCategories": { + "description": "IP services, such as a proxy or VPN, to include or exclude for an Enhanced Dynamic Network Zone", + "properties": { + "exclude": { + "description": "IP services to exclude for an Enhanced Dynamic Network Zone", + "items": { + "$ref": "#/components/schemas/IPServiceCategory" + }, + "maximum": 75, + "type": "array" + }, + "include": { + "description": "IP services to include for an Enhanced Dynamic Network Zone", + "items": { + "$ref": "#/components/schemas/IPServiceCategory" + }, + "maximum": 75, + "type": "array" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "locations": { + "description": "The list of geolocations to include or exclude for an Enhanced Dynamic Network Zone", + "properties": { + "exclude": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkZoneLocationArray" + }, + { + "description": "An array of geolocations to exclude for an Enhanced Dynamic Network Zone" + } + ] + }, + "include": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkZoneLocationArray" + }, + { + "description": "An array of geolocations to include for an Enhanced Dynamic Network Zone" + } + ] + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EnrollmentActivationRequest": { + "description": "Enrollment Initialization Request", + "properties": { + "credResponses": { + "description": "List of credential responses from the fulfillment provider", + "items": { + "$ref": "#/components/schemas/WebAuthnCredResponse" + }, + "type": "array" + }, + "fulfillmentProvider": { + "description": "Name of the fulfillment provider for the WebAuthn preregistration factor", + "enum": [ + "yubico" + ], + "type": "string" + }, + "pinResponseJwe": { + "description": "Encrypted JWE of the PIN response from the fulfillment provider", + "type": "string" + }, + "serial": { + "description": "Serial number of the YubiKey", + "type": "string" + }, + "userId": { + "description": "ID of an existing Okta user", + "type": "string" + }, + "version": { + "description": "Firmware version of the YubiKey", + "type": "string" + }, + "yubicoSigningJwks": { + "description": "List of usable signing keys from Yubico (in JSON Web Key Sets (JWKS) format). The signing keys are used to verify the JSON Web Signature (JWS) inside the JWE.", + "items": { + "$ref": "#/components/schemas/ECKeyJWK" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnrollmentActivationResponse": { + "description": "Enrollment initialization response", + "properties": { + "authenticatorEnrollmentIds": { + "description": "List of IDs for preregistered WebAuthn factors in Okta", + "items": { + "type": "string" + }, + "type": "array" + }, + "fulfillmentProvider": { + "description": "Name of the fulfillment provider for the WebAuthn preregistration factor", + "enum": [ + "yubico" + ], + "type": "string" + }, + "userId": { + "description": "ID of an existing Okta user", + "type": "string" + } + }, + "type": "object" + }, + "EnrollmentInitializationRequest": { + "description": "Enrollment initialization request", + "properties": { + "enrollmentRpIds": { + "description": "List of relying party hostnames to register on the YubiKey", + "items": { + "type": "string" + }, + "type": "array" + }, + "fulfillmentProvider": { + "description": "Name of the fulfillment provider for the WebAuthn preregistration factor", + "enum": [ + "yubico" + ], + "type": "string" + }, + "userId": { + "description": "ID of an existing Okta user", + "type": "string" + }, + "yubicoTransportKeyJWK": { + "$ref": "#/components/schemas/ECKeyJWK", + "description": "Transport public key in JWK (JSON Web Key) format used to encrypt fulfillment requests to Yubico" + } + }, + "type": "object" + }, + "EnrollmentInitializationResponse": { + "description": "Yubico transport key in the form of a JSON Web Token (JWK), used to encrypt our fulfillment request to Yubico. The currently agreed protocol uses P-384.", + "properties": { + "credRequests": { + "description": "List of credential requests for the fulfillment provider", + "items": { + "$ref": "#/components/schemas/WebAuthnCredRequest" + }, + "type": "array" + }, + "fulfillmentProvider": { + "description": "Name of the fulfillment provider for the WebAuthn preregistration factor", + "enum": [ + "yubico" + ], + "type": "string" + }, + "pinRequestJwe": { + "description": "Encrypted JWE of PIN request for the fulfillment provider", + "type": "string" + }, + "userId": { + "description": "ID of an existing Okta user", + "type": "string" + } + }, + "type": "object" + }, + "EnrollmentPolicyAuthenticatorGracePeriod": { + "description": "Specifies the [grace period](https://developer.okta.com/docs/concepts/policies/#authenticator-enrollment-policies) configuration for completing an authenticator enrollment or setup", + "discriminator": { + "mapping": { + "BY_DATE_TIME": "#/components/schemas/ByDateTimeAuthenticatorGracePeriodExpiry", + "BY_SKIP_COUNT": "#/components/schemas/BySkipCountAuthenticatorGracePeriod" + }, + "propertyName": "type" + }, + "properties": { + "type": { + "description": "Grace period type\n\n* `BY_DATE_TIME`: The grace period is defined by a specific date and time.\n* `BY_SKIP_COUNT`: The grace period is defined by the number of times the user can skip enrolling the corresponding authenticator.", + "enum": [ + "BY_DATE_TIME", + "BY_DATE_TIME", + "BY_SKIP_COUNT" + ], + "type": "string" + } + }, + "type": "object" + }, + "EntitlementValue": { + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "properties": { + "app": { + "$ref": "#/components/schemas/HrefObjectAppLink" + }, + "group": { + "$ref": "#/components/schemas/HrefObjectGroupLink" + }, + "resource-set": { + "$ref": "#/components/schemas/HrefObjectResourceSetLink" + } + }, + "readOnly": true, + "type": "object" + }, + "id": { + "description": "Entitlement value ID", + "type": "string" + }, + "name": { + "description": "The entitlement value resource name", + "type": "string" + }, + "value": { + "description": "The entitlement value resource [ORN](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn)", + "type": "string" + } + }, + "type": "object" + }, + "EntitlementValuesResponse": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "bundle": { + "$ref": "#/components/schemas/BundleLink" + }, + "entitlements": { + "$ref": "#/components/schemas/EntitlementsLink" + }, + "next": { + "$ref": "#/components/schemas/HrefObjectNextLink" + } + } + } + ] + }, + "entitlementValues": { + "description": "List of entitlement values for a bundle entitlement", + "items": { + "$ref": "#/components/schemas/EntitlementValue" + }, + "type": "array" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EntitlementsCapability": { + "description": "Entitlements capability configuration with embedded protocol details.\n\n**Protocol validation rule:**\n- The `actions` parameter is required when `supportedProtocols` is set to `ACTIONS`.\n", + "properties": { + "actions": { + "description": "Configuration for the Actions protocol. This parameter is required when `supportedProtocols` is set to `ACTIONS`.", + "items": { + "$ref": "#/components/schemas/SubmissionAction" + }, + "type": "array" + }, + "capability": { + "description": "Entitlements capability identifier", + "enum": [ + "ENTITLEMENTS" + ], + "type": "string" + }, + "supportedProtocols": { + "description": "List of supported entitlements protocols", + "items": { + "enum": [ + "ACTIONS" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "capability", + "supportedProtocols" + ], + "type": "object" + }, + "EntitlementsLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the entitlements resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EntityRiskPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "type": "object" + } + ], + "properties": { + "conditions": { + "default": null, + "description": "Policy conditions aren't supported for this policy type.", + "nullable": true, + "type": "string" + } + }, + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EntityRiskPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "description": "The action to take based on the risk event", + "properties": { + "entityRisk": { + "description": "The object that contains the `actions` array", + "properties": { + "actions": { + "description": "The `entityRisk` object's `actions` array can be empty or contain one of two `action` object value pairs. This object determines the specific response to a risk event.", + "items": { + "$ref": "#/components/schemas/EntityRiskPolicyRuleActionsObject" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "conditions": { + "$ref": "#/components/schemas/EntityRiskPolicyRuleConditions" + } + }, + "type": "object" + } + ] + }, + "EntityRiskPolicyRuleActionRunWorkflow": { + "properties": { + "action": { + "enum": [ + "RUN_WORKFLOW" + ], + "type": "string" + }, + "workflow": { + "description": "This action runs a workflow", + "properties": { + "id": { + "description": "The `id` of the workflow that runs.", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "EntityRiskPolicyRuleActionTerminateAllSessions": { + "properties": { + "action": { + "description": "This action revokes or terminates all of the user's active sessions.", + "enum": [ + "TERMINATE_ALL_SESSIONS" + ], + "type": "string" + } + }, + "type": "object" + }, + "EntityRiskPolicyRuleActionsObject": { + "discriminator": { + "mapping": { + "RUN_WORKFLOW": "#/components/schemas/EntityRiskPolicyRuleActionRunWorkflow", + "TERMINATE_ALL_SESSIONS": "#/components/schemas/EntityRiskPolicyRuleActionTerminateAllSessions" + }, + "propertyName": "action" + }, + "properties": { + "action": { + "enum": [ + "RUN_WORKFLOW", + "TERMINATE_ALL_SESSIONS" + ], + "type": "string" + } + }, + "type": "object" + }, + "EntityRiskPolicyRuleConditions": { + "allOf": [ + { + "type": "object" + }, + { + "description": "Specifies conditions that must be met during policy evaluation to apply the rule. All policy conditions and conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule.", + "properties": { + "entityRisk": { + "$ref": "#/components/schemas/EntityRiskScorePolicyRuleCondition" + }, + "people": { + "$ref": "#/components/schemas/PolicyPeopleCondition" + }, + "riskDetectionTypes": { + "$ref": "#/components/schemas/RiskDetectionTypesPolicyRuleCondition" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EntityRiskScorePolicyRuleCondition": { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle> The risk score level of the entity risk policy rule", + "properties": { + "level": { + "enum": [ + "ANY", + "LOW", + "MEDIUM", + "HIGH" + ], + "type": "string" + } + }, + "required": [ + "level" + ], + "type": "object" + }, + "Error": { + "properties": { + "errorCauses": { + "items": { + "$ref": "#/components/schemas/ErrorCause" + }, + "type": "array" + }, + "errorCode": { + "description": "An Okta code for this type of error", + "type": "string" + }, + "errorId": { + "description": "A unique identifier for this error. This can be used by Okta Support to help with troubleshooting.", + "type": "string" + }, + "errorLink": { + "description": "An Okta code for this type of error", + "type": "string" + }, + "errorSummary": { + "description": "A short description of what caused this error. Sometimes this contains dynamically-generated information about your specific error.", + "type": "string" + } + }, + "title": "Error", + "type": "object" + }, + "Error409": { + "description": "Conflict error object", + "properties": { + "errorCauses": { + "description": "Another request has already been received for the settings for this email template", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "errorCode": { + "description": "E0000254", + "readOnly": true, + "type": "string" + }, + "errorId": { + "description": "sampleH3iLB6bpBcbnV9E09Fy", + "readOnly": true, + "type": "string" + }, + "errorLink": { + "description": "E0000254", + "readOnly": true, + "type": "string" + }, + "errorSummary": { + "description": "Another request has already been received for the settings for this email template", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ErrorCause": { + "properties": { + "errorSummary": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorPage": { + "allOf": [ + { + "$ref": "#/components/schemas/CustomizablePage" + }, + { + "properties": { + "contentSecurityPolicySetting": { + "$ref": "#/components/schemas/ContentSecurityPolicySetting" + } + }, + "type": "object" + } + ] + }, + "ErrorPageTouchPointVariant": { + "default": "OKTA_DEFAULT", + "description": "Variant for the error page. You can publish a theme for error page with different combinations of assets. Variants are preset combinations of those assets.\n", + "enum": [ + "BACKGROUND_IMAGE", + "BACKGROUND_SECONDARY_COLOR", + "OKTA_DEFAULT" + ], + "type": "string", + "x-enumDescriptions": { + "BACKGROUND_IMAGE": "Uses the logo, favicon, and background image from the theme", + "BACKGROUND_SECONDARY_COLOR": "Uses the logo and favicon from the theme. Uses `secondaryColorHex` as the background color for the error page.", + "OKTA_DEFAULT": "Uses the Okta logo, favicon, and background color" + } + }, + "EventHook": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "deactivate": { + "$ref": "#/components/schemas/HrefObject" + }, + "verify": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + }, + "channel": { + "$ref": "#/components/schemas/EventHookChannel" + }, + "created": { + "description": "Timestamp of the event hook creation", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "The ID of the user who created the event hook", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of the event hook", + "nullable": true, + "type": "string" + }, + "events": { + "$ref": "#/components/schemas/EventSubscriptions" + }, + "id": { + "description": "Unique key for the event hook", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Date of the last event hook update", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Display name for the event hook", + "type": "string" + }, + "status": { + "description": "Status of the event hook", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "readOnly": true, + "type": "string" + }, + "verificationStatus": { + "$ref": "#/components/schemas/EventHookVerificationStatus" + } + }, + "required": [ + "name", + "events", + "channel" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "EventHookChannel": { + "properties": { + "config": { + "$ref": "#/components/schemas/EventHookChannelConfig" + }, + "type": { + "$ref": "#/components/schemas/EventHookChannelType" + }, + "version": { + "description": "Version of the channel. Currently the only supported version is `1.0.0`.", + "type": "string" + } + }, + "required": [ + "type", + "config", + "version" + ], + "type": "object" + }, + "EventHookChannelConfig": { + "properties": { + "authScheme": { + "$ref": "#/components/schemas/EventHookChannelConfigAuthScheme" + }, + "headers": { + "description": "Optional list of key/value pairs for headers that can be sent with the request to the external service. For example,\n`X-Other-Header` is an example of an optional header, with a value of `my-header-value`, that you want Okta to pass to your\nexternal service.", + "items": { + "$ref": "#/components/schemas/EventHookChannelConfigHeader" + }, + "type": "array" + }, + "method": { + "description": "The method of the Okta event hook request", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "The external service endpoint called to execute the event hook handler", + "type": "string" + } + }, + "required": [ + "uri" + ], + "type": "object" + }, + "EventHookChannelConfigAuthScheme": { + "description": "The authentication scheme used for this request.\n\nTo use Basic Auth for authentication, set `type` to `HEADER`,\n`key` to `Authorization`, and `value` to the Base64-encoded string of \"username:password\". Ensure that you include\nthe scheme (including space) as part of the `value` parameter. For example, `Basic YWRtaW46c3VwZXJzZWNyZXQ=`.", + "properties": { + "key": { + "description": "The name for the authorization header", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/EventHookChannelConfigAuthSchemeType" + }, + "value": { + "description": "The header value. This secret key is passed to your external service endpoint for security verification.\nThis property is not returned in the response.", + "type": "string", + "writeOnly": true + } + }, + "type": "object" + }, + "EventHookChannelConfigAuthSchemeType": { + "description": "The authentication scheme type. Currently only supports `HEADER`.", + "enum": [ + "HEADER" + ], + "type": "string" + }, + "EventHookChannelConfigHeader": { + "nullable": true, + "properties": { + "key": { + "description": "The optional field or header name", + "type": "string" + }, + "value": { + "description": "The value for the key", + "type": "string" + } + }, + "type": "object" + }, + "EventHookChannelType": { + "description": "The channel type. Currently supports `HTTP`.", + "enum": [ + "HTTP" + ], + "type": "string" + }, + "EventHookFilterMap": { + "description": "The object that maps the filter to the event type", + "items": { + "$ref": "#/components/schemas/EventHookFilterMapObject" + }, + "type": "array" + }, + "EventHookFilterMapObject": { + "properties": { + "condition": { + "$ref": "#/components/schemas/EventHookFilterMapObjectCondition" + }, + "event": { + "description": "The filtered event type", + "type": "string" + } + }, + "type": "object" + }, + "EventHookFilterMapObjectCondition": { + "properties": { + "expression": { + "description": "The Okta Expression language statement that filters the event type", + "type": "string" + }, + "version": { + "description": "Internal field", + "nullable": true, + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EventHookFilters": { + "description": "The optional filter defined on a specific event type\n\n> **Note:** Event hook filters is a [self-service Early Access (EA)](/openapi/okta-management/guides/release-lifecycle/#early-access-ea) to enable.\nIf you want to disable this feature, it's recommended to first remove all event filters.", + "nullable": true, + "properties": { + "eventFilterMap": { + "$ref": "#/components/schemas/EventHookFilterMap" + }, + "type": { + "description": "The type of filter. Currently only supports `EXPRESSION_LANGUAGE`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EventHookSubscribedEventTypes": { + "description": "The subscribed event types that trigger the event hook. When you register an event hook\nyou need to specify which events you want to subscribe to. To see the list of event types\ncurrently eligible for use in event hooks, use the [Event Types catalog](https://developer.okta.com/docs/reference/api/event-types/#catalog)\nand search with the parameter `event-hook-eligible`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "EventHookVerificationStatus": { + "description": "Verification status of the event hook. `UNVERIFIED` event hooks won't receive any events.", + "enum": [ + "UNVERIFIED", + "VERIFIED" + ], + "readOnly": true, + "type": "string" + }, + "EventSubscriptionType": { + "description": "The events object type. Currently supports `EVENT_TYPE`.", + "enum": [ + "EVENT_TYPE" + ], + "type": "string" + }, + "EventSubscriptions": { + "properties": { + "filter": { + "$ref": "#/components/schemas/EventHookFilters" + }, + "items": { + "$ref": "#/components/schemas/EventHookSubscribedEventTypes" + }, + "type": { + "$ref": "#/components/schemas/EventSubscriptionType" + } + }, + "required": [ + "type", + "items" + ], + "type": "object" + }, + "ExpiresAt": { + "description": "Timestamp when the object expires", + "example": "2016-01-03T18:15:47.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "ExpressConfiguration": { + "description": "Auth0 tenant details used to enable Express Configuration on an OIN Integration submission. Populates the submission's sign-on, authentication, and app settings so that admins can configure the app through the Express Configuration flow.", + "properties": { + "applicationClientId": { + "description": "The client ID of the SaaS application that end users sign in to", + "example": "0oa9z8y7x6w5v4u3t2s1", + "maxLength": 64, + "type": "string" + }, + "capabilities": { + "description": "The Express Configuration capabilities to enable on the submission. If omitted, all capabilities are automatically configured based on the OIN integration's supported protocols.", + "items": { + "$ref": "#/components/schemas/ExpressConfigureCapabilityType" + }, + "type": "array", + "uniqueItems": true + }, + "initiateLoginUriTemplate": { + "description": "The URL template that Okta uses to launch the app from the end-user dashboard. Supports template variables `{organization_name}`, `{organization_id}`, and `{connection_name}`.", + "example": "https://example.auth0.com/login/initiate", + "maxLength": 2048, + "type": "string" + }, + "loginDomain": { + "description": "The Auth0 admin login domain that Okta redirects to as part of the consent flow in a web browser. Use the custom domain name if one is configured in Auth0.", + "example": "login.example.com", + "maxLength": 255, + "type": "string" + }, + "oinClientId": { + "description": "The client ID of the additional client application that Auth0 creates for the OIN administrator consent flow between Okta and Auth0", + "example": "0oa1a2b3c4d5e6f7g8h9", + "maxLength": 64, + "type": "string" + }, + "tenantDomain": { + "description": "The Auth0 tenant domain (for example, `example.auth0.com`)", + "example": "example.auth0.com", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "oinClientId", + "applicationClientId", + "tenantDomain", + "loginDomain" + ], + "type": "object" + }, + "ExpressConfigureCapabilityType": { + "description": "Capability type", + "enum": [ + "PROVISIONING", + "SSO", + "UNIVERSAL_LOGOUT" + ], + "type": "string", + "x-enumDescriptions": { + "PROVISIONING": "Express setup enabled for provisioning", + "SSO": "Express setup enabled for SSO", + "UNIVERSAL_LOGOUT": "Express setup enabled for Universal Logout" + } + }, + "Expression": { + "description": "Conditional expression", + "properties": { + "value": { + "description": "Value of the condition expression", + "type": "string" + } + }, + "type": "object" + }, + "FCMConfiguration": { + "properties": { + "fileName": { + "description": "(Optional) File name for Admin Console display", + "type": "string" + }, + "projectId": { + "description": "Project ID of FCM configuration", + "readOnly": true, + "type": "string" + }, + "serviceAccountJson": { + "description": "JSON containing the private service account key and service account details. See [Creating and managing service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys) for more information on creating service account keys in JSON.", + "type": "object", + "writeOnly": true + } + }, + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "FCMPushProvider": { + "allOf": [ + { + "$ref": "#/components/schemas/PushProvider" + }, + { + "properties": { + "configuration": { + "$ref": "#/components/schemas/FCMConfiguration" + } + }, + "type": "object" + } + ] + }, + "FailbackRequestSchema": { + "properties": { + "domains": { + "description": "The Okta domain to failback", + "items": { + "description": "Okta domain to failback", + "example": "yourOktaDomain.okta.com", + "type": "string" + }, + "type": "array" + } + }, + "title": "Domains", + "type": "object" + }, + "FailoverRequestSchema": { + "properties": { + "domains": { + "description": "The Okta domain to failover", + "items": { + "description": "Okta domain to failover", + "example": "yourOktaDomain.okta.com", + "type": "string" + }, + "type": "array" + } + }, + "title": "Domains", + "type": "object" + }, + "Feature": { + "description": "Specifies feature release cycle information", + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "dependencies": { + "description": "Link to feature dependencies", + "properties": { + "href": { + "description": "Link URI", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "dependents": { + "description": "Link to feature dependents", + "properties": { + "href": { + "description": "Link URI", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + } + } + } + ] + }, + "description": { + "description": "Brief description of the feature and what it provides", + "type": "string" + }, + "id": { + "description": "Unique identifier for this feature", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the feature", + "type": "string" + }, + "stage": { + "$ref": "#/components/schemas/FeatureStage" + }, + "status": { + "$ref": "#/components/schemas/EnabledStatus" + }, + "type": { + "$ref": "#/components/schemas/FeatureType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "FeatureLifecycle": { + "enum": [ + "DISABLE", + "ENABLE" + ], + "example": "ENABLE", + "type": "string" + }, + "FeatureStage": { + "description": "Current release cycle stage of a feature\n\nIf a feature's stage value is `EA`, the state is `null` and not returned. If the value is `BETA`, the state is `OPEN` or `CLOSED` depending on whether the `BETA` feature is manageable.\n\n> **Note:** If a feature's stage is `OPEN BETA`, you can update it only in Preview cells. If a feature's stage is `CLOSED BETA`, you can disable it only in Preview cells.", + "properties": { + "state": { + "$ref": "#/components/schemas/FeatureStageState" + }, + "value": { + "$ref": "#/components/schemas/FeatureStageValue" + } + }, + "type": "object" + }, + "FeatureStageState": { + "description": "Indicates the release state of the feature", + "enum": [ + "CLOSED", + "OPEN" + ], + "type": "string" + }, + "FeatureStageValue": { + "description": "Current release stage of the feature", + "enum": [ + "BETA", + "EA" + ], + "type": "string" + }, + "FeatureType": { + "description": "Type of feature", + "enum": [ + "self-service" + ], + "type": "string" + }, + "FederatedClaim": { + "properties": { + "created": { + "description": "Timestamp when the federated claim was created", + "example": "2024-02-29T20:08:24.000Z", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "expression": { + "description": "The Okta Expression Language expression to be evaluated at runtime", + "example": "appuser.entitlements.role", + "nullable": false, + "readOnly": false, + "type": "string" + }, + "id": { + "description": "The unique ID of the federated claim", + "example": "ofc2f4zrZbs8nUa7p0g4", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the federated claim was updated", + "example": "2023-02-21T20:08:24.000Z", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the claim to be used in the produced token", + "example": "roleg", + "nullable": false, + "readOnly": false, + "type": "string" + } + }, + "type": "object" + }, + "FederatedClaimRequestBody": { + "properties": { + "expression": { + "description": "The Okta Expression Language expression to be evaluated at runtime", + "example": "appuser.entitlements.role", + "type": "string" + }, + "name": { + "description": "The name of the claim to be used in the produced token", + "example": "role", + "type": "string" + } + }, + "type": "object" + }, + "FipsEnum": { + "enum": [ + "OPTIONAL", + "REQUIRED" + ], + "type": "string" + }, + "ForgotPasswordResponse": { + "properties": { + "resetPasswordUrl": { + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "FulfillmentData": { + "description": "List of fulfillment order details", + "items": { + "$ref": "#/components/schemas/FulfillmentDataOrderDetails" + }, + "type": "array" + }, + "FulfillmentDataOrderDetails": { + "description": "Information about the fulfillment order that includes the factor\u2019s make and model, the custom configuration of the factor, and inventory details.", + "properties": { + "customizationId": { + "description": "ID for the set of custom configurations of the requested factor", + "type": "string" + }, + "inventoryProductId": { + "description": "ID for the specific inventory bucket of the requested factor", + "type": "string" + }, + "productId": { + "description": "ID for the make and model of the requested factor", + "type": "string" + } + }, + "type": "object" + }, + "FulfillmentRequest": { + "description": "Fulfillment request", + "properties": { + "fulfillmentData": { + "$ref": "#/components/schemas/FulfillmentData" + }, + "fulfillmentProvider": { + "description": "Name of the fulfillment provider for the WebAuthn preregistration factor", + "enum": [ + "yubico" + ], + "type": "string" + }, + "userId": { + "description": "ID of an existing Okta user", + "type": "string" + } + }, + "type": "object" + }, + "GlobalTokenRevocation": { + "properties": { + "authMethod": { + "description": "Authentication method <br> **Note:** Currently, only the `SIGNED_JWT` method is supported", + "enum": [ + "SIGNED_JWT" + ], + "type": "string" + }, + "endpoint": { + "description": "URL of the authorization server's global token revocation endpoint", + "format": "uri", + "type": "string" + }, + "partialLogout": { + "default": false, + "description": "Allow partial support for Universal Logout", + "type": "boolean" + }, + "subjectFormat": { + "description": "The format of the subject", + "enum": [ + "EMAIL", + "ISS_SUB" + ], + "type": "string" + } + }, + "required": [ + "endpoint", + "subjectFormat", + "authMethod" + ], + "type": "object" + }, + "GoogleApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/OINApplication" + }, + { + "type": "object" + }, + { + "properties": { + "name": { + "enum": [ + "google" + ], + "example": "google", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/GoogleApplicationSettings" + }, + "signOnMode": { + "enum": [ + "BROWSER_PLUGIN", + "SAML_2_0" + ], + "example": "BROWSER_PLUGIN", + "type": "string" + } + }, + "required": [ + "name", + "label", + "settings" + ] + } + ], + "description": "Schema for the Google Workspace app (key name: `google`)\n\nTo create a Google Workspace app, use the [Create an Application](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/application/other/createapplication) request with the following parameters in the request body.\n> **Note:** The Google Workspace app only supports `BROWSER_PLUGIN` and `SAML_2_0` sign-on modes.\n", + "example": { + "label": "Sample Google App", + "name": "google", + "settings": { + "app": { + "domain": "my-company-domain" + } + }, + "signOnMode": "SAML_2_0" + }, + "title": "Google Workspace", + "x-okta-defined-as": { + "name": "google" + }, + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-tags": [ + "Application" + ] + }, + "GoogleApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "type": "object" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/GoogleApplicationSettingsApplication" + }, + "signOn": { + "$ref": "#/components/schemas/OINSaml20ApplicationSettingsSignOn" + } + }, + "required": [ + "app" + ] + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "GoogleApplicationSettingsApplication": { + "description": "Google app instance properties", + "properties": { + "domain": { + "description": "Your Google company domain", + "type": "string" + }, + "rpId": { + "description": "RPID", + "type": "string" + } + }, + "required": [ + "domain" + ], + "type": "object" + }, + "GovernanceBundle": { + "properties": { + "_links": { + "description": "Link relations available", + "properties": { + "entitlements": { + "$ref": "#/components/schemas/EntitlementsLink" + }, + "self": { + "$ref": "#/components/schemas/HrefObjectSelfLink" + } + }, + "type": "object" + }, + "description": { + "description": "Description of the governance bundle", + "type": "string" + }, + "id": { + "description": "Governance bundle ID", + "type": "string" + }, + "name": { + "description": "Name of the governance bundle", + "type": "string" + }, + "orn": { + "description": "The governance bundle resource, in [ORN format](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn)", + "type": "string" + }, + "status": { + "description": "Status of the governance bundle", + "type": "string" + } + }, + "type": "object" + }, + "GovernanceBundleCreateRequest": { + "description": "Request to create a governance bundle", + "properties": { + "description": { + "description": "Description of the governance bundle", + "type": "string" + }, + "entitlements": { + "description": "List of entitlements to include in the governance bundle", + "items": { + "$ref": "#/components/schemas/IAMBundleEntitlement" + }, + "type": "array" + }, + "name": { + "description": "Name of the governance bundle", + "type": "string" + } + }, + "type": "object" + }, + "GovernanceBundleUpdateRequest": { + "description": "Request to update a governance bundle", + "properties": { + "description": { + "description": "Description of the governance bundle", + "type": "string" + }, + "entitlements": { + "description": "List of entitlements to include in the governance bundle", + "items": { + "$ref": "#/components/schemas/IAMBundleEntitlement" + }, + "type": "array" + }, + "name": { + "description": "Name of the governance bundle", + "type": "string" + } + }, + "type": "object" + }, + "GovernanceBundlesResponse": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "readOnly": true + }, + { + "properties": { + "next": { + "$ref": "#/components/schemas/HrefObjectNextLink" + } + }, + "type": "object" + } + ] + }, + "bundles": { + "description": "List of governance bundles", + "items": { + "$ref": "#/components/schemas/GovernanceBundle" + }, + "type": "array" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "GovernanceSourceType": { + "description": "The grant type", + "enum": [ + "CUSTOM", + "ENTITLEMENT-BUNDLE" + ], + "type": "string" + }, + "GracePeriod": { + "description": "Represents the Grace Period configuration for the device assurance policy", + "properties": { + "expiry": { + "oneOf": [ + { + "$ref": "#/components/schemas/DateTime" + }, + { + "$ref": "#/components/schemas/TimeDuration" + } + ] + }, + "type": { + "description": "Represents the type of Grace Period configured for the device assurance policy", + "enum": [ + "BY_DATE_TIME", + "BY_DURATION" + ], + "example": "BY_DATE_TIME", + "type": "string", + "x-enumDescriptions": { + "BY_DATE_TIME": "The Grace Period configured for this device assurance policy expires at a specified date and time", + "BY_DURATION": "The Grace Period configured for this device assurance policy expires after a specified duration" + } + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "GracePeriodRequiredSoon": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Customizable strings to use with [grace periods](https://developer.okta.com/docs/concepts/policies/#authenticator-enrollment-policies) that are shown on the Sign-In Widget\n\nYou can use the `gracePeriodRequiredSoonDescription` string without using either of the custom link strings.\nHowever, if you use one of the custom link strings (`gracePeriodRequiredSoonCustomLinkLabel` or `gracePeriodRequiredSoonCustomLinkUrl`), then both are required.\n", + "properties": { + "gracePeriodRequiredSoonCustomLinkLabel": { + "description": "The label of the custom link that's shown on the Sign-In Widget when users are prompted to enroll required authenticators before their grace period ends.", + "type": "string" + }, + "gracePeriodRequiredSoonCustomLinkUrl": { + "description": "The URL for the custom link that's shown on the Sign-In Widget when users are prompted to enroll required authenticators before their grace period ends.", + "type": "string" + }, + "gracePeriodRequiredSoonDescription": { + "description": "The description that's shown on the Sign-In Widget for users who are within an authenticator grace period. This description prompts users to enroll required authenticators before their grace period ends.", + "type": "string" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "GrantOrTokenStatus": { + "description": "Status", + "enum": [ + "ACTIVE", + "REVOKED" + ], + "example": "ACTIVE", + "readOnly": true, + "type": "string" + }, + "GrantResourcesHrefObject": { + "properties": { + "href": { + "description": "Link URI", + "example": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7/clients/0oabskvc6442nkvQO0h7/grants", + "type": "string" + } + }, + "type": "object" + }, + "GrantType": { + "description": "Determines the mechanism Okta uses to authorize the creation of the tokens.", + "enum": [ + "authorization_code", + "client_credentials", + "implicit", + "interaction_code", + "password", + "refresh_token", + "urn:ietf:params:oauth:grant-type:device_code", + "urn:ietf:params:oauth:grant-type:jwt-bearer", + "urn:ietf:params:oauth:grant-type:saml2-bearer", + "urn:ietf:params:oauth:grant-type:token-exchange", + "urn:openid:params:grant-type:ciba", + "urn:okta:params:oauth:grant-type:otp", + "urn:okta:params:oauth:grant-type:oob", + "http://auth0.com/oauth/grant-type/mfa-otp", + "http://auth0.com/oauth/grant-type/mfa-oob" + ], + "type": "string" + }, + "GrantTypePolicyRuleCondition": { + "description": "Array of grant types that this condition includes. Determines the mechanism that Okta uses to authorize the creation of the tokens.", + "properties": { + "include": { + "description": "Array of grant types that this condition includes.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Group": { + "properties": { + "_embedded": { + "description": "Embedded resources related to the group", + "properties": { + "app": { + "description": "If the group is sourced from an app, this object contains information about that app", + "properties": { + "id": { + "description": "The ID of the `AppInstance`", + "type": "string" + }, + "label": { + "description": "The user-facing display name of the `AppInstance`", + "type": "string" + }, + "name": { + "description": "The name of the `AppInstance`", + "type": "string" + }, + "signOnMode": { + "description": "The configured sign-on mode for the `AppInstance`", + "example": "SAML_1_1", + "type": "string" + } + }, + "type": "object" + }, + "stats": { + "description": "Statistics about the group", + "properties": { + "appsCount": { + "description": "Number of apps associated with the group", + "format": "int32", + "type": "integer" + }, + "groupPushMappingsCount": { + "description": "Number of group push mappings associated with the group", + "format": "int32", + "type": "integer" + }, + "hasAdminPrivlege": { + "description": "Indicates if the group has admin privileges via a group-level role assignment", + "type": "boolean" + }, + "usersCount": { + "description": "Number of users in the group", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "apps": { + "$ref": "#/components/schemas/HrefObject" + }, + "logo": { + "items": { + "$ref": "#/components/schemas/HrefObject" + }, + "type": "array" + }, + "source": { + "$ref": "#/components/schemas/HrefObject" + }, + "users": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ], + "description": "[Discoverable resources](/openapi/okta-management/management/group/listgroups#group/listgroups/t=response&c=200&path=_links/source) related to the group" + }, + "created": { + "description": "Timestamp when the group was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique ID for the group", + "example": "0gabcd1234", + "readOnly": true, + "type": "string" + }, + "lastMembershipUpdated": { + "description": "Timestamp when the groups memberships were last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the group's profile was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "objectClass": { + "description": "Determines the group's `profile`", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "profile": { + "$ref": "#/components/schemas/GroupProfile" + }, + "type": { + "$ref": "#/components/schemas/GroupType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "GroupAssignmentProfile": { + "additionalProperties": true, + "description": "Specifies the profile properties applied to [application users](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/applicationusers) that are assigned to the app through group membership. \nSome reference properties are imported from the target app and can't be configured. See [profile](https://developer.okta.com/docs/api/openapi/okta-management/management/user/getuser#user/getuser/t=response&c=200&path=profile).", + "type": "object" + }, + "GroupCondition": { + "description": "Specifies a set of groups whose users are to be included or excluded", + "properties": { + "exclude": { + "description": "Groups to be excluded", + "items": { + "type": "string" + }, + "type": "array" + }, + "include": { + "description": "Groups to be included", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GroupMembershipsRequestSchema": { + "properties": { + "memberExternalIds": { + "description": "A list of app user external IDs to be inserted in this group in Okta", + "items": { + "maxLength": 255, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GroupMembershipsResponseSchema": { + "properties": { + "memberExternalIds": { + "description": "A list of app user external IDs that are members of the group in Okta", + "items": { + "maxLength": 255, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GroupOwner": { + "properties": { + "displayName": { + "description": "The display name of the group owner", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The `id` of the group owner", + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the group owner was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "originId": { + "description": "The ID of the app instance if the `originType` is `APPLICATION`. This value is `NULL` if `originType` is `OKTA_DIRECTORY`.", + "type": "string" + }, + "originType": { + "$ref": "#/components/schemas/GroupOwnerOriginType" + }, + "resolved": { + "description": "If `originType`is APPLICATION, this parameter is set to `FALSE` until the owner's `originId` is reconciled with an associated Okta ID.", + "type": "boolean" + }, + "type": { + "$ref": "#/components/schemas/GroupOwnerType" + } + }, + "type": "object" + }, + "GroupOwnerOriginType": { + "description": "The source where group ownership is managed", + "enum": [ + "APPLICATION", + "OKTA_DIRECTORY" + ], + "type": "string" + }, + "GroupOwnerType": { + "description": "The entity type of the owner", + "enum": [ + "GROUP", + "USER" + ], + "type": "string" + }, + "GroupPolicyRuleCondition": { + "description": "Specifies a set of groups whose users are to be included or excluded", + "properties": { + "exclude": { + "description": "Groups to be excluded", + "items": { + "type": "string" + }, + "type": "array" + }, + "include": { + "description": "Groups to be included", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GroupProfile": { + "anyOf": [ + { + "$ref": "#/components/schemas/OktaUserGroupProfile" + }, + { + "$ref": "#/components/schemas/OktaActiveDirectoryGroupProfile" + } + ] + }, + "GroupProfileResult": { + "properties": { + "id": { + "description": "The ID of the group", + "example": "00g19oiNHkbKFvNTX0g4", + "type": "string" + }, + "profile": { + "additionalProperties": true, + "description": "Map of requested attributes and their values", + "example": { + "cn": "CN=Finance", + "description": "Finance Department Group", + "distinguishedName": "CN=Finance,OU=Groups,DC=example,DC=com", + "whenCreated": "20230101000000.0Z" + }, + "type": "object" + } + }, + "type": "object" + }, + "GroupPushMapping": { + "properties": { + "_links": { + "$ref": "#/components/schemas/GroupPushMappingLinks" + }, + "appConfig": { + "$ref": "#/components/schemas/AppConfig", + "readOnly": true, + "type": "object" + }, + "created": { + "description": "Timestamp when the group push mapping was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errorSummary": { + "description": "The error message summary if the latest push failed", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the group push mapping", + "readOnly": true, + "type": "string" + }, + "lastPush": { + "description": "Timestamp when the group push mapping was pushed", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the group push mapping was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "sourceGroupId": { + "description": "The ID of the source group for the group push mapping", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/GroupPushMappingStatus", + "description": "The status of the group push mapping", + "readOnly": true, + "type": "string" + }, + "targetGroupId": { + "description": "The ID of the target group for the group push mapping", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GroupPushMappingLinks": { + "description": "Discoverable resources related to the group push mapping", + "properties": { + "app": { + "$ref": "#/components/schemas/HrefObjectAppLink" + }, + "sourceGroup": { + "$ref": "#/components/schemas/HrefObjectGroupLink" + }, + "targetGroup": { + "$ref": "#/components/schemas/HrefObjectGroupLink" + } + }, + "type": "object" + }, + "GroupPushMappingStatus": { + "description": "The status of the group push mapping", + "enum": [ + "ACTIVE", + "ERROR", + "INACTIVE" + ], + "type": "string", + "x-enumDescriptions": { + "ACTIVE": "The group push mapping is active and Okta pushes membership changes to the target group", + "ERROR": "The group push mapping is in an error state and Okta doesn't push membership changes to the target group", + "INACTIVE": "The group push mapping is inactive and Okta doesn't push membership changes to the target group" + } + }, + "GroupPushMappingStatusUpsert": { + "default": "ACTIVE", + "description": "The status of the group push mapping", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "title": "GroupPushMappingStatus", + "type": "string" + }, + "GroupQueryRequest": { + "properties": { + "attributes": { + "description": "An array of LDAP group attribute names to retrieve. Restricted attributes: member, memberOf, *", + "example": [ + "distinguishedName", + "description", + "cn", + "whenCreated" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "attributes" + ], + "type": "object" + }, + "GroupQueryResponse": { + "properties": { + "resultId": { + "description": "Identifier used to poll for the query result", + "example": "rdj4edr7pSDGv8QF10g4", + "type": "string" + } + }, + "type": "object" + }, + "GroupRule": { + "properties": { + "_embedded": { + "description": "This object appears with embedded resources related to the group rule if you use the `expand` query parameter", + "properties": { + "groupIdToGroupNameMap": { + "additionalProperties": { + "type": "string" + }, + "description": "A mapping of group IDs to group names", + "readOnly": true, + "type": "object" + } + }, + "readOnly": true, + "type": "object" + }, + "actions": { + "$ref": "#/components/schemas/GroupRuleAction" + }, + "conditions": { + "$ref": "#/components/schemas/GroupRuleConditions" + }, + "created": { + "description": "Creation date for group rule", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "ID of the group rule", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Date group rule was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the group rule", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/GroupRuleStatus" + }, + "type": { + "description": "Type to indicate a group rule operation. Only `group_rule` is allowed.", + "type": "string" + } + }, + "type": "object" + }, + "GroupRuleAction": { + "description": "Defines which users and groups to assign", + "properties": { + "assignUserToGroups": { + "$ref": "#/components/schemas/GroupRuleGroupAssignment" + } + }, + "type": "object" + }, + "GroupRuleConditions": { + "description": "Defines group rule conditions", + "properties": { + "expression": { + "$ref": "#/components/schemas/GroupRuleExpression" + }, + "people": { + "$ref": "#/components/schemas/GroupRulePeopleCondition" + } + }, + "type": "object" + }, + "GroupRuleExpression": { + "description": "Defines Okta specific [group-rules expression](https://developer.okta.com/docs/reference/okta-expression-language/#expressions-in-group-rules)", + "properties": { + "type": { + "description": "Expression type. Only valid value is '`urn:okta:expression:1.0`'.", + "type": "string" + }, + "value": { + "description": "Okta expression that would result in a Boolean value", + "example": "user.role==\\\"Engineer\\\"", + "type": "string" + } + }, + "type": "object" + }, + "GroupRuleGroupAssignment": { + "description": "Contains the `groupIds` array", + "properties": { + "groupIds": { + "description": "Array of `groupIds` to which users are added", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GroupRuleGroupCondition": { + "description": "Currently not supported", + "properties": { + "exclude": { + "description": "Currently not supported", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GroupRulePeopleCondition": { + "description": "Defines conditions for `people` in a group rule", + "properties": { + "groups": { + "$ref": "#/components/schemas/GroupRuleGroupCondition" + }, + "users": { + "$ref": "#/components/schemas/GroupRuleUserCondition" + } + }, + "type": "object" + }, + "GroupRuleStatus": { + "description": "Status of group rule. You can't update the status of a rule from `INACTIVE` to `ACTIVE`. You must use the activate and deactivate lifecycle operations.", + "enum": [ + "ACTIVE", + "INACTIVE", + "INVALID" + ], + "type": "string" + }, + "GroupRuleUserCondition": { + "description": "Defines conditions specific to user exclusion", + "properties": { + "exclude": { + "description": "Excluded `userIds` when processing rules", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GroupSchema": { + "properties": { + "$schema": { + "description": "JSON schema version identifier", + "readOnly": true, + "type": "string" + }, + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "created": { + "description": "Timestamp when the schema was created", + "readOnly": true, + "type": "string" + }, + "definitions": { + "$ref": "#/components/schemas/GroupSchemaDefinitions" + }, + "description": { + "description": "Description for the schema", + "type": "string" + }, + "id": { + "description": "URI of group schema", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the schema was last updated", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the schema", + "readOnly": true, + "type": "string" + }, + "properties": { + "$ref": "#/components/schemas/UserSchemaProperties", + "description": "Group object properties" + }, + "title": { + "description": "User-defined display name for the schema", + "type": "string" + }, + "type": { + "description": "Type of [root schema](https://tools.ietf.org/html/draft-zyp-json-schema-04#section-3.4)", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-allow-null-property-value-for-updates": true + }, + "GroupSchemaAttribute": { + "properties": { + "description": { + "description": "Description of the property", + "type": "string" + }, + "enum": { + "description": "Enumerated value of the property.\n\nThe value of the property is limited to one of the values specified in the enum definition. The list of values for the enum must consist of unique elements.", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, + "nullable": true, + "type": "array" + }, + "externalName": { + "description": "Name of the property as it exists in an external application", + "type": "string" + }, + "externalNamespace": { + "description": "Namespace from the external application", + "type": "string" + }, + "format": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttributeFormat" + } + ], + "description": "Identifies the type of data represented by the string" + }, + "items": { + "$ref": "#/components/schemas/UserSchemaAttributeItems", + "nullable": true + }, + "master": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttributeMaster" + } + ], + "description": "Identifies where the property is mastered" + }, + "maxLength": { + "description": "Maximum character length of a string property", + "nullable": true, + "type": "integer" + }, + "minLength": { + "description": "Minimum character length of a string property", + "nullable": true, + "type": "integer" + }, + "mutability": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttributeMutabilityString" + } + ], + "description": "Defines the mutability of the property" + }, + "oneOf": { + "description": "Non-empty array of valid JSON schemas.\n\nThe `oneOf` key is only supported in conjunction with `enum` and provides a mechanism to return a display name for the `enum` value.<br>\nEach schema has the following format:\n\n```\n{\n \"const\": \"enumValue\",\n \"title\": \"display name\"\n}\n```\n\nWhen `enum` is used in conjunction with `oneOf`, you must keep the set of enumerated values and their order.<br>\nFor example:\n\n```\n\"enum\": [\"S\",\"M\",\"L\",\"XL\"],\n\"oneOf\": [\n {\"const\": \"S\", \"title\": \"Small\"},\n {\"const\": \"M\", \"title\": \"Medium\"},\n {\"const\": \"L\", \"title\": \"Large\"},\n {\"const\": \"XL\", \"title\": \"Extra Large\"}\n ]\n```", + "items": { + "$ref": "#/components/schemas/UserSchemaAttributeEnum" + }, + "nullable": true, + "type": "array" + }, + "permissions": { + "description": "Access control permissions for the property", + "items": { + "$ref": "#/components/schemas/UserSchemaAttributePermission" + }, + "nullable": true, + "type": "array" + }, + "required": { + "description": "Determines whether the property is required", + "nullable": true, + "type": "boolean" + }, + "scope": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttributeScope" + } + ], + "description": "Determines whether a group attribute can be set at the individual or group level" + }, + "title": { + "description": "User-defined display name for the property", + "minLength": 1, + "type": "string" + }, + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttributeType" + } + ], + "description": "Type of property" + }, + "unique": { + "description": "Determines whether property values must be unique", + "nullable": true, + "type": "boolean" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "GroupSchemaBase": { + "properties": { + "id": { + "description": "The subschema name", + "readOnly": true, + "type": "string" + }, + "properties": { + "allOf": [ + { + "$ref": "#/components/schemas/GroupSchemaBaseProperties" + } + ], + "description": "The `#base` object properties" + }, + "required": { + "description": "A collection indicating required property names", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "type": { + "description": "The object type", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "GroupSchemaBaseProperties": { + "description": "All Okta-defined profile properties are defined in a profile subschema with the resolution scope `#base`. These properties can't be removed or edited, regardless of any attempt to do so.", + "properties": { + "description": { + "allOf": [ + { + "$ref": "#/components/schemas/GroupSchemaAttribute" + } + ], + "description": "Human readable description of the group" + }, + "name": { + "allOf": [ + { + "$ref": "#/components/schemas/GroupSchemaAttribute" + } + ], + "description": "Unique identifier for the group" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "GroupSchemaCustom": { + "description": "All custom profile properties are defined in a profile subschema with the resolution scope `#custom`", + "properties": { + "id": { + "description": "The subschema name", + "readOnly": true, + "type": "string" + }, + "properties": { + "additionalProperties": { + "$ref": "#/components/schemas/GroupSchemaAttribute" + }, + "description": "The `#custom` object properties", + "type": "object" + }, + "required": { + "description": "A collection indicating required property names", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "type": { + "description": "The object type", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GroupSchemaDefinitions": { + "properties": { + "base": { + "$ref": "#/components/schemas/GroupSchemaBase" + }, + "custom": { + "$ref": "#/components/schemas/GroupSchemaCustom" + } + }, + "type": "object" + }, + "GroupType": { + "description": "Determines how a group's profile and memberships are managed", + "enum": [ + "APP_GROUP", + "BUILT_IN", + "OKTA_GROUP" + ], + "type": "string", + "x-enumDescriptions": { + "APP_GROUP": "Group profile and memberships are imported and must be managed within the app (such as Active Directory or LDAP) that imported the group", + "BUILT_IN": "Group profile and memberships are managed by Okta and can't be modified", + "OKTA_GROUP": "Group profile and memberships are directly managed in Okta via static assignments or indirectly through group rules" + } + }, + "GroupsLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the [Application Groups](/openapi/okta-management/management/tags/applicationgroups/other/listapplicationgroupassignments) resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "GroupsRequestSchema": { + "properties": { + "externalId": { + "description": "The external ID of the identity source group to be created", + "maxLength": 255, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/IdentitySourceGroupProfileForUpsert" + } + }, + "type": "object" + }, + "GroupsResponseSchema": { + "properties": { + "externalId": { + "description": "The external ID of the identity source group", + "maxLength": 255, + "type": "string" + }, + "id": { + "description": "The Okta group ID of the identity source group", + "readOnly": true, + "type": "string" + }, + "profile": { + "description": "The profile information of the group", + "properties": { + "profile": { + "$ref": "#/components/schemas/IdentitySourceGroupProfileForUpsert" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "HelpLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the app help resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HookKey": { + "description": "The `id` property in the response as `id` serves as the unique ID for the key, which you can specify when invoking other CRUD operations. \n\nThe `keyId` provided in the response is the alias of the public key that you can use to get details of the public key data in a separate call.", + "properties": { + "created": { + "description": "Timestamp when the key was created", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The unique identifier for the key", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "isUsed": { + "description": "Whether this key is currently in use by other applications", + "format": "boolean", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "keyId": { + "description": "The alias of the public key", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the key was updated", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Display name of the key", + "maxLength": 255, + "minLength": 1, + "nullable": false, + "readOnly": false, + "type": "string" + } + }, + "title": "HookKeyInstance", + "type": "object" + }, + "HostedPage": { + "properties": { + "type": { + "$ref": "#/components/schemas/HostedPageType" + }, + "url": { + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "HostedPageType": { + "enum": [ + "EXTERNALLY_HOSTED", + "OKTA_DEFAULT" + ], + "type": "string" + }, + "HrefCsrPublishLink": { + "description": "Link to publish CSR", + "properties": { + "hints": { + "$ref": "#/components/schemas/CsrPublishHrefHints" + }, + "href": { + "description": "Link URI", + "example": "https://{yourOktaDomain}/api/v1/apps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50/lifecycle/publish", + "type": "string" + } + }, + "readOnly": true, + "required": [ + "href" + ], + "title": "Link Object", + "type": "object" + }, + "HrefCsrSelfLink": { + "description": "Link to the resource (self)", + "properties": { + "hints": { + "$ref": "#/components/schemas/CsrSelfHrefHints" + }, + "href": { + "description": "Link URI", + "example": "https://{yourOktaDomain}/api/v1/apps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50", + "type": "string" + } + }, + "readOnly": true, + "required": [ + "href" + ], + "title": "Link Object", + "type": "object" + }, + "HrefHints": { + "description": "Describes allowed HTTP verbs for the `href`", + "properties": { + "allow": { + "items": { + "$ref": "#/components/schemas/HttpMethod" + }, + "type": "array" + } + }, + "type": "object" + }, + "HrefHintsGuidanceObject": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefHints" + }, + { + "description": "Describes allowed HTTP verbs and guidance for the `href`" + }, + { + "properties": { + "guidance": { + "description": "Specifies the URI to invoke for granting scope consent required to complete the OAuth 2.0 connection\n", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObject": { + "additionalProperties": true, + "properties": { + "hints": { + "$ref": "#/components/schemas/HrefHints", + "readOnly": true + }, + "href": { + "description": "Link URI", + "type": "string" + }, + "name": { + "description": "Link name", + "readOnly": true, + "type": "string" + }, + "templated": { + "description": "Indicates whether the link object's `href` property is a URI template.", + "readOnly": true, + "type": "boolean" + }, + "type": { + "description": "The media type of the link. If omitted, it is implicitly `application/json`.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "href" + ], + "title": "Link Object", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectActivateLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to activate the resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectAppLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the app resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectAssigneeLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the assignee resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectAuthorizeLink": { + "description": "Link to authorize scopes", + "properties": { + "hints": { + "$ref": "#/components/schemas/HrefHintsGuidanceObject" + }, + "href": { + "description": "Link URI", + "type": "string" + } + }, + "readOnly": true, + "required": [ + "href" + ], + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "HrefObjectBindingLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the binding resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectBindingsLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the bindings resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectClientLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the client resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectDeactivateLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to deactivate the resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectDeleteLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to delete the resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectGovernanceResourcesLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the resources" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectGrantAerialConsent": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to grant Okta Aerial access to your Org" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectGroupLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the group resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectLogoLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the logo resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectMappingsLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the mappings resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectMemberLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the member resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectMembersLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the members resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectNextLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the next resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectPermissionsLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the permissions resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectResourceSetLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the resource set resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectResourceSetResourcesLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to resource set resources" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectRetrieveAerialConsent": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to retrieve Okta Aerial consent for your Org" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectRevokeAerialConsent": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to revoke Okta Aerial consent for your Org" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectRoleLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the role resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectRulesLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the rules resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectSelfLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the resource (self)" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectSuspendLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to suspend the resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectUnsuspendLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to unsuspend the resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectUserLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the user resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HrefObjectWebLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the resource in the Okta Admin Console" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "HttpMethod": { + "enum": [ + "DELETE", + "GET", + "POST", + "PUT" + ], + "type": "string" + }, + "IAMBundleEntitlement": { + "description": "An entitlement in a governance bundle", + "properties": { + "resourceSets": { + "description": "List of resource set IDs for the custom role", + "items": { + "description": "Resource set ID", + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "The role", + "type": "string" + }, + "targets": { + "description": "List of target resource IDs to scope the entitlement with the role", + "items": { + "description": "Target resource (app or group ID)", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "IDVAuthorizationEndpoint": { + "description": "IDV authorization endpoint", + "properties": { + "binding": { + "enum": [ + "HTTP-REDIRECT" + ], + "type": "string" + }, + "url": { + "description": "URL of the `authorization` endpoint of the IDV vendor", + "type": "string" + } + }, + "type": "object" + }, + "IDVCredentials": { + "description": "Credentials for verifying requests to the IDV vendor", + "properties": { + "bearer": { + "description": "Client credential for `IDV_PERSONA` IdP type", + "properties": { + "apiKey": { + "description": "The API key that you generate in your Persona dashboard", + "type": "string" + } + }, + "required": [ + "apiKey" + ], + "type": "object" + }, + "client": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Client credentials for `IDV_CLEAR` and `IDV_INCODE` IdP types", + "properties": { + "client_id": { + "description": "The client ID that you generate in your IDV vendor", + "type": "string" + }, + "client_secret": { + "description": "The client secret that you generate in your IDV vendor", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ], + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "type": "object" + }, + "IDVEndpoints": { + "description": "Contains endpoints for the IDV vendor. When you create an `IDV_STANDARD` IdP, you must include the `par`, `authorization`, `token`, and `jwks` endpoints in the request body.", + "properties": { + "authorization": { + "$ref": "#/components/schemas/IDVAuthorizationEndpoint" + }, + "jwks": { + "$ref": "#/components/schemas/OidcJwksEndpoint" + }, + "par": { + "$ref": "#/components/schemas/IDVParEndpoint" + }, + "token": { + "$ref": "#/components/schemas/IDVTokenEndpoint" + } + }, + "required": [ + "par", + "authorization", + "token", + "jwks" + ], + "type": "object" + }, + "IDVParEndpoint": { + "description": "IDV [PAR](https://datatracker.ietf.org/doc/html/rfc9126) endpoint", + "properties": { + "binding": { + "enum": [ + "HTTP-POST" + ], + "type": "string" + }, + "url": { + "description": "URL of the `par` endpoint of the IDV vendor", + "type": "string" + } + }, + "type": "object" + }, + "IDVTokenEndpoint": { + "description": "Token endpoint of the IDV vendor", + "properties": { + "binding": { + "enum": [ + "HTTP-POST" + ], + "type": "string" + }, + "url": { + "description": "URL of the `token` endpoint of the IDV vendor", + "type": "string" + } + }, + "type": "object" + }, + "IPNetworkZone": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkZone" + }, + { + "title": "IP Network Zone" + }, + { + "properties": { + "gateways": { + "description": "The IP addresses (range or CIDR form) for an IP Network Zone.\nThe maximum array length is 150 entries for admin-created IP zones, 1000 entries for IP blocklist zones, and 5000 entries for the default system IP Zone.", + "items": { + "$ref": "#/components/schemas/NetworkZoneAddress" + }, + "type": "array" + }, + "proxies": { + "description": "The IP addresses (range or CIDR form) that are allowed to forward a request from gateway addresses for an IP Network Zone.\nThese proxies are automatically trusted by Threat Insights and used to identify the client IP of a request.\nThe maximum array length is 150 entries for admin-created zones and 5000 entries for the default system IP Zone.", + "items": { + "$ref": "#/components/schemas/NetworkZoneAddress" + }, + "nullable": true, + "type": "array" + }, + "useAsExemptList": { + "description": "You can **only** use this parameter when making a request to the Replace the network zone endpoint (`/api/v1/zones/{zoneId}`).\nSet this parameter to `true` in your request when you update the `DefaultExemptIpZone` to allow IPs through the blocklist.", + "type": "boolean" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "IPServiceCategory": { + "description": "An IP service offered by a provider, such as a proxy or VPN", + "enum": [ + "ABCPROXY_PROXY", + "ALL_ANONYMIZERS", + "ALL_ANONYMIZERS_EXCEPT_TOR", + "ALL_IP_SERVICES", + "ALL_PROXIES_VPNS", + "ANONYMIZER_TOR", + "APPLE_ICLOUD_RELAY_PROXY", + "ASTRILL_VPN", + "AVAST_VPN", + "BIGMAMA_PROXY", + "CYBERGHOST_VPN", + "DATAIMPULSE_PROXY", + "EXPRESS_VPN", + "FACELESS_PROXY", + "FROXY_PROXY", + "GEONODE_PROXY", + "GLOBALPROTECT_VPN", + "GOOGLE_VPN", + "IPCOLA_PROXY", + "IPIDEA_PROXY", + "IPROXYSHOP_PROXY", + "LUMINATI_PROXY", + "MULLVAD_VPN", + "NETNUT_PROXY", + "NEXUS_PROXY", + "NORD_VPN", + "OCULUS_PROXY", + "OXYLABS_PROXY", + "PIA_VPN", + "PROXYRACK_PROXY", + "SAMSUNG_VPN", + "SPACEPROXIES_PROXY", + "SURFSHARK_VPN", + "SYMANTEC_VPN", + "TRENDMICRO_VPN", + "ULTRASURF_VPN", + "WARP_VPN", + "YILU_PROXY" + ], + "type": "string" + }, + "IamRole": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "permissions": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + }, + "created": { + "description": "Timestamp when the role was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of the role", + "type": "string" + }, + "id": { + "description": "Unique key for the role", + "readOnly": true, + "type": "string" + }, + "label": { + "description": "Unique label for the role", + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the role was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "label", + "description" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "IamRoles": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksNext" + }, + "roles": { + "items": { + "$ref": "#/components/schemas/IamRole" + }, + "type": "array" + } + }, + "type": "object" + }, + "IdPCertificateCredential": { + "properties": { + "x5c": { + "$ref": "#/components/schemas/X5c" + } + }, + "required": [ + "x5c" + ], + "type": "object" + }, + "IdPCsr": { + "description": "Defines a CSR for a signature or decryption credential for an IdP", + "properties": { + "_links": { + "additionalProperties": true, + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "publish": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "Publish the CSR" + } + } + } + ], + "type": "object" + }, + "created": { + "$ref": "#/components/schemas/Created" + }, + "csr": { + "description": "Base64-encoded CSR in DER format", + "example": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9/tKvvbFN59T4raoCs/78KRm4fSefHQOv1TKLXo4wTLbsqYWRWc5u0sd5orUMQgPQOyj3i6qh13mALY4BzrT057EG1BUNjGg29QgYlnOk2iX890e5BIDMQQEIKFrvOi2V8cLUkLvE2ydRn0VO1Q1frbUkYeStJYC5Api2JQsYRwa+1ZeDH1ITnIzUaugWhW2WB2lSnwZkenne5KtffxMPYVu+IhNRHoKaRA6Z51YNhMJIx17JM2hs/H4Ka3drk6kzDf7ofk/yBpb9yBWyU7CTSQhdoHidxqFprMDaT66W928t3AeOENHBuwn8c2K9WeGG+bELNyQRJVmawIDAQABoCowKAYJKoZIhvcNAQkOMRswGTAXBgNVHREEEDAOggxkZXYub2t0YS5jb20wDQYJKoZIhvcNAQELBQADggEBAA2hsVJRVM+A83X9MekjTnIbt19UNT8wX7wlE9jUKirWsxceLiZBpVGn9qfKhhVIpvdaIRSeoFYS2Kg/m1G6bCvjmZLcrQ5FcEBjZH2NKfNppGVnfC2ugtUkBtCB+UUzOhKhRKJtGugenKbP33zRWWIqnd2waF6Cy8TIuqQVPbwEDN9bCbAs7ND6CFYNguY7KYjWzQOeAR716eqpEEXuPYAS4nx/ty4ylonR8cv+gpq51rvq80A4k/36aoeM0Y6I4w64vhTfuvWW2UYFUD+/+y2FA2CSP4JfctySrf1s525v6fzTFZ3qZbB5OZQtP2b8xYWktMzywsxGKDoVDB4wkH4=", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the CSR", + "example": "h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50", + "readOnly": true, + "type": "string" + }, + "kty": { + "description": "Cryptographic algorithm family for the CSR's keypair", + "example": "RSA", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "IdPCsrPkcs10": { + "description": "Base64URL-encoded CSR in DER format", + "format": "base64", + "type": "string" + }, + "IdPKeyCredential": { + "additionalProperties": true, + "description": "A [JSON Web Key](https://tools.ietf.org/html/rfc7517) for a signature or encryption credential for an IdP", + "properties": { + "created": { + "$ref": "#/components/schemas/Created" + }, + "e": { + "description": "The exponent value for the RSA public key", + "example": "AQAB", + "type": "string" + }, + "expiresAt": { + "$ref": "#/components/schemas/ExpiresAt" + }, + "kid": { + "description": "Unique identifier for the key", + "example": "your-key-id", + "type": "string" + }, + "kty": { + "description": "Identifies the cryptographic algorithm family used with the key", + "example": "RSA", + "type": "string" + }, + "lastUpdated": { + "$ref": "#/components/schemas/LastUpdated" + }, + "n": { + "description": "The modulus value for the RSA public key", + "example": "101438407598598116085679865987760095721749307901605456708912786847324207000576780508113360584555007890315805735307890113536927352312915634368993759211767770602174860126854831344273970871509573365292777620005537635317282520456901584213746937262823585533063042033441296629204165064680610660631365266976782082747", + "type": "string" + }, + "use": { + "description": "Intended use of the public key", + "example": "sig", + "type": "string" + }, + "x5c": { + "$ref": "#/components/schemas/X5c" + }, + "x5t#S256": { + "description": "Base64url-encoded SHA-256 thumbprint of the DER encoding of an X.509 certificate", + "example": "wzPVobIrveR1x-PCbjsFGNV-6zn7Rm9KuOWOG4Rk6jE", + "type": "string" + } + }, + "type": "object" + }, + "IdProofingMethod": { + "allOf": [ + { + "$ref": "#/components/schemas/VerificationMethod" + }, + { + "properties": { + "id": { + "description": "ID for ID proofing entity", + "type": "string" + } + }, + "type": "object" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "IdTokenKeyEncryptionAlgorithm": { + "description": "JWE alg algorithm for encrypting the ID token issued to this client. If this is requested, the response is signed, and then encrypted with the result being a nested JWT. The default, if omitted, is that no encryption is performed. See the [Application Public Keys API](/openapi/okta-management/management/applicationssopublickeys/) for more information on encryption keys. See [Key management](https://developer.okta.com/docs/guides/key-management/main/) for more information on how encryption keys are used.", + "enum": [ + "RSA-OAEP-256", + "RSA-OAEP-384", + "RSA-OAEP-512" + ], + "type": "string", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "IdentityClaimSourcingPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "conditions": { + "default": null, + "description": "Policy conditions aren't supported for this policy type.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "IdentityClaimSourcingPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "$ref": "#/components/schemas/IdentityClaimSourcingPolicyRuleAction" + }, + "conditions": { + "default": null, + "description": "Policy rule conditions aren't supported for this policy type.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "IdentityClaimSourcingPolicyRuleAction": { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Specifies actions to be taken, or operations that may be allowed, if the rule conditions are satisfied", + "properties": { + "claimSourcing": { + "description": "Specifies the settings for the identity claims sourcing policy rule", + "properties": { + "redirectType": { + "description": "The redirect method that's used to select an IdP for claims sourcing during re-authentication. `IDP_DISCOVERY` is the only supported value and routes through the org's IdP discovery policy.", + "enum": [ + "IDP_DISCOVERY" + ], + "type": "string" + }, + "refresh": { + "description": "Specifies how identity claims are refreshed from the IdP when re-authentication occurs", + "properties": { + "filter": { + "description": "Filter which IdPs are available to use for re-authentication", + "properties": { + "include": { + "description": "List of IdPs that can be used for re-authentication", + "items": { + "properties": { + "id": { + "description": "The IdP ID", + "type": "string" + }, + "name": { + "description": "The IdP name", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "redirectType": { + "description": "The redirect type for re-authentication. You can set it to `NONE` (re-authentication to the IdP isn't allowed) or `FIXED` (users re-authenticate with the most recently active SSO IdP).", + "enum": [ + "NONE", + "FIXED" + ], + "type": "string" + } + }, + "required": [ + "redirectType" + ], + "type": "object" + } + }, + "required": [ + "redirectType" + ], + "type": "object" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "IdentityProvider": { + "properties": { + "_links": { + "additionalProperties": true, + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "acs": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "SAML 2.0 Assertion Consumer Service URL for the Okta SP" + }, + "activate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "Activate IdP" + }, + "authorize": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "OAuth 2.0 authorization endpoint for the IdP OAuth 2.0 Authorization Code flow" + }, + "clientRedirectUri": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "Redirect URI for the OAuth 2.0 Authorization Code flow" + }, + "deactivate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "Deactivate IdP" + }, + "keys": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "IdP keys" + }, + "metadata": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "Federation metadata document for the IdP (for example: SAML 2.0 Metadata)" + }, + "users": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "IdP users" + } + } + } + ], + "type": "object" + }, + "created": { + "$ref": "#/components/schemas/Created" + }, + "id": { + "description": "Unique key for the IdP", + "example": "0oaWma58liwx40w6boYD", + "readOnly": true, + "type": "string" + }, + "issuerMode": { + "$ref": "#/components/schemas/IdentityProviderIssuerMode" + }, + "lastUpdated": { + "$ref": "#/components/schemas/LastUpdated" + }, + "name": { + "description": "Unique name for the IdP", + "example": "Sample IdP", + "maxLength": 100, + "type": "string" + }, + "policy": { + "$ref": "#/components/schemas/IdentityProviderPolicy" + }, + "properties": { + "$ref": "#/components/schemas/IdentityProviderProperties" + }, + "protocol": { + "description": "IdP-specific protocol settings for endpoints, bindings, and algorithms used to connect with the IdP and validate messages", + "discriminator": { + "mapping": { + "ID_PROOFING": "#/components/schemas/ProtocolIdVerification", + "MTLS": "#/components/schemas/ProtocolMtls", + "OAUTH2": "#/components/schemas/ProtocolOAuth", + "OIDC": "#/components/schemas/ProtocolOidc", + "SAML2": "#/components/schemas/ProtocolSaml" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/ProtocolSaml" + }, + { + "$ref": "#/components/schemas/ProtocolOAuth" + }, + { + "$ref": "#/components/schemas/ProtocolOidc" + }, + { + "$ref": "#/components/schemas/ProtocolMtls" + }, + { + "$ref": "#/components/schemas/ProtocolIdVerification" + } + ] + }, + "status": { + "$ref": "#/components/schemas/LifecycleStatus" + }, + "type": { + "$ref": "#/components/schemas/IdentityProviderType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "IdentityProviderApplicationUser": { + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "Embedded resources related to the IdP user", + "readOnly": true, + "type": "object" + }, + "_links": { + "additionalProperties": true, + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "$ref": "#/components/schemas/LinksNext" + }, + { + "properties": { + "idp": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "The IdP instance", + "example": { + "href": "https://{yourOktaDomain}/api/v1/idps/0oa1k5d68qR2954hb0g4" + } + }, + "user": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "The linked Okta user", + "example": { + "href": "https://{yourOktaDomain}/api/v1/users/00ulwodIu7wCfdiVR0g3" + } + } + } + } + ], + "type": "object" + }, + "created": { + "$ref": "#/components/schemas/Created" + }, + "externalId": { + "description": "Unique IdP-specific identifier for the user", + "example": "saml.jackson@example.com", + "maxLength": 512, + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique key of the user", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "$ref": "#/components/schemas/LastUpdated" + }, + "profile": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "IdP-specific profile for the user. \n\nIdP user profiles are IdP-specific but may be customized by the Profile Editor in the Admin Console.\n\n> **Note:** Okta variable names have reserved characters that may conflict with the name of an IdP assertion attribute. You can use the **External name** to define the attribute name as defined in an IdP assertion such as a SAML attribute name.", + "example": { + "authnContextClassRef": null, + "displayName": "Saml Jackson", + "email": "saml.jackson@example.com", + "firstName": "Saml", + "lastName": "Jackson", + "mobilePhone": "+1-415-555-5141", + "subjectConfirmationAddress": null, + "subjectConfirmationMethod": null, + "subjectNameFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "subjectNameId": "saml.jackson@example.com", + "subjectNameQualifier": "example.com", + "subjectSpNameQualifier": "urn:federation:example", + "subjectSpProvidedId": null + }, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "IdentityProviderIssuerMode": { + "default": "DYNAMIC", + "description": "Indicates whether Okta uses the original Okta org domain URL or a custom domain URL in the request to the social IdP", + "enum": [ + "CUSTOM_URL", + "DYNAMIC", + "ORG_URL" + ], + "type": "string", + "x-enumDescriptions": { + "CUSTOM_URL": "In the authorize request to the social IdP, Okta uses the custom domain URL as the domain in the `redirect_uri`. You can set `issuerMode` to `CUSTOM_URL` only if you have a custom URL domain configured.", + "DYNAMIC": "In the authorize request to the social IdP, Okta uses the custom domain URL as the domain in the `redirect_uri` if the request was made from the custom domain URL. Otherwise, Okta uses the Okta org's original domain URL if the request was made from the Okta org domain.", + "ORG_URL": "In the authorize request to the social IdP, Okta uses the Okta org's original domain URL (`https://${yourOktaDomain}`) as the domain in the `redirect_uri`." + } + }, + "IdentityProviderPolicy": { + "allOf": [ + { + "properties": { + "accountLink": { + "$ref": "#/components/schemas/PolicyAccountLink" + }, + "maxClockSkew": { + "description": "Maximum allowable clock skew when processing messages from the IdP", + "example": 120000, + "type": "integer" + }, + "provisioning": { + "$ref": "#/components/schemas/Provisioning" + }, + "subject": { + "$ref": "#/components/schemas/PolicySubject" + }, + "trustClaims": { + "default": false, + "description": "Indicates whether to trust authentication claims from the IdP", + "type": "boolean" + } + }, + "type": "object" + } + ], + "description": "Policy settings for the IdP.\nThe following provisioning and account linking actions are supported by each IdP provider:\n| IdP type | User provisioning actions | Group provisioning actions | Account link actions | Account link filters |\n| ----------------------------------------------------------------- | ------------------------- | ------------------------------------- | -------------------- | -------------------- |\n| `SAML2` | `AUTO` or `DISABLED` | `NONE`, `ASSIGN`, `APPEND`, or `SYNC` | `AUTO`, `DISABLED` | `groups`, `users` |\n| `X509`, `IDV_PERSONA`, `IDV_INCODE`, `IDV_CLEAR` and `IDV_STANDARD`| `DISABLED` | No support for JIT provisioning | | |\n| All other IdP types | `AUTO`, `DISABLED` | `NONE` or `ASSIGN` | `AUTO`, `DISABLED` | `groups`, `users` |", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "IdentityProviderPolicyProvider": { + "enum": [ + "ANY", + "OKTA", + "SPECIFIC_IDP" + ], + "type": "string" + }, + "IdentityProviderPolicyRuleCondition": { + "description": "Specifies the IdP that's used to sign in", + "properties": { + "idpIds": { + "description": "Specifies the IdP ID", + "items": { + "type": "string" + }, + "type": "array" + }, + "provider": { + "$ref": "#/components/schemas/IdentityProviderPolicyProvider" + } + }, + "type": "object" + }, + "IdentityProviderProperties": { + "description": "The properties in the IdP `properties` object vary depending on the IdP type", + "nullable": true, + "properties": { + "aalValue": { + "description": "The [authentication assurance level](https://developers.login.gov/oidc/#aal-values) (AAL) value for the Login.gov IdP.\nSee [Add a Login.gov IdP](https://developer.okta.com/docs/guides/add-logingov-idp/). Applies to `LOGINGOV` and `LOGINGOV_SANDBOX` IdP types.", + "nullable": true, + "type": "string" + }, + "additionalAmr": { + "description": "The additional Assurance Methods References (AMR) values for Smart Card IdPs. Applies to `X509` IdP type.", + "items": { + "enum": [ + "sc", + "hwk", + "pin", + "mfa" + ], + "type": "string", + "x-enumDescriptions": { + "hwk": "Hardware-secured key", + "mfa": "Multifactor authentication", + "pin": "Personal identification number", + "sc": "Smart card" + } + }, + "nullable": true, + "type": "array" + }, + "allowDynamicUserMatching": { + "default": false, + "description": "Enables authenticated users to enroll a Smart Card if the users can't be identified using the configured `matchAttribute`. Applies to `X509` IdP type.\n\n> **Note:** Enrollment requires a PIN if the Smart Card is PIN-protected. And enrollment is also blocked if the X.509 certificate contains restricted attributes (`login`, `email`, `secondEmail`, and configured attributes that are used in multiple identifiers).", + "type": "boolean" + }, + "allowUserUpdates": { + "default": false, + "description": "Enables attribute synchronization from the X.509 certificate to the user's Okta profile. If it's set to `true`, Okta overwrites user profile attributes with values found in the X.509 certificate. Applies to `X509` IdP type.\n\n> **Note:** Some attributes are restricted and won't be updated, including `login`, `email`, `secondEmail`, and configured attributes that are used in multiple identifiers. ", + "type": "boolean" + }, + "ialValue": { + "description": "The [type of identity verification](https://developers.login.gov/oidc/#ial-values) (IAL) value for the Login.gov IdP.\nSee [Add a Login.gov IdP](https://developer.okta.com/docs/guides/add-logingov-idp/). Applies to `LOGINGOV` and `LOGINGOV_SANDBOX` IdP types.", + "nullable": true, + "type": "string" + }, + "idvMetadata": { + "description": "Metadata about the IDV vendor. Available only for `IDV_STANDARD` IdPs.", + "properties": { + "privacyPolicy": { + "description": "A URL that links to the privacy policy for the IDV vendor", + "type": "string" + }, + "termsOfUse": { + "description": "A URL that links to the terms of use for the IDV vendor", + "type": "string" + }, + "vendorDisplayName": { + "description": "The display name of the IDV vendor", + "type": "string" + } + }, + "type": "object" + }, + "inquiryTemplateId": { + "description": "The ID of the inquiry template from your Persona dashboard. The inquiry template always starts with `itmpl`. Applies to the `IDV_PERSONA` IdP type.", + "example": "itmpl_HSctx8fNvXoHtrQfz2hxUVH8RBjG", + "type": "string" + } + }, + "required": [ + "inquiryTemplateId" + ], + "type": "object" + }, + "IdentityProviderType": { + "description": "The IdP object's `type` property identifies the social or enterprise IdP used for authentication. \nEach IdP uses a specific protocol, therefore the `protocol` object must correspond with the IdP `type`. \nIf the protocol is OAuth 2.0-based, the `protocol` object's `scopes` property must also correspond with the scopes supported by the IdP `type`. \nFor policy actions supported by each IdP type, see [IdP type policy actions](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=policy&t=request).\n\n| Type | Description | Corresponding protocol | Corresponding protocol scopes |\n| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | -------------------------------------------------------------------- |\n| `AMAZON` | [Amazon](https://developer.amazon.com/settings/console/registration?return_to=/) as the IdP | OpenID Connect | `profile`, `profile:user_id` |\n| `APPLE` | [Apple](https://developer.apple.com/sign-in-with-apple/) as the IdP | OpenID Connect | `names`, `email`, `openid` |\n| `DISCORD` | [Discord](https://discord.com/login) as the IdP | OAuth 2.0 | `identify`, `email` |\n| `FACEBOOK` | [Facebook](https://developers.facebook.com) as the IdP | OAuth 2.0 | `public_profile`, `email` |\n| `GITHUB` | [GitHub](https://github.com/join) as the IdP | OAuth 2.0 | `user` |\n| `GITLAB` | [GitLab](https://gitlab.com/users/sign_in) as the IdP | OpenID Connect | `openid`, `read_user`, `profile`, `email` |\n| `GOOGLE` | [Google](https://accounts.google.com/signup) as the IdP | OpenID Connect | `openid`, `email`, `profile` |\n| `IDV_PERSONA` | [Persona](https://app.withpersona.com/dashboard/login) as the IDV IdP | ID verification | |\n| `IDV_CLEAR` | [CLEAR Verified](https://www.clearme.com/) as the IDV IdP | ID verification | `openid`, `profile`, `identity_assurance` |\n| `IDV_INCODE` | [Incode](https://incode.com/) as the IDV IdP | ID verification | `openid`, `profile`, `identity_assurance` |\n| `IDV_STANDARD` | Custom IDV as the IDV IdP | ID verification | `openid`, `profile`, `identity_assurance` |\n| `LINKEDIN` | [LinkedIn](https://developer.linkedin.com/) as the IdP | OAuth 2.0 | `r_emailaddress`, `r_liteprofile` |\n| `LOGINGOV` | [Login.gov](https://developers.login.gov/) as the IdP | OpenID Connect | `email`, `profile`, `profile:name` |\n| `LOGINGOV_SANDBOX` | [Login.gov's identity sandbox](https://developers.login.gov/testing/) as the IdP | OpenID Connect | `email`, `profile`, `profile:name` |\n| `MICROSOFT` | [Microsoft Enterprise SSO](https://azure.microsoft.com/) as the IdP | OpenID Connect | `openid`, `email`, `profile`, `https://graph.microsoft.com/User.Read` |\n| `OIDC` | IdP that supports [OpenID Connect](https://openid.net/specs/openid-connect-core-1_0.html) | OpenID Connect | `openid`, `email`, `profile` |\n| `PAYPAL` | [Paypal](https://www.paypal.com/signin) as the IdP | OpenID Connect | `openid`, `email`, `profile` |\n| `PAYPAL_SANDBOX` | [Paypal Sandbox](https://developer.paypal.com/tools/sandbox/) as the IdP | OpenID Connect | `openid`, `email`, `profile` |\n| `SALESFORCE` | [SalesForce](https://login.salesforce.com/) as the IdP | OAuth 2.0 | `id`, `email`, `profile` |\n| `SAML2` | Enterprise IdP that supports the [SAML 2.0 Web Browser SSO Profile](https://docs.oasis-open.org/security/saml/v2.0/saml-profiles-2.0-os.pdf)| SAML 2.0 | |\n| `SPOTIFY` | [Spotify](https://developer.spotify.com/) as the IdP | OpenID Connect | `user-read-email`, `user-read-private` |\n| `X509` | [Smart Card IdP](https://tools.ietf.org/html/rfc5280) | Mutual TLS | |\n| `XERO` | [Xero](https://www.xero.com/us/signup/api/) as the IdP | OpenID Connect | `openid`, `profile`, `email` |\n| `YAHOO` | [Yahoo](https://login.yahoo.com/) as the IdP | OpenID Connect | `openid`, `profile`, `email` |\n| `YAHOOJP` | [Yahoo Japan](https://login.yahoo.co.jp/config/login) as the IdP | OpenID Connect | `openid`, `profile`, `email` |\n| `OKTA_INTEGRATION` | IdP that supports the [OpenID Connect](https://openid.net/specs/openid-connect-core-1_0.html) Org2Org IdP | OpenID Connect | `openid`, `email`, `profile` |", + "enum": [ + "AMAZON", + "APPLE", + "DISCORD", + "FACEBOOK", + "GITHUB", + "GITLAB", + "GOOGLE", + "IDV_CLEAR", + "IDV_INCODE", + "IDV_PERSONA", + "IDV_STANDARD", + "LINKEDIN", + "LOGINGOV", + "LOGINGOV_SANDBOX", + "MICROSOFT", + "OIDC", + "OKTA_INTEGRATION", + "PAYPAL", + "PAYPAL_SANDBOX", + "SALESFORCE", + "SAML2", + "SPOTIFY", + "X509", + "XERO", + "YAHOO", + "YAHOOJP" + ], + "type": "string" + }, + "IdentitySourceGroupMembershipsDeleteProfile": { + "description": "Array of group memberships that need to be deleted in Okta", + "items": { + "properties": { + "groupExternalId": { + "description": "The external ID of the group whose memberships need to be deleted in Okta", + "maxLength": 255, + "type": "string" + }, + "memberExternalIds": { + "description": "Array of external IDs of member profiles that need to be inserted in this group in Okta", + "items": { + "maxLength": 255, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "IdentitySourceGroupMembershipsUpsertProfile": { + "description": "Array of group memberships that need to be inserted or updated in Okta", + "items": { + "properties": { + "groupExternalId": { + "description": "The external ID of the group whose memberships need to be inserted or updated in Okta", + "maxLength": 255, + "type": "string" + }, + "memberExternalIds": { + "description": "Array of external IDs of member profiles that need to be inserted in this group in Okta", + "items": { + "maxLength": 255, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "IdentitySourceGroupProfileForUpsert": { + "description": "Contains a set of external group attributes and their values that are mapped to Okta standard properties. See the group [`profile` object](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/getGroup!c=200&path=profile&t=response) and Declaration of a Custom Identity Source Schema in [Using anything as a source](https://help.okta.com/okta_help.htm?type=oie&id=ext-anything-as-a-source).\n> **Note:** Profile attributes can only be of the string type.", + "properties": { + "description": { + "description": "Description of the group", + "maxLength": 1024, + "nullable": true, + "type": "string" + }, + "displayName": { + "description": "Name of the group", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "IdentitySourceSession": { + "properties": { + "created": { + "description": "The timestamp when the identity source session was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the identity source session", + "readOnly": true, + "type": "string" + }, + "identitySourceId": { + "description": "The ID of the custom identity source for which the session is created", + "readOnly": true, + "type": "string" + }, + "importType": { + "description": "The type of import. All imports are `INCREMENTAL` imports.", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "The timestamp when the identity source session was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/IdentitySourceSessionStatus" + } + }, + "type": "object" + }, + "IdentitySourceSessionStatus": { + "description": "The current status of the identity source session", + "enum": [ + "CLOSED", + "COMPLETED", + "CREATED", + "ERROR", + "EXPIRED", + "IN_PROGRESS", + "TRIGGERED" + ], + "type": "string", + "x-enumDescriptions": { + "CLOSED": "The identity source session was canceled and isn't available for further activity.", + "COMPLETED": "The bulk data was processed and imported into Okta.", + "CREATED": "This is a new identity source session that hasn't been processed. You can upload bulk data in this stage.", + "ERROR": "The processing of import data in the session encountered an error. You need to open a new session to upload the data again.", + "EXPIRED": "This identity source session had the `CREATED` status and timed-out after 24 hours of inactivity.", + "IN_PROGRESS": "The bulk data is being uploaded to Okta.", + "TRIGGERED": "Okta is processing the import data in this session. You can't load bulk data in this stage." + } + }, + "IdentitySourceUserProfileForDelete": { + "properties": { + "externalId": { + "description": "The external ID of the entity that needs to be deleted in Okta", + "maxLength": 512, + "type": "string" + } + }, + "type": "object" + }, + "IdentitySourceUserProfileForUpsert": { + "description": "Contains a set of external user attributes and their values that are mapped to Okta standard and custom profile properties. See the [`profile` object](https://developer.okta.com/docs/api/openapi/okta-management/management/user/getuser#user/getuser/t=response&c=200&path=profile) and Declaration of a Custom Identity Source Schema in [Using anything as a source](https://help.okta.com/okta_help.htm?type=oie&id=ext-anything-as-a-source).\n> **Note:** Profile attributes can only be of the string type.", + "properties": { + "email": { + "description": "Email address of the user", + "format": "email", + "maxLength": 100, + "minLength": 5, + "type": "string" + }, + "firstName": { + "description": "First name of the user", + "maxLength": 50, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "homeAddress": { + "description": "Home address of the user", + "maxLength": 4096, + "nullable": true, + "type": "string" + }, + "lastName": { + "description": "Last name of the user", + "maxLength": 50, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "mobilePhone": { + "description": "Mobile phone number of the user", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "secondEmail": { + "description": "Alternative email address of the user", + "format": "email", + "maxLength": 100, + "minLength": 5, + "type": "string" + }, + "userName": { + "description": "Username of the user", + "maxLength": 100, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "IdentitySourceUserProfileForUpsertRequired": { + "allOf": [ + { + "$ref": "#/components/schemas/IdentitySourceUserProfileForUpsert" + }, + { + "description": "Contains a set of external user attributes and their values that are mapped to Okta standard and custom profile properties. See the [`profile` object](https://developer.okta.com/docs/api/openapi/okta-management/management/user/getuser#user/getuser/t=response&c=200&path=profile) and Declaration of a Custom Identity Source Schema in [Using anything as a source](https://help.okta.com/okta_help.htm?type=oie&id=ext-anything-as-a-source).\n> **Note:** Profile attributes can only be of the string type.", + "required": [ + "email", + "userName" + ], + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "IdpDiscoveryPlatformConditionEvaluatorPlatform": { + "properties": { + "os": { + "$ref": "#/components/schemas/IdpDiscoveryPlatformConditionEvaluatorPlatformOperatingSystem" + }, + "type": { + "$ref": "#/components/schemas/PolicyPlatformType" + } + }, + "type": "object" + }, + "IdpDiscoveryPlatformConditionEvaluatorPlatformOperatingSystem": { + "properties": { + "expression": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/IdpDiscoveryPolicyPlatformOperatingSystemType" + }, + "version": { + "$ref": "#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystemVersion" + } + }, + "type": "object" + }, + "IdpDiscoveryPlatformPolicyRuleCondition": { + "description": "Specifies a particular platform or device to match on", + "properties": { + "exclude": { + "items": { + "$ref": "#/components/schemas/IdpDiscoveryPlatformConditionEvaluatorPlatform" + }, + "type": "array" + }, + "include": { + "items": { + "$ref": "#/components/schemas/IdpDiscoveryPlatformConditionEvaluatorPlatform" + }, + "type": "array" + } + }, + "type": "object" + }, + "IdpDiscoveryPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "conditions": { + "default": null, + "description": "Policy conditions aren't supported for this policy type.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "IdpDiscoveryPolicyPlatformOperatingSystemType": { + "description": "The type of operating system", + "enum": [ + "ANDROID", + "ANY", + "CHROMEOS", + "IOS", + "OSX", + "OTHER", + "WINDOWS", + "LINUX" + ], + "type": "string" + }, + "IdpDiscoveryPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "$ref": "#/components/schemas/IdpPolicyRuleAction" + }, + "conditions": { + "$ref": "#/components/schemas/IdpDiscoveryPolicyRuleCondition" + } + }, + "type": "object" + } + ] + }, + "IdpDiscoveryPolicyRuleCondition": { + "allOf": [ + { + "description": "Specifies conditions that must be met during policy evaluation to apply the rule. All policy conditions and conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule." + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/AppAndInstancePolicyRuleCondition" + }, + "network": { + "$ref": "#/components/schemas/PolicyNetworkCondition" + }, + "platform": { + "$ref": "#/components/schemas/IdpDiscoveryPlatformPolicyRuleCondition" + }, + "userIdentifier": { + "$ref": "#/components/schemas/UserIdentifierPolicyRuleCondition" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "IdpPolicyRuleAction": { + "description": "Specifies where to route users when they are attempting to sign in to your org, if the rule conditions are satisfied. You can add up to 10 providers to a single `idp` policy action.", + "properties": { + "idp": { + "description": "Specifies IdP settings", + "properties": { + "idpSelectionType": { + "$ref": "#/components/schemas/IdpSelectionType", + "description": "Determines whether the rule should use expression language or a specific IdP" + }, + "matchCriteria": { + "description": "Required if `idpSelectionType` is set to `DYNAMIC`", + "items": { + "$ref": "#/components/schemas/IdpPolicyRuleActionMatchCriteria" + }, + "type": "array" + }, + "providers": { + "description": "List of configured identity providers that a given rule can route to. Ability to define multiple providers is a part of the Identity Engine. This allows users to choose a provider when they sign in. Contact support for information on the Identity Engine.", + "items": { + "$ref": "#/components/schemas/IdpPolicyRuleActionProvider" + }, + "type": "array" + }, + "shouldFallBackToOkta": { + "default": false, + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Specifies whether to fall back to `OKTA` if authentication with the configured identity provider fails", + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "IdpPolicyRuleActionMatchCriteria": { + "properties": { + "propertyName": { + "description": "The IdP property that the evaluated string should match to", + "type": "string" + }, + "providerExpression": { + "description": "You can provide an Okta Expression Language expression with the Login Context that's evaluated with the IdP. For example, the value `login.identifier` refers to the user's username. If the user is signing in with the username `john.doe@mycompany.com`, the expression `login.identifier.substringAfter(@))` is evaluated to the domain name of the user, for example: `mycompany.com`.\n", + "type": "string" + } + }, + "type": "object" + }, + "IdpPolicyRuleActionProvider": { + "properties": { + "id": { + "description": "IdP types of `OKTA`, `AgentlessDSSO`, and `IWA` don't require an ID.", + "type": "string" + }, + "name": { + "description": "Provider `name` in Okta. Optional. Supported in `IDENTITY ENGINE`.", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/IdentityProviderType" + } + }, + "type": "object" + }, + "IdpSelectionType": { + "description": "Determines whether the rule should use expression language or a specific IdP", + "enum": [ + "DYNAMIC", + "SPECIFIC" + ], + "type": "string" + }, + "Idv": { + "description": "Identity Verification (IDV) protocol configuration for identity verification.", + "properties": { + "authorizeUrl": { + "description": "URL of the authorization endpoint", + "example": "https://auth.example.com/oauth/authorize", + "format": "uri", + "type": "string" + }, + "configUrl": { + "description": "URL of the configuration endpoint", + "example": "https://example.com/config/url", + "format": "uri", + "type": "string" + }, + "issuerUrl": { + "description": "URL of the token issuer", + "example": "https://auth.example.com/", + "format": "uri", + "type": "string" + }, + "jwksUrl": { + "description": "URL of the JSON Web Key Set (JWKS) endpoint", + "example": "https://auth.example.com/.well-known/jwks.json", + "format": "uri", + "type": "string" + }, + "parUrl": { + "description": "URL of the Pushed Authorization Request (PAR) endpoint", + "example": "https://auth.example.com/oauth/par", + "format": "uri", + "type": "string" + }, + "privacyPolicyUrl": { + "description": "URL of the privacy policy", + "example": "https://example.com/legal/privacy", + "format": "uri", + "type": "string" + }, + "termsOfUseUrl": { + "description": "URL of the terms of use", + "example": "https://example.com/legal/eula", + "format": "uri", + "type": "string" + }, + "tokenUrl": { + "description": "URL of the token endpoint", + "example": "https://auth.example.com/oauth/token", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "IdvCapability": { + "description": "Identity Verification (IDV) capability configuration with embedded protocol details.", + "properties": { + "capability": { + "description": "IDV capability identifier", + "enum": [ + "IDV" + ], + "type": "string" + }, + "supportedProtocols": { + "description": "List of supported IDV protocols", + "items": { + "enum": [ + "ID_PROOFING" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "capability", + "supportedProtocols" + ], + "type": "object" + }, + "IframeEmbedScopeAllowedApps": { + "enum": [ + "OKTA_ENDUSER" + ], + "type": "string" + }, + "ImageUploadResponse": { + "properties": { + "url": { + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ImportScheduleObject": { + "description": "Import schedule configuration", + "properties": { + "fullImport": { + "allOf": [ + { + "$ref": "#/components/schemas/ImportScheduleSettings" + }, + { + "description": "Determines the full import schedule" + } + ] + }, + "incrementalImport": { + "allOf": [ + { + "$ref": "#/components/schemas/ImportScheduleSettings" + }, + { + "description": "Determines the incremental import schedule" + } + ] + }, + "status": { + "$ref": "#/components/schemas/EnabledStatus" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ImportScheduleSettings": { + "properties": { + "expression": { + "description": "The import schedule in UNIX cron format", + "example": "00 21 * * Mon,Thu,Fri,Sat", + "type": "string" + }, + "timezone": { + "description": "The import schedule time zone in Internet Assigned Numbers Authority (IANA) time zone name format", + "example": "America/Los_Angeles", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "expression" + ], + "type": "object" + }, + "ImportUsernameObject": { + "description": "Determines the Okta username for the imported user", + "properties": { + "userNameExpression": { + "description": "For `usernameFormat=CUSTOM`, specifies the Okta Expression Language statement for a username format that imported users use to sign in to Okta", + "type": "string" + }, + "usernameFormat": { + "default": "EMAIL", + "description": "Determines the username format when users sign in to Okta", + "enum": [ + "EMAIL", + "CUSTOM" + ], + "type": "string" + } + }, + "required": [ + "usernameFormat" + ], + "type": "object" + }, + "InactivityPolicyRuleCondition": { + "properties": { + "number": { + "type": "integer" + }, + "unit": { + "type": "string" + } + }, + "type": "object" + }, + "InboundProvisioningApplicationFeature": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationFeature" + }, + { + "type": "object" + }, + { + "properties": { + "capabilities": { + "$ref": "#/components/schemas/CapabilitiesInboundProvisioningObject" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "InlineHook": { + "description": "An inline hook object that specifies the details of the inline hook", + "properties": { + "_links": { + "$ref": "#/components/schemas/InlineHookLinks" + }, + "channel": { + "$ref": "#/components/schemas/InlineHookChannel" + }, + "created": { + "description": "Date of the inline hook creation", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The unique identifier for the inline hook", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Date of the last inline hook update", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The display name of the inline hook", + "maximum": 255, + "minimum": 1, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/InlineHookStatus" + }, + "type": { + "$ref": "#/components/schemas/InlineHookType" + }, + "version": { + "description": "Version of the inline hook type. The currently supported version is `1.0.0`.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InlineHookBasePayload": { + "properties": { + "cloudEventVersion": { + "description": "The inline hook cloud version", + "example": 0.1, + "type": "string" + }, + "contentType": { + "description": "The inline hook request header content", + "example": "application/JSON", + "type": "string" + }, + "eventId": { + "description": "The individual inline hook request ID", + "example": "3o9jBzq1SmOGmmsDsqyyeQ", + "type": "string" + }, + "eventTime": { + "description": "The time the inline hook request was sent", + "example": "2020-01-17T21:23:56.000Z", + "type": "string" + }, + "eventTypeVersion": { + "description": "The inline hook version", + "example": 1, + "type": "string" + } + }, + "type": "object" + }, + "InlineHookChannel": { + "discriminator": { + "mapping": { + "HTTP": "#/components/schemas/InlineHookChannelHttp", + "OAUTH": "#/components/schemas/InlineHookChannelOAuth" + }, + "propertyName": "type" + }, + "properties": { + "type": { + "$ref": "#/components/schemas/InlineHookChannelType" + }, + "version": { + "description": "Version of the inline hook type. The currently supported version is `1.0.0`.", + "type": "string" + } + }, + "type": "object" + }, + "InlineHookChannelConfig": { + "description": "Properties of the communications channel that are used to contact your external service", + "properties": { + "headers": { + "description": "An optional list of key/value pairs for headers that you can send with the request to the external service", + "items": { + "$ref": "#/components/schemas/InlineHookChannelConfigHeaders" + }, + "type": "array" + }, + "method": { + "description": "The method of the Okta inline hook request", + "type": "string" + }, + "uri": { + "description": "The external service endpoint that executes the inline hook handler. It must begin with `https://` and be reachable by Okta. No white space is allowed in the URI.", + "maximum": 1024, + "type": "string" + } + }, + "type": "object" + }, + "InlineHookChannelConfigAuthSchemeBody": { + "description": "The authentication scheme to use for this request", + "nullable": true, + "properties": { + "key": { + "description": "The header name for the authorization server", + "type": "string" + }, + "type": { + "description": "The authentication scheme type. Supported type—`HEADER`.", + "type": "string" + }, + "value": { + "description": "The header value. This secret value is passed to your external service endpoint. Your external service can check it as a security measure.", + "type": "string" + } + }, + "type": "object" + }, + "InlineHookChannelConfigAuthSchemeResponse": { + "description": "The authentication scheme to use for this request", + "nullable": true, + "properties": { + "key": { + "description": "The header name for the authorization server", + "type": "string" + }, + "type": { + "description": "The authentication scheme type. Supported type—`HEADER`", + "type": "string" + } + }, + "type": "object" + }, + "InlineHookChannelConfigCreate": { + "description": "Properties of the communications channel that are used to contact your external service", + "properties": { + "headers": { + "description": "An optional list of key/value pairs for headers that you can send with the request to the external service.", + "items": { + "$ref": "#/components/schemas/InlineHookChannelConfigHeaders" + }, + "type": "array" + }, + "method": { + "description": "The method of the Okta inline hook request", + "type": "string" + }, + "uri": { + "description": "The external service endpoint that executes the inline hook handler. It must begin with `https://` and be reachable by Okta. No white space is allowed in the URI.", + "maximum": 1024, + "type": "string" + } + }, + "type": "object" + }, + "InlineHookChannelConfigHeaders": { + "properties": { + "key": { + "description": "The optional field or header name", + "type": "string" + }, + "value": { + "description": "The value for the key", + "type": "string" + } + }, + "type": "object" + }, + "InlineHookChannelCreate": { + "discriminator": { + "mapping": { + "HTTP": "#/components/schemas/InlineHookChannelHttpCreate", + "OAUTH": "#/components/schemas/InlineHookChannelOAuthCreate" + }, + "propertyName": "type" + }, + "properties": { + "type": { + "$ref": "#/components/schemas/InlineHookChannelType" + }, + "version": { + "description": "Version of the inline hook type. The currently supported version is `1.0.0`.", + "type": "string" + } + }, + "type": "object" + }, + "InlineHookChannelHttp": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookChannel" + }, + { + "properties": { + "config": { + "$ref": "#/components/schemas/InlineHookHttpConfig" + } + }, + "type": "object" + } + ] + }, + "InlineHookChannelHttpCreate": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookChannelCreate" + }, + { + "properties": { + "config": { + "$ref": "#/components/schemas/InlineHookHttpConfigCreate" + } + }, + "type": "object" + } + ] + }, + "InlineHookChannelOAuth": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookChannel" + }, + { + "properties": { + "config": { + "$ref": "#/components/schemas/InlineHookOAuthChannelConfig" + } + }, + "type": "object" + } + ] + }, + "InlineHookChannelOAuthCreate": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookChannelCreate" + }, + { + "properties": { + "config": { + "$ref": "#/components/schemas/InlineHookOAuthChannelConfigCreate" + } + }, + "type": "object" + } + ] + }, + "InlineHookChannelType": { + "enum": [ + "HTTP", + "OAUTH" + ], + "type": "string" + }, + "InlineHookCreate": { + "description": "An inline hook object that specifies the details of the inline hook", + "properties": { + "channel": { + "$ref": "#/components/schemas/InlineHookChannelCreate" + }, + "name": { + "description": "The display name of the inline hook", + "maximum": 255, + "minimum": 1, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/InlineHookType" + }, + "version": { + "description": "Version of the inline hook type. The currently supported version is `1.0.0`.", + "type": "string" + } + }, + "type": "object" + }, + "InlineHookCreateResponse": { + "description": "An inline hook object that specifies the details of the inline hook", + "properties": { + "_links": { + "$ref": "#/components/schemas/InlineHookLinksCreate" + }, + "channel": { + "$ref": "#/components/schemas/InlineHookChannel" + }, + "created": { + "description": "Date of the inline hook creation", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The unique identifier for the inline hook", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Date of the last inline hook update", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The display name of the inline hook", + "maximum": 255, + "minimum": 1, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/InlineHookStatus" + }, + "type": { + "$ref": "#/components/schemas/InlineHookType" + }, + "version": { + "description": "Version of the inline hook type. The currently supported version is `1.0.0`.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InlineHookHttpConfig": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookChannelConfig" + } + ], + "properties": { + "authScheme": { + "$ref": "#/components/schemas/InlineHookChannelConfigAuthSchemeResponse" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "InlineHookHttpConfigCreate": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookChannelConfigCreate" + } + ], + "properties": { + "authScheme": { + "$ref": "#/components/schemas/InlineHookChannelConfigAuthSchemeBody" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "InlineHookLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "activate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to activate the inline hook" + }, + "deactivate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to deactivate the inline hook" + }, + "delete": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to delete the inline hook" + }, + "execute": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to test the inline hook" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "InlineHookLinksCreate": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "deactivate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to deactivate the inline hook" + }, + "execute": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to test the inline hook" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "InlineHookOAuthBasicConfig": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookChannelConfig" + } + ], + "properties": { + "authType": { + "type": "string" + }, + "clientId": { + "description": "A publicly exposed string provided by the service that's used to identify the OAuth app and build authorization URLs", + "type": "string" + }, + "scope": { + "description": "Include the scopes that allow you to perform the actions on the hook endpoint that you want to access", + "type": "string" + }, + "tokenUrl": { + "description": "The URI where inline hooks can exchange an authorization code for access and refresh tokens", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "InlineHookOAuthChannelConfig": { + "discriminator": { + "mapping": { + "client_secret_post": "#/components/schemas/InlineHookOAuthClientSecretConfig", + "private_key_jwt": "#/components/schemas/InlineHookOAuthPrivateKeyJwtConfig" + }, + "propertyName": "authType" + }, + "properties": { + "authType": { + "description": "The authentication method for the token endpoint", + "type": "string" + } + }, + "type": "object" + }, + "InlineHookOAuthChannelConfigCreate": { + "discriminator": { + "mapping": { + "client_secret_post": "#/components/schemas/InlineHookOAuthClientSecretConfigCreate", + "private_key_jwt": "#/components/schemas/InlineHookOAuthPrivateKeyJwtConfig" + }, + "propertyName": "authType" + }, + "properties": { + "authType": { + "description": "The authentication method for the token endpoint", + "type": "string" + } + }, + "type": "object" + }, + "InlineHookOAuthClientSecretConfig": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookOAuthBasicConfig" + } + ], + "properties": { + "authScheme": { + "description": "Not applicable. Must be `null`.", + "nullable": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "InlineHookOAuthClientSecretConfigCreate": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookOAuthBasicConfig" + } + ], + "properties": { + "clientSecret": { + "description": "A private value provided by the service used to authenticate the identity of the app to the service", + "type": "string" + }, + "method": { + "description": "The method of the Okta inline hook request. Only accepts `POST`.", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "InlineHookOAuthPrivateKeyJwtConfig": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookOAuthBasicConfig" + } + ], + "properties": { + "authScheme": { + "description": "Not applicable. Must be `null`.", + "nullable": true, + "type": "string" + }, + "hookKeyId": { + "description": "An ID value of the hook key pair generated from the [Hook Keys API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/HookKey/#tag/HookKey)", + "type": "string" + }, + "method": { + "description": "The method of the Okta inline hook request. Only accepts `POST`.", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "InlineHookPayload": { + "type": "object", + "x-okta-extensible": true, + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "InlineHookReplace": { + "description": "An inline hook object that specifies the details of the inline hook", + "properties": { + "channel": { + "$ref": "#/components/schemas/InlineHookChannelCreate" + }, + "name": { + "description": "The display name of the inline hook", + "maximum": 255, + "minimum": 1, + "type": "string" + }, + "version": { + "description": "Version of the inline hook type. The currently supported version is `1.0.0`.", + "type": "string" + } + }, + "type": "object" + }, + "InlineHookRequestObject": { + "description": "The API request that triggered the inline hook", + "properties": { + "id": { + "description": "The unique identifier that Okta assigned to the API request", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the client that made the API request", + "type": "string" + }, + "method": { + "description": "The HTTP request method of the API request", + "type": "string" + }, + "url": { + "description": "The URL of the API endpoint", + "properties": { + "value": { + "description": "The URL value of the API endpoint", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "InlineHookResponse": { + "properties": { + "commands": { + "items": { + "$ref": "#/components/schemas/InlineHookResponseCommands" + }, + "type": "array" + } + }, + "type": "object" + }, + "InlineHookResponseCommandValue": { + "properties": { + "op": { + "type": "string" + }, + "path": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "InlineHookResponseCommands": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "items": { + "$ref": "#/components/schemas/InlineHookResponseCommandValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "InlineHookStatus": { + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "InlineHookType": { + "description": "One of the inline hook types", + "enum": [ + "com.okta.import.transform", + "com.okta.oauth2.tokens.transform", + "com.okta.saml.tokens.transform", + "com.okta.telephony.provider", + "com.okta.user.credential.password.import", + "com.okta.user.pre-registration" + ], + "type": "string" + }, + "IntegrationCapability": { + "properties": { + "description": { + "description": "Description of the integration capability", + "example": "API Service Integration", + "type": "string" + }, + "helpUrl": { + "description": "URL to the help documentation for the integration capability", + "example": "https://example.com/docs/integration-capabilities/api-service", + "format": "uri", + "type": "string" + }, + "id": { + "description": "Unique identifier for the integration capability", + "example": "icp3eoa6r26zMq51w0g4", + "type": "string" + }, + "name": { + "description": "Name of the integration capability", + "example": "API Service integration", + "type": "string" + }, + "releaseDate": { + "description": "The date when the integration capability was released", + "example": "2023-08-24T14:15:22.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Status of the integration capability", + "enum": [ + "upcoming", + "released", + "deprecated", + "unknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "InterclientTrustMapping": { + "properties": { + "appInstanceId": { + "description": "The app ID of the target app", + "example": "0oa8ghelqWXs70qD80g5", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "created": { + "description": "Timestamp when the interclient trust mapping was created", + "example": "2025-11-25T22:44:06.000Z", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The unique ID of the interclient trust mapping", + "example": "itmahqusSr3v8Kk3B0g5", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the interclient trust mapping was updated", + "example": "2025-11-25T22:44:06.000Z", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "lastUpdatedBy": { + "description": "ID of the user who created the interclient trust mapping", + "example": "00u102rhXmxEGFKiB0g5", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "orgId": { + "description": "ID of the org", + "example": "00o102n9p4vX126Gp0g5", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "trustedAppInstanceId": { + "description": "The app ID of the allowed app", + "example": "0oa5kw6q51dFckBE70g5", + "nullable": false, + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InterclientTrustMappingRequestBody": { + "properties": { + "id": { + "description": "App ID of the allowed app", + "example": "0oa1elyw9EAkUNUrW0g5", + "nullable": false, + "type": "string" + } + }, + "type": "object" + }, + "IssuerMode": { + "enum": [ + "CUSTOM_URL", + "DYNAMIC", + "ORG_URL" + ], + "type": "string" + }, + "JsonPatchOperation": { + "description": "The update action", + "properties": { + "op": { + "$ref": "#/components/schemas/PatchAction" + }, + "path": { + "description": "The resource path of the attribute to update", + "type": "string" + }, + "value": { + "description": "The update operation value", + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "JsonWebKey": { + "properties": { + "created": { + "$ref": "#/components/schemas/createdProperty" + }, + "e": { + "description": "RSA key value (public exponent) for Key binding", + "readOnly": true, + "type": "string" + }, + "expiresAt": { + "description": "Timestamp when the certificate expires", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "kid": { + "description": "Unique identifier for the certificate", + "readOnly": true, + "type": "string" + }, + "kty": { + "description": "Cryptographic algorithm family for the certificate's keypair. Valid value: `RSA`", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "$ref": "#/components/schemas/lastUpdatedProperty", + "format": "date-time", + "type": "string" + }, + "n": { + "description": "RSA modulus value that is used by both the public and private keys and provides a link between them", + "type": "string" + }, + "use": { + "description": "Acceptable use of the certificate. Valid value: `sig`", + "readOnly": true, + "type": "string" + }, + "x5c": { + "description": "X.509 certificate chain that contains a chain of one or more certificates", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "x5t#S256": { + "description": "X.509 certificate SHA-256 thumbprint, which is the base64url-encoded SHA-256 thumbprint (digest) of the DER encoding of an X.509 certificate", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "JsonWebKeyStatus": { + "description": "The status of the public key", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "JsonWebKeyType": { + "description": "The type of public key", + "enum": [ + "RSA" + ], + "type": "string" + }, + "JsonWebKeyUse": { + "description": "The intended use of the public key", + "enum": [ + "enc" + ], + "type": "string" + }, + "JwkUse": { + "properties": { + "use": { + "$ref": "#/components/schemas/JwkUseType" + } + }, + "type": "object" + }, + "JwkUseType": { + "description": "Purpose of the certificate. The only supported value is `sig`.", + "enum": [ + "sig" + ], + "type": "string" + }, + "KeepCurrent": { + "properties": { + "keepCurrent": { + "default": true, + "description": "Skip deleting the user's current session when set to `true`", + "type": "boolean" + } + }, + "type": "object" + }, + "KeepMeSignedIn": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Controls how often the post-authentication prompt is presented to users", + "properties": { + "postAuth": { + "description": "Whether the post-authentication [Keep Me Signed In (KMSI)](https://help.okta.com/oie/en-us/content/topics/security/stay-signed-in.htm) flow is allowed", + "enum": [ + "ALLOWED", + "NOT_ALLOWED" + ], + "type": "string" + }, + "postAuthPromptFrequency": { + "$ref": "#/components/schemas/TimeDuration", + "default": "P30D", + "description": "If allowed, how often to display the post-authentication Keep Me Signed In prompt" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "KeyRequest": { + "properties": { + "name": { + "description": "Display name for the key", + "maxLength": 255, + "minLength": 1, + "nullable": false, + "readOnly": false, + "type": "string", + "uniqueItems": true + } + }, + "type": "object" + }, + "KeyTrustLevelBrowserKey": { + "description": "Represents the attestation strength used by the Chrome Verified Access API", + "enum": [ + "CHROME_BROWSER_HW_KEY", + "CHROME_BROWSER_OS_KEY" + ], + "example": "CHROME_BROWSER_HW_KEY", + "type": "string", + "x-enumDescriptions": { + "CHROME_BROWSER_HW_KEY": "Identity of the device was attested using a key pair that is OS encapsulated by a hardware layer", + "CHROME_BROWSER_OS_KEY": "Identity of the device was attested using a key pair that is simply stored on the device but not in any specific hardware layer" + } + }, + "KeyTrustLevelOSMode": { + "description": "Represents the attestation strength used by the Chrome Verified Access API", + "enum": [ + "CHROME_OS_DEVELOPER_MODE", + "CHROME_OS_VERIFIED_MODE" + ], + "example": "CHROME_OS_VERIFIED_MODE", + "type": "string", + "x-enumDescriptions": { + "CHROME_OS_DEVELOPER_MODE": "Identity of the device was attested using an enterprise-emitted certificate, and the device is in Developer mode", + "CHROME_OS_VERIFIED_MODE": "Identity of the device was attested using an enterprise-emitted certificate, and the device is in Verified mode" + } + }, + "KnowledgeConstraint": { + "allOf": [ + { + "$ref": "#/components/schemas/AccessPolicyConstraint" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "Language": { + "description": "The language specified as an [IETF BCP 47 language tag](https://datatracker.ietf.org/doc/html/rfc5646)", + "type": "string" + }, + "LastUpdated": { + "description": "Timestamp when the object was last updated", + "example": "2016-01-03T18:15:47.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "LifecycleCreateSettingObject": { + "description": "Determines whether to update a user in the app when a user in Okta is updated", + "properties": { + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/EnabledStatus" + }, + { + "default": "DISABLED" + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LifecycleDeactivateSettingObject": { + "description": "Determines whether deprovisioning occurs when the app is unassigned", + "properties": { + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/EnabledStatus" + }, + { + "default": "DISABLED" + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LifecycleExpirationPolicyRuleCondition": { + "properties": { + "lifecycleStatus": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "unit": { + "type": "string" + } + }, + "type": "object" + }, + "LifecycleStatus": { + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "LinkedHrefObject": { + "additionalProperties": true, + "properties": { + "href": { + "description": "Link URI", + "type": "string" + } + }, + "readOnly": true, + "required": [ + "href" + ], + "title": "Link Object", + "type": "object" + }, + "LinkedObject": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinkedObjectLinksSelf" + }, + "associated": { + "$ref": "#/components/schemas/LinkedObjectDetails" + }, + "primary": { + "$ref": "#/components/schemas/LinkedObjectDetails" + } + }, + "title": "LinkedObject", + "type": "object" + }, + "LinkedObjectDetails": { + "properties": { + "description": { + "description": "Description of the `primary` or the `associated` relationship", + "type": "string" + }, + "name": { + "description": "API name of the `primary` or the `associated` link. The `name` parameter can't start with a number and can only contain the following characters: `a-z`, `A-Z`,` 0-9`, and `_`.", + "type": "string" + }, + "title": { + "description": "Display name of the `primary` or the `associated` link", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/LinkedObjectDetailsType" + } + }, + "required": [ + "name", + "title", + "type" + ], + "title": "LinkedObjectDetails", + "type": "object" + }, + "LinkedObjectDetailsType": { + "description": "The object type for this relationship", + "enum": [ + "USER" + ], + "type": "string", + "x-enumDescriptions": { + "USER": "Specifies the type of object" + } + }, + "LinkedObjectLinksSelf": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of an application using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkedHrefObject" + } + }, + "type": "object" + }, + "LinksActivate": { + "properties": { + "activate": { + "allOf": [ + { + "description": "Activates an enrolled factor. See [Activate a factor](/openapi/okta-management/management/userfactor/activatefactor)." + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksAerialConsentGranted": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "revoke": { + "$ref": "#/components/schemas/HrefObjectRevokeAerialConsent" + } + }, + "type": "object" + } + ] + }, + "LinksAerialConsentRevoked": { + "allOf": [ + { + "properties": { + "grant": { + "$ref": "#/components/schemas/HrefObjectGrantAerialConsent" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksAppAndUser": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of resources related to the application user.", + "properties": { + "app": { + "$ref": "#/components/schemas/HrefObjectAppLink" + }, + "group": { + "$ref": "#/components/schemas/HrefObjectGroupLink" + }, + "user": { + "$ref": "#/components/schemas/HrefObjectUserLink" + } + }, + "readOnly": true, + "type": "object" + }, + "LinksAssignee": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification.", + "properties": { + "assignee": { + "$ref": "#/components/schemas/HrefObjectAssigneeLink" + } + }, + "type": "object" + }, + "LinksAuthenticator": { + "properties": { + "authenticator": { + "allOf": [ + { + "description": "Returns information about a specific authenticator. See [Retrieve an authenticator](/openapi/okta-management/management/authenticator/getauthenticator)." + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksCancel": { + "properties": { + "cancel": { + "allOf": [ + { + "description": "Cancels a `push` factor challenge with a `WAITING` status" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksCustomRoleResponse": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources.", + "properties": { + "assignee": { + "$ref": "#/components/schemas/HrefObjectAssigneeLink" + }, + "member": { + "$ref": "#/components/schemas/HrefObjectMemberLink" + }, + "permissions": { + "$ref": "#/components/schemas/HrefObjectPermissionsLink" + }, + "resource-set": { + "$ref": "#/components/schemas/HrefObjectResourceSetLink" + }, + "role": { + "$ref": "#/components/schemas/HrefObjectRoleLink" + } + }, + "type": "object" + }, + "LinksDeactivate": { + "properties": { + "deactivate": { + "allOf": [ + { + "description": "Deactivates the factor. See [Unenroll a factor](/openapi/okta-management/management/userfactor/unenrollfactor)." + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksEnroll": { + "properties": { + "enroll": { + "allOf": [ + { + "description": "Enrolls a supported factor. See [Enroll a factor](/openapi/okta-management/management/userfactor/enrollfactor)." + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksFactor": { + "properties": { + "factor": { + "allOf": [ + { + "description": "Link to the factor resource" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksGovernanceResources": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the resources using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification.", + "properties": { + "resources": { + "$ref": "#/components/schemas/HrefObjectGovernanceResourcesLink" + } + }, + "readOnly": true, + "type": "object" + }, + "LinksGovernanceSources": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the sources using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification.", + "properties": { + "assignee": { + "$ref": "#/components/schemas/HrefObjectUserLink" + }, + "self": { + "$ref": "#/components/schemas/HrefObjectSelfLink" + } + }, + "readOnly": true, + "type": "object" + }, + "LinksNext": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of an application using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. Use the `LinksNext` object for dynamic discovery of related resources and lifecycle operations.", + "properties": { + "next": { + "$ref": "#/components/schemas/HrefObjectNextLink" + } + }, + "readOnly": true, + "type": "object" + }, + "LinksNextForRoleAssignments": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification.", + "properties": { + "next": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "The next page of results if [pagination](#pagination) is required" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksPoll": { + "properties": { + "poll": { + "allOf": [ + { + "description": "Polls the factor resource for status information. Always use the `poll` link instead of manually constructing your own URL." + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksQrcode": { + "properties": { + "qrcode": { + "allOf": [ + { + "description": "QR code that encodes the push activation code needed for enrollment on the device" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksQuestions": { + "properties": { + "question": { + "allOf": [ + { + "description": "Lists all supported security questions. See [List all supported security questions](/openapi/okta-management/management/userfactor/listsupportedsecurityquestions)." + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksResend": { + "properties": { + "resend": { + "allOf": [ + { + "description": "Resends the factor enrollment challenge. See [Resend a factor enrollment](/openapi/okta-management/management/userfactor/resendenrollfactor)." + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksSelf": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.", + "properties": { + "self": { + "$ref": "#/components/schemas/HrefObjectSelfLink" + } + }, + "readOnly": true, + "type": "object" + }, + "LinksSelfAndFullUsersLifecycle": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + }, + { + "properties": { + "suspend": { + "$ref": "#/components/schemas/HrefObjectSuspendLink" + }, + "unsuspend": { + "$ref": "#/components/schemas/HrefObjectUnsuspendLink" + }, + "users": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "Link to device users" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksSelfAndLifecycle": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "activate": { + "$ref": "#/components/schemas/HrefObjectActivateLink" + }, + "deactivate": { + "$ref": "#/components/schemas/HrefObjectDeactivateLink" + } + }, + "type": "object" + } + ] + }, + "LinksSelfAndRoles": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "roles": { + "$ref": "#/components/schemas/HrefObjectRoleLink" + } + }, + "type": "object" + } + ] + }, + "LinksSelfForRoleAssignment": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources.", + "properties": { + "self": { + "$ref": "#/components/schemas/HrefObjectSelfLink" + } + }, + "type": "object" + }, + "LinksSelfLifecycleAndAuthorize": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + }, + { + "properties": { + "authorize": { + "$ref": "#/components/schemas/HrefObjectAuthorizeLink" + } + }, + "type": "object" + } + ] + }, + "LinksSend": { + "properties": { + "send": { + "allOf": [ + { + "description": "Sends an activation link through email or sms for users who can't scan the QR code" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksUserAuthenticators": { + "properties": { + "user": { + "allOf": [ + { + "description": "Returns information about the specified user" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksUserFactors": { + "properties": { + "user": { + "allOf": [ + { + "description": "Returns information on the specified user" + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LinksUserRef": { + "properties": { + "user": { + "$ref": "#/components/schemas/HrefObjectUserLink" + } + }, + "type": "object" + }, + "LinksVerify": { + "properties": { + "verify": { + "allOf": [ + { + "description": "Verifies the factor resource. See [Verify a factor](/openapi/okta-management/management/userfactor/verifyfactor)." + }, + { + "$ref": "#/components/schemas/HrefObject" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ListProfileMappings": { + "description": "A collection of the profile mappings that include a subset of the profile mapping object's properties. The profile mapping object describes a mapping between an Okta user's and an app user's properties using [JSON Schema Draft 4](https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-04).\n\n> **Note:** Same type source/target mappings aren't supported by this API. Profile mappings must either be Okta->App or App->Okta.", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "id": { + "description": "Unique identifier for profile mapping", + "readOnly": true, + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/ProfileMappingSource" + }, + "target": { + "$ref": "#/components/schemas/ProfileMappingTarget" + } + }, + "type": "object" + }, + "LoadingPageTouchPointVariant": { + "default": "OKTA_DEFAULT", + "description": "Variant for the Okta loading page. You can publish a theme for Okta loading page with different combinations of assets. Variants are preset combinations of those assets.\n", + "enum": [ + "NONE", + "OKTA_DEFAULT" + ], + "type": "string", + "x-enumDescriptions": { + "NONE": "Uses no loading page animation during the redirect", + "OKTA_DEFAULT": "Uses the default Okta loading page animation during the redirect" + } + }, + "LocationGranularity": { + "enum": [ + "CITY", + "COUNTRY", + "LAT_LONG", + "SUBDIVISION" + ], + "type": "string" + }, + "LogActor": { + "description": "Describes the user, app, client, or other entity (actor) who performs an action on a target. The actor is dependent on the action that is performed. All events have actors.", + "properties": { + "alternateId": { + "description": "Alternative ID of the actor", + "readOnly": true, + "type": "string" + }, + "detailEntry": { + "additionalProperties": true, + "description": "Further details about the actor", + "readOnly": true, + "type": "object" + }, + "displayName": { + "description": "Display name of the actor", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "ID of the actor", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Type of actor", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LogAuthenticationContext": { + "description": "All authentication relies on validating one or more credentials that prove the authenticity of the actor's identity. Credentials are sometimes provided by the actor, as is the case with passwords, and at other times provided by a third party, and validated by the authentication provider.\n\nThe authenticationContext contains metadata about how the actor is authenticated. For example, an authenticationContext for an event, where a user authenticates with Integrated Windows Authentication (IWA), looks like the following:\n```\n{\n \"authenticationProvider\": \"ACTIVE_DIRECTORY\",\n \"authenticationStep\": 0,\n \"credentialProvider\": null,\n \"credentialType\": \"IWA\",\n \"externalSessionId\": \"102N1EKyPFERROGvK9wizMAPQ\",\n \"interface\": null,\n \"issuer\": null\n}\n```\nIn this case, the user enters an IWA credential to authenticate against an Active Directory instance. All of the user's future-generated events in this sign-in session are going to share the same `externalSessionId`.\n\nAmong other operations, this response object can be used to scan for suspicious sign-in activity or perform analytics on user authentication habits (for example, how often authentication scheme X is used versus authentication scheme Y).", + "properties": { + "authenticationProvider": { + "$ref": "#/components/schemas/LogAuthenticationProvider" + }, + "authenticationStep": { + "description": "The zero-based step number in the authentication pipeline. Currently unused and always set to `0`.", + "readOnly": true, + "type": "integer" + }, + "credentialProvider": { + "$ref": "#/components/schemas/LogCredentialProvider" + }, + "credentialType": { + "$ref": "#/components/schemas/LogCredentialType" + }, + "externalSessionId": { + "description": "A proxy for the actor's [session ID](https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html)", + "readOnly": true, + "type": "string" + }, + "interface": { + "description": "The third-party user interface that the actor authenticates through, if any.", + "readOnly": true, + "type": "string" + }, + "issuer": { + "$ref": "#/components/schemas/LogIssuer" + } + }, + "type": "object" + }, + "LogAuthenticationProvider": { + "description": "The system that proves the identity of an actor using the credentials provided to it", + "enum": [ + "ACTIVE_DIRECTORY", + "FACTOR_PROVIDER", + "FEDERATION", + "LDAP", + "OKTA_AUTHENTICATION_PROVIDER", + "SOCIAL" + ], + "type": "string" + }, + "LogBotProtection": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>The result of the bot protection detection associated with the event", + "nullable": true, + "properties": { + "level": { + "description": "The bot detected level associated with the bot protection configuration target", + "enum": [ + "NONE", + "LOW", + "MEDIUM", + "HIGH" + ], + "nullable": true, + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "LogClient": { + "description": "When an event is triggered by an HTTP request, the `client` object describes the [client](https://datatracker.ietf.org/doc/html/rfc2616) that issues the HTTP request. For instance, the web browser is the client when a user accesses Okta. When this request is received and processed, a sign-in event is fired. When the event isn't sourced to an HTTP request, such as an automatic update, the `client` object field is blank.", + "properties": { + "device": { + "description": "Type of device that the client operates from (for example, computer)", + "readOnly": true, + "type": "string" + }, + "geographicalContext": { + "$ref": "#/components/schemas/LogGeographicalContext" + }, + "id": { + "description": "For OAuth requests, this is the ID of the OAuth [client](https://datatracker.ietf.org/doc/html/rfc6749#section-1.1) making the request. For SSWS token requests, this is the ID of the agent making the request.", + "readOnly": true, + "type": "string" + }, + "ipAddress": { + "description": "IP address that the client is making its request from", + "readOnly": true, + "type": "string" + }, + "userAgent": { + "$ref": "#/components/schemas/LogUserAgent" + }, + "zone": { + "description": "The `name` of the [Zone](https://developer.okta.com/docs/api/openapi/okta-management/management/networkzone/#tag/NetworkZone/operation/getNetworkZone) that the client's location is mapped to", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LogCredentialProvider": { + "description": "A credential provider is a software service that manages identities and their associated credentials. When authentication occurs through credentials provided by a credential provider, the credential provider is recorded here.", + "enum": [ + "DUO", + "GOOGLE", + "OKTA_AUTHENTICATION_PROVIDER", + "OKTA_CREDENTIAL_PROVIDER", + "RSA", + "SYMANTEC", + "YUBIKEY" + ], + "type": "string" + }, + "LogCredentialType": { + "description": "The underlying technology/scheme used in the credential", + "enum": [ + "ASSERTION", + "CERTIFICATE", + "DEVICE_UDID", + "EMAIL", + "IWA", + "JWT", + "OAuth 2.0", + "OKTA_CLIENT_SESSION", + "OTP", + "PASSWORD", + "PRE_SHARED_SYMMETRIC_KEY", + "SMS" + ], + "type": "string" + }, + "LogDebugContext": { + "description": "For some kinds of events (for example, OLM provisioning, sign-in request, second factor SMS, and so on), the fields that are provided in other response objects aren't sufficient to adequately describe the operations that the event has performed. In such cases, the `debugContext` object provides a way to store additional information.\n\nFor example, an event where a second factor SMS token is sent to a user may have a `debugContext` that looks like the following:\n```\n{\n \"debugData\": {\n \"requestUri\": \"/api/v1/users/00u3gjksoiRGRAZHLSYV/factors/smsf8luacpZJAva10x45/verify\",\n \"smsProvider\": \"TELESIGN\",\n \"transactionId\": \"268632458E3C100F5F5F594C6DC689D4\"\n }\n}\n```\nBy inspecting the debugData field, you can find the URI that is used to trigger the second factor SMS (`/api/v1/users/00u3gjksoiRGRAZHLSYV/factors/smsf8luacpZJAva10x45/verify`), the SMS provider (`TELESIGN`), and the ID used by Telesign to identify this transaction (`268632458E3C100F5F5F594C6DC689D4`).\n\nIf for some reason the information that is needed to implement a feature isn't provided in other response objects, you should scan the `debugContext.debugData` field for potentially useful fields.\n> **Important:** The information contained in `debugContext.debugData` is intended to add context when troubleshooting customer platform issues. Both key names and values may change from release to release and aren't guaranteed to be stable. Therefore, they shouldn't be viewed as a data contract but as a debugging aid instead.", + "properties": { + "debugData": { + "additionalProperties": true, + "description": "A dynamic field that contains miscellaneous information that is dependent on the event type.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, + "LogDevice": { + "description": "The entity that describes a device enrolled with passwordless authentication using Okta Verify.", + "example": { + "LogDeviceObject": { + "$ref": "#/components/examples/LogDeviceObject" + } + }, + "properties": { + "device_integrator": { + "description": "The integration platform or software used with the device", + "readOnly": true, + "type": "object" + }, + "disk_encryption_type": { + "$ref": "#/components/schemas/LogDiskEncryptionType" + }, + "id": { + "description": "ID of the device", + "readOnly": true, + "type": "string" + }, + "jailbreak": { + "description": "If the device has removed software restrictions", + "readOnly": true, + "type": "boolean" + }, + "managed": { + "description": "Indicates if the device is configured for device management and is registered with Okta", + "readOnly": true, + "type": "boolean" + }, + "name": { + "readOnly": true, + "type": "string" + }, + "os_platform": { + "readOnly": true, + "type": "string" + }, + "os_version": { + "readOnly": true, + "type": "string" + }, + "registered": { + "description": "Indicates if the device is registered with an Okta org and is bound to an Okta Verify instance on the device", + "readOnly": true, + "type": "boolean" + }, + "screen_lock_type": { + "$ref": "#/components/schemas/LogScreenLockType" + }, + "secure_hardware_present": { + "description": "The availability of hardware security on the device", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LogDiskEncryptionType": { + "enum": [ + "ALL_INTERNAL_VALUES", + "FULL", + "NONE", + "SYSTEM_VOLUME", + "USER" + ], + "type": "string" + }, + "LogEvent": { + "properties": { + "actor": { + "$ref": "#/components/schemas/LogActor" + }, + "authenticationContext": { + "$ref": "#/components/schemas/LogAuthenticationContext" + }, + "client": { + "$ref": "#/components/schemas/LogClient" + }, + "debugContext": { + "$ref": "#/components/schemas/LogDebugContext" + }, + "displayMessage": { + "description": "The display message for an event", + "readOnly": true, + "type": "string" + }, + "eventType": { + "description": "The published event type. Event instances are categorized by action in the event type attribute. This attribute is key to\nnavigating the System Log through expression filters. See [Event Types catalog](https://developer.okta.com/docs/reference/api/event-types/#catalog) for a complete list of System Log event types.", + "readOnly": true, + "type": "string" + }, + "legacyEventType": { + "description": "Associated Events API Action `objectType` attribute value", + "readOnly": true, + "type": "string" + }, + "outcome": { + "$ref": "#/components/schemas/LogOutcome" + }, + "published": { + "description": "Timestamp when the event is published", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "request": { + "$ref": "#/components/schemas/LogRequest" + }, + "securityContext": { + "$ref": "#/components/schemas/LogSecurityContext" + }, + "severity": { + "$ref": "#/components/schemas/LogSeverity" + }, + "target": { + "description": "The entity that an actor performs an action on. Targets can be anything, such as an app user, a sign-in token, or anything else.\n\n> **Note:** When searching the target array, search for a given `type` rather than the array location. Target types, such as `User` and `AppInstance`,\nfor a given `eventType` are not always in the same array location.", + "items": { + "$ref": "#/components/schemas/LogTarget" + }, + "readOnly": true, + "type": "array" + }, + "transaction": { + "$ref": "#/components/schemas/LogTransaction" + }, + "uuid": { + "description": "Unique identifier for an individual event", + "readOnly": true, + "type": "string" + }, + "version": { + "description": "Versioning indicator", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LogGeographicalContext": { + "description": "Geographical context describes a set of geographic coordinates. In addition to containing latitude and longitude data, the `GeographicalContext` object also contains address data of postal code-level granularity. Within the `Client` object, the geographical context refers to the physical location of the client when it sends the request that triggers this event. All `Transaction` events with `type` equal to `WEB` have a geographical context set. `Transaction` events with `type` equal to `JOB` don't have a geographical context set. The geographical context data can be missing if the geographical data for a request can't be resolved.", + "properties": { + "city": { + "description": "The city that encompasses the area that contains the geolocation coordinates, if available (for example, Seattle, San Francisco)", + "readOnly": true, + "type": "string" + }, + "country": { + "description": "Full name of the country that encompasses the area that contains the geolocation coordinates (for example, France, Uganda)", + "readOnly": true, + "type": "string" + }, + "geolocation": { + "$ref": "#/components/schemas/LogGeolocation" + }, + "postalCode": { + "description": "Postal code of the area that encompasses the geolocation coordinates", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Full name of the state or province that encompasses the area that contains the geolocation coordinates (for example, Montana, Ontario)", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LogGeolocation": { + "description": "The latitude and longitude of the geolocation where an action was performed. The object is formatted according to the [ISO 6709](https://www.iso.org/obp/ui/fr/#iso:std:iso:6709:ed-3:v1:en) standard.", + "properties": { + "lat": { + "description": "Latitude which uses two digits for the [integer part](https://www.iso.org/obp/ui/fr/#iso:std:iso:6709:ed-3:v1:en#Latitude)", + "format": "double", + "readOnly": true, + "type": "number" + }, + "lon": { + "description": "Longitude which uses three digits for the [integer part](https://www.iso.org/obp/ui/fr/#iso:std:iso:6709:ed-3:v1:en#Longitude)", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "LogIpAddress": { + "properties": { + "geographicalContext": { + "$ref": "#/components/schemas/LogGeographicalContext" + }, + "ip": { + "description": "IP address", + "readOnly": true, + "type": "string" + }, + "ipDetails": { + "$ref": "#/components/schemas/LogIpDetails" + }, + "source": { + "description": "Details regarding the source", + "readOnly": true, + "type": "string" + }, + "version": { + "description": "IP address version", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LogIpDetails": { + "description": "Details about the associated IP address", + "nullable": true, + "properties": { + "asNumber": { + "description": "The [Autonomous system](https://docs.telemetry.mozilla.org/datasets/other/asn_aggregates/reference) number that's associated with the IP address", + "nullable": true, + "readOnly": true, + "type": "integer" + }, + "asOrg": { + "description": "The name associated with the Autonomous System Number (ASN)", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "domain": { + "description": "The domain name associated with the IP address", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "ipServiceCategories": { + "description": "The associated IP service categories for the IP address", + "items": { + "$ref": "#/components/schemas/LogIpServiceCategory" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "isp": { + "description": "The internet service provider associated with the IP address", + "nullable": true, + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "LogIpServiceCategory": { + "description": "Describes the IP service category associated with an IP.", + "properties": { + "isAnonymous": { + "description": "Indicates whether the service is an anonymizer", + "nullable": true, + "readOnly": true, + "type": "boolean" + }, + "operator": { + "description": "The name of the associated operator", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The type of service provided from this IP address", + "enum": [ + "VPN", + "Proxy", + "Tor", + "Residential Proxy", + "Blockchain VPN" + ], + "nullable": true, + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "LogIssuer": { + "description": "Describes the issuer of the authorization server when the authentication is performed through OAuth. This is the location where well-known resources regarding the details of the authorization servers are published.", + "properties": { + "id": { + "description": "Varies depending on the type of authentication. If authentication is SAML 2.0, `id` is the issuer in the SAML assertion. For social login, `id` is the issuer of the token.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Information on the `issuer` and source of the SAML assertion or token", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LogOutcome": { + "properties": { + "reason": { + "description": "Reason for the result, for example, `INVALID_CREDENTIALS`", + "maxLength": 255, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "result": { + "description": "Result of the action", + "enum": [ + "SUCCESS", + "FAILURE", + "SKIPPED", + "ALLOW", + "DENY", + "CHALLENGE", + "UNKNOWN", + "RATE_LIMIT", + "DEFERRED", + "SCHEDULED", + "ABANDONED", + "UNANSWERED" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LogRequest": { + "description": "The `Request` object describes details that are related to the HTTP request that triggers this event, if available. When the event isn't sourced to an HTTP request, such as an automatic update on the Okta servers, the `Request` object still exists, but the `ipChain` field is empty.", + "properties": { + "ipChain": { + "description": "If the incoming request passes through any proxies, the IP addresses of those proxies are stored here in the format of clientIp, proxy1, proxy2, and so on. This field is useful when working with trusted proxies.", + "items": { + "$ref": "#/components/schemas/LogIpAddress" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "LogRisk": { + "description": "Risk associated with the event", + "nullable": true, + "properties": { + "detectionName": { + "description": "The name of the detection mechanism that identified the risk", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "issuer": { + "description": "The entity that issued the associated risk", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "level": { + "description": "The risk level associated with the request", + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ], + "nullable": true, + "readOnly": true, + "type": "string" + }, + "previousLevel": { + "description": "The previous risk level (if any) associated with the user", + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ], + "nullable": true, + "readOnly": true, + "type": "string" + }, + "reasons": { + "description": "Reasons for the associated risk", + "items": { + "type": "string" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "readOnly": true, + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "LogScreenLockType": { + "enum": [ + "BIOMETRIC", + "NONE", + "PASSCODE" + ], + "type": "string" + }, + "LogSecurityContext": { + "description": "The `securityContext` object provides security information that is directly related to the evaluation of the event's IP reputation. IP reputation is a trustworthiness rating that evaluates how likely a sender is to be malicious and is based on the sender's IP address. As the name implies, the `securityContext` object is useful for security applications-flagging and inspecting suspicious events.", + "properties": { + "asNumber": { + "description": "The [Autonomous system](https://docs.telemetry.mozilla.org/datasets/other/asn_aggregates/reference) number that's associated with the autonomous system the event request was sourced to", + "nullable": true, + "readOnly": true, + "type": "integer" + }, + "asOrg": { + "description": "The organization that is associated with the autonomous system that the event request is sourced to", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "botProtection": { + "$ref": "#/components/schemas/LogBotProtection" + }, + "domain": { + "description": "The domain name that's associated with the IP address of the inbound event request", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "ipDetails": { + "$ref": "#/components/schemas/LogIpDetails" + }, + "isProxy": { + "description": "Specifies whether an event's request is from a known proxy", + "nullable": true, + "readOnly": true, + "type": "boolean" + }, + "isp": { + "description": "The Internet service provider that's used to send the event's request", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "risk": { + "$ref": "#/components/schemas/LogRisk" + }, + "userBehaviors": { + "description": "The result of the user behavior detection models associated with the event", + "items": { + "$ref": "#/components/schemas/LogUserBehavior" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "LogSeverity": { + "description": "Indicates how severe the event is", + "enum": [ + "DEBUG", + "ERROR", + "INFO", + "WARN" + ], + "type": "string" + }, + "LogStream": { + "discriminator": { + "mapping": { + "aws_eventbridge": "#/components/schemas/LogStreamAws", + "splunk_cloud_logstreaming": "#/components/schemas/LogStreamSplunk" + }, + "propertyName": "type" + }, + "properties": { + "_links": { + "$ref": "#/components/schemas/LogStreamLinksSelfAndLifecycle" + }, + "created": { + "description": "Timestamp when the log stream object was created", + "example": "2022-10-21T16:59:59.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the log stream", + "example": "0oa1orzg0CHSgPcjZ0g4", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the log stream object was last updated", + "example": "2022-10-21T17:15:10.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "$ref": "#/components/schemas/LogStreamName" + }, + "status": { + "description": "Lifecycle status of the log stream object", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/LogStreamType" + } + }, + "required": [ + "created", + "id", + "lastUpdated", + "name", + "status", + "type", + "_links" + ], + "type": "object" + }, + "LogStreamActivateLink": { + "allOf": [ + { + "$ref": "#/components/schemas/LogStreamLinkObject" + }, + { + "description": "Link to activate the resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LogStreamAws": { + "allOf": [ + { + "$ref": "#/components/schemas/LogStream" + }, + { + "properties": { + "settings": { + "$ref": "#/components/schemas/LogStreamSettingsAws" + } + }, + "required": [ + "settings" + ], + "type": "object" + } + ] + }, + "LogStreamAwsPutSchema": { + "allOf": [ + { + "$ref": "#/components/schemas/LogStreamPutSchema" + }, + { + "properties": { + "settings": { + "$ref": "#/components/schemas/LogStreamSettingsAws" + } + }, + "required": [ + "settings" + ], + "type": "object" + } + ] + }, + "LogStreamDeactivateLink": { + "allOf": [ + { + "$ref": "#/components/schemas/LogStreamLinkObject" + }, + { + "description": "Link to deactivate the resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LogStreamLinkObject": { + "properties": { + "href": { + "description": "The URI of the resource", + "type": "string" + }, + "method": { + "description": "HTTP method allowed for the resource", + "enum": [ + "GET", + "POST" + ], + "type": "string" + } + }, + "readOnly": true, + "required": [ + "href" + ], + "title": "Log stream link object", + "type": "object" + }, + "LogStreamLinksSelfAndLifecycle": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of an application using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.", + "properties": { + "activate": { + "$ref": "#/components/schemas/LogStreamActivateLink" + }, + "deactivate": { + "$ref": "#/components/schemas/LogStreamDeactivateLink" + }, + "self": { + "$ref": "#/components/schemas/LogStreamSelfLink" + } + }, + "readOnly": true, + "required": [ + "self" + ], + "type": "object" + }, + "LogStreamName": { + "description": "Unique name for the log stream object", + "example": "My AWS EventBridge log stream", + "type": "string" + }, + "LogStreamPutSchema": { + "discriminator": { + "mapping": { + "aws_eventbridge": "#/components/schemas/LogStreamAwsPutSchema", + "splunk_cloud_logstreaming": "#/components/schemas/LogStreamSplunkPutSchema" + }, + "propertyName": "type" + }, + "properties": { + "name": { + "$ref": "#/components/schemas/LogStreamName" + }, + "type": { + "$ref": "#/components/schemas/LogStreamType" + } + }, + "required": [ + "name", + "type" + ], + "type": "object" + }, + "LogStreamSchema": { + "properties": { + "$schema": { + "description": "JSON schema version identifier", + "readOnly": true, + "type": "string" + }, + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "errorMessage": { + "description": "A collection of error messages for individual properties in the schema. Okta implements a subset of [ajv-errors](https://github.com/ajv-validator/ajv-errors).", + "type": "object" + }, + "id": { + "description": "URI of log stream schema", + "readOnly": true, + "type": "string" + }, + "oneOf": { + "description": "Non-empty array of valid JSON schemas.\n\nOkta only supports `oneOf` for specifying display names for an `enum`. Each schema has the following format:\n\n```\n{\n \"const\": \"enumValue\",\n \"title\": \"display name\"\n}\n```", + "items": { + "$ref": "#/components/schemas/UserSchemaAttributeEnum" + }, + "nullable": true, + "type": "array" + }, + "pattern": { + "description": "For `string` log stream schema property type, specifies the regular expression used to validate the property", + "type": "string" + }, + "properties": { + "description": "log stream schema properties object", + "type": "object" + }, + "required": { + "description": "Required properties for this log stream schema object", + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Name of the log streaming integration", + "type": "string" + }, + "type": { + "description": "Type of log stream schema property", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LogStreamSelfLink": { + "allOf": [ + { + "$ref": "#/components/schemas/LogStreamLinkObject" + }, + { + "description": "Link to the resource (self)" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "LogStreamSettingsAws": { + "description": "Specifies the configuration for the `aws_eventbridge` log stream type. This configuration can't be modified after creation.", + "properties": { + "accountId": { + "$ref": "#/components/schemas/AwsAccountId" + }, + "eventSourceName": { + "$ref": "#/components/schemas/AwsEventSourceName" + }, + "region": { + "$ref": "#/components/schemas/AwsRegion" + } + }, + "required": [ + "accountId", + "eventSourceName", + "region" + ], + "type": "object" + }, + "LogStreamSettingsSplunk": { + "description": "Specifies the configuration for the `splunk_cloud_logstreaming` log stream type.", + "properties": { + "edition": { + "$ref": "#/components/schemas/SplunkEdition" + }, + "host": { + "$ref": "#/components/schemas/SplunkHost" + }, + "token": { + "$ref": "#/components/schemas/SplunkToken" + } + }, + "required": [ + "edition", + "host", + "token" + ], + "type": "object" + }, + "LogStreamSettingsSplunkPut": { + "description": "Specifies the configuration for the `splunk_cloud_logstreaming` log stream type.", + "properties": { + "edition": { + "$ref": "#/components/schemas/SplunkEdition" + }, + "host": { + "$ref": "#/components/schemas/SplunkHost" + } + }, + "required": [ + "edition", + "host" + ], + "type": "object" + }, + "LogStreamSplunk": { + "allOf": [ + { + "$ref": "#/components/schemas/LogStream" + }, + { + "properties": { + "settings": { + "$ref": "#/components/schemas/LogStreamSettingsSplunk" + } + }, + "required": [ + "settings" + ], + "type": "object" + } + ] + }, + "LogStreamSplunkPutSchema": { + "allOf": [ + { + "$ref": "#/components/schemas/LogStreamPutSchema" + }, + { + "properties": { + "settings": { + "$ref": "#/components/schemas/LogStreamSettingsSplunkPut" + } + }, + "required": [ + "settings" + ], + "type": "object" + } + ] + }, + "LogStreamType": { + "description": "Specifies the streaming provider used\n\nSupported providers:\n * `aws_eventbridge` ([AWS EventBridge](https://aws.amazon.com/eventbridge))\n * `splunk_cloud_logstreaming` ([Splunk Cloud](https://www.splunk.com/en_us/software/splunk-cloud-platform.html))\n\nSelect the provider type to see provider-specific configurations in the `settings` property:", + "enum": [ + "aws_eventbridge", + "splunk_cloud_logstreaming" + ], + "type": "string" + }, + "LogTarget": { + "properties": { + "alternateId": { + "description": "The alternate ID of the target", + "readOnly": true, + "type": "string" + }, + "changeDetails": { + "description": "Details on the target's changes. Not all event types support the `changeDetails` property, and not all\n`target` objects contain the `changeDetails` property.\n\n> **Note:** You can't run queries on `changeDetails` or the object's `to` or `from` properties.", + "example": { + "LogTargetChangeDetails": { + "$ref": "#/components/examples/LogTargetChangeDetails" + } + }, + "properties": { + "from": { + "additionalProperties": true, + "description": "The original properties of the target", + "type": "object" + }, + "to": { + "additionalProperties": true, + "description": "The updated properties of the target", + "type": "object" + } + }, + "type": "object" + }, + "detailEntry": { + "additionalProperties": true, + "description": "Further details on the target", + "readOnly": true, + "type": "object" + }, + "displayName": { + "description": "The display name of the target", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the target", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The type of target", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LogTransaction": { + "description": "A `transaction` object comprises contextual information associated with its respective event.\nThis information is useful for understanding sequences of correlated events.\nFor example, a `transaction` object such as the following:\n```\n{\n \"id\": \"Wn4f-0RQ8D8lTSLkAmkKdQAADqo\",\n \"type\": \"WEB\",\n \"detail\": null\n}\n```\nindicates that a `WEB` request with `id` `Wn4f-0RQ8D8lTSLkAmkKdQAADqo` has created this event.\n\nA `transaction` object with a `requestApiTokenId` in the `detail` object, for example :\n```\n{\n \"id\": \"YjSlblAAqnKY7CdyCkXNBgAAAIU\",\n \"type\": \"WEB\",\n \"detail\": {\n \"requestApiTokenId\": \"00T94e3cn9kSEO3c51s5\"\n }\n}\n```\nindicates that this event was the result of an action performed through an API using the token identified by 00T94e3cn9kSEO3c51s5. The token ID is visible in the Admin Console, **Security** > **API**. See [API token management](https://help.okta.com/okta_help.htm?id=Security_API). For more information on API tokens, see [Create an API token](https://developer.okta.com/docs/guides/create-an-api-token/).", + "properties": { + "detail": { + "additionalProperties": true, + "description": "Details for this transaction.", + "readOnly": true, + "type": "object" + }, + "id": { + "description": "Unique identifier for this transaction.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Describes the kind of transaction. `WEB` indicates a web request. `JOB` indicates an asynchronous task.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LogUserAgent": { + "description": "\"A user agent is software (a software agent) that is acting on behalf of a user.\" ([Definition of User Agent](https://developer.mozilla.org/en-US/docs/Glossary/User_agent))\n\nIn the Okta event data object, the `UserAgent` object provides specifications about the client software that makes event-triggering HTTP requests. User agent identification is often useful for identifying interoperability problems between servers and clients, and also for browser and operating system usage analytics.\n", + "properties": { + "browser": { + "description": "If the client is a web browser, this field identifies the type of web browser (for example, CHROME, FIREFOX)", + "readOnly": true, + "type": "string" + }, + "os": { + "description": "The operating system that the client runs on (for example, Windows 10)", + "readOnly": true, + "type": "string" + }, + "rawUserAgent": { + "description": "A raw string representation of the user agent that is formatted according to [section 5.5.3 of HTTP/1.1 Semantics and Content](https://datatracker.ietf.org/doc/html/rfc7231#section-5.5.3). Both the `browser` and the `OS` fields can be derived from this field.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LogUserBehavior": { + "description": "The result of the user behavior detection models associated with the event", + "properties": { + "id": { + "description": "The unique identifier of the user behavior detection model", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the user behavior detection model [configured by admins](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Behavior/)", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "result": { + "description": "The result of the user behavior analysis", + "enum": [ + "UNKNOWN", + "POSITIVE", + "NEGATIVE", + "BAD_REQUEST" + ], + "nullable": true, + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "MDMEnrollmentPolicyEnrollment": { + "enum": [ + "ANY_OR_NONE", + "OMM" + ], + "type": "string" + }, + "MDMEnrollmentPolicyRuleCondition": { + "properties": { + "blockNonSafeAndroid": { + "type": "boolean" + }, + "enrollment": { + "$ref": "#/components/schemas/MDMEnrollmentPolicyEnrollment" + } + }, + "type": "object" + }, + "MacOSAccountProfile": { + "properties": { + "accountUuid": { + "description": "Unique identifier for the macOS account", + "example": "4ac29c85-d847-4492-96cb-46e337170c33", + "format": "uuid", + "type": "string" + }, + "fullName": { + "description": "Full name of the account user", + "example": "Carmel Sonne", + "type": "string" + }, + "type": { + "description": "Profile type discriminator", + "enum": [ + "MACOS" + ], + "type": "string" + }, + "username": { + "description": "Username of the account", + "example": "carmel.sonne", + "type": "string" + } + }, + "type": "object" + }, + "MembershipRequestSchema": { + "properties": { + "memberExternalId": { + "description": "The external ID of the user to be added as a member of the group in Okta", + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "MetadataLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the [SAML metadata](/openapi/okta-management/management/applicationsso/previewsamlmetadataforapplication) for SSO" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "MtlsCredentials": { + "description": "Certificate chain description for verifying assertions from the Smart Card", + "properties": { + "trust": { + "$ref": "#/components/schemas/MtlsTrustCredentials" + } + }, + "type": "object" + }, + "MtlsEndpoints": { + "properties": { + "sso": { + "$ref": "#/components/schemas/MtlsSsoEndpoint" + } + }, + "type": "object" + }, + "MtlsSsoEndpoint": { + "description": "The Single Sign-On (SSO) endpoint is the IdP's `SingleSignOnService` endpoint", + "properties": { + "url": { + "example": "https://{yourOktaDomain}.okta.com/login/cert", + "maxLength": 1014, + "type": "string" + } + }, + "type": "object" + }, + "MtlsTrustCredentials": { + "properties": { + "audience": { + "description": "Not used", + "example": null, + "type": "string" + }, + "issuer": { + "description": "Description of the certificate issuer", + "example": "CN=Test Smart Card, OU=Test OU, O=Test O, C=US", + "maxLength": 1024, + "type": "string" + }, + "kid": { + "$ref": "#/components/schemas/ProtocolCredentialsKeyId" + }, + "revocation": { + "$ref": "#/components/schemas/MtlsTrustCredentialsRevocation" + }, + "revocationCacheLifetime": { + "deprecated": true, + "description": "Time in minutes to cache the certificate revocation information\n\n> **Note:** This property isn't supported. Okta now handles CRL caching automatically. As of October 8, 2025, in Preview orgs, and October 13, 2025, in Production orgs, this property is ignored if it's specified in any API requests. Specifying this property in your API requests doesn't cause errors since the property has no effect.\n>\n> See [Deprecation Notice - Smart Card IdP Legacy CRL Cache Setting](https://support.okta.com/help/s/article/deprecation-notice-smart-card-idp-legacy-crl-cache-setting?language=en_US).", + "example": 2880, + "maximum": 4320, + "type": "number" + } + }, + "type": "object" + }, + "MtlsTrustCredentialsRevocation": { + "deprecated": true, + "description": "Mechanism to validate the certificate\n\n> **Note:** This property isn't supported. Okta now handles CRL caching automatically. As of October 8, 2025, in Preview orgs, and October 13, 2025, in Production orgs, this property is ignored if it's specified in any API requests. Specifying the property in your API requests doesn't cause any errors since the property has no effect.\n>\n> See [Deprecation Notice - Smart Card IdP Legacy CRL Cache Setting](https://support.okta.com/help/s/article/deprecation-notice-smart-card-idp-legacy-crl-cache-setting?language=en_US).", + "enum": [ + "CRL", + "DELTA_CRL", + "OCSP" + ], + "example": "CRL", + "type": "string" + }, + "NetworkZone": { + "discriminator": { + "mapping": { + "DYNAMIC": "#/components/schemas/DynamicNetworkZone", + "DYNAMIC_V2": "#/components/schemas/EnhancedDynamicNetworkZone", + "IP": "#/components/schemas/IPNetworkZone" + }, + "propertyName": "type" + }, + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + }, + "created": { + "description": "Timestamp when the object was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the Network Zone", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the object was last modified", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Unique name for this Network Zone", + "maxLength": 128, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/NetworkZoneStatus" + }, + "system": { + "description": "Indicates a system Network Zone:\n* `true` for system Network Zones\n* `false` for custom Network Zones\n\nThe Okta org provides the following default system Network Zones:\n* `LegacyIpZone`\n* `BlockedIpZone`\n* `DefaultEnhancedDynamicZone`\n* `DefaultExemptIpZone`\n\nAdmins can modify the name of the default system Network Zone and add up to 5000 gateway or proxy IP entries.\n", + "readOnly": true, + "type": "boolean" + }, + "type": { + "$ref": "#/components/schemas/NetworkZoneType" + }, + "usage": { + "$ref": "#/components/schemas/NetworkZoneUsage" + } + }, + "required": [ + "name", + "type" + ], + "type": "object" + }, + "NetworkZoneAddress": { + "description": "Specifies the value of an IP address expressed using either `range` or `CIDR` form.", + "properties": { + "type": { + "$ref": "#/components/schemas/NetworkZoneAddressType" + }, + "value": { + "description": "Value in CIDR/range form, depending on the `type` specified", + "type": "string" + } + }, + "type": "object" + }, + "NetworkZoneAddressType": { + "description": "Format of the IP addresses", + "enum": [ + "CIDR", + "RANGE" + ], + "type": "string" + }, + "NetworkZoneAsns": { + "items": { + "type": "string" + }, + "maximum": 75, + "type": "array" + }, + "NetworkZoneLocation": { + "properties": { + "country": { + "description": "The two-character ISO 3166-1 country code.\nDon't use continent codes since they are treated as generic codes for undesignated countries.\n<br>For example: `US`", + "maxLength": 2, + "minLength": 2, + "type": "string" + }, + "region": { + "description": "(Optional) The ISO 3166-2 region code appended to the country code (`countryCode-regionCode`), or `null` if empty.\nDon't use continent codes since they are treated as generic codes for undesignated regions.\n<br>For example: `CA` (for `US-CA` country and region code)", + "type": "string" + } + }, + "type": "object" + }, + "NetworkZoneLocationArray": { + "items": { + "$ref": "#/components/schemas/NetworkZoneLocation" + }, + "maximum": 75, + "nullable": true, + "type": "array" + }, + "NetworkZoneStatus": { + "description": "Network Zone status", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "NetworkZoneType": { + "description": "The type of Network Zone", + "enum": [ + "DYNAMIC", + "IP", + "DYNAMIC_V2" + ], + "type": "string" + }, + "NetworkZoneUsage": { + "description": "The usage of the Network Zone", + "enum": [ + "BLOCKLIST", + "POLICY" + ], + "type": "string" + }, + "NotificationType": { + "description": "The type of notification", + "enum": [ + "AD_AGENT", + "AGENT_AUTO_UPDATE_NOTIFICATION", + "AGENT_AUTO_UPDATE_NOTIFICATION_LDAP", + "APP_IMPORT", + "CONNECTOR_AGENT", + "IWA_AGENT", + "LDAP_AGENT", + "OKTA_ANNOUNCEMENT", + "OKTA_UPDATE", + "RATELIMIT_NOTIFICATION", + "REPORT_SUSPICIOUS_ACTIVITY", + "USER_DEPROVISION", + "USER_LOCKED_OUT" + ], + "type": "string", + "x-enumDescriptions": { + "AD_AGENT": "System notification sent when an AD agent disconnects or reconnects", + "AGENT_AUTO_UPDATE_NOTIFICATION": "System notification sent when an agent automatically updates", + "APP_IMPORT": "System notification sent with the status of an app user import", + "CONNECTOR_AGENT": "System notification sent when an on-premises provisioning or Okta on-prem MFA agent disconnects or reconnects", + "IWA_AGENT": "System notification sent when an IGA agent disconnects or reconnects", + "LDAP_AGENT": "System notification sent when an LDAP agent disconnects or reconnects", + "OKTA_ANNOUNCEMENT": "Okta communication sent for announcements and release notes", + "OKTA_UPDATE": "Okta communication sent for scheduled system updates", + "RATELIMIT_NOTIFICATION": "System notification sent when an org reaches rate limit warning or violation thresholds", + "REPORT_SUSPICIOUS_ACTIVITY": "System notification sent when a user reports suspicious activity", + "USER_DEPROVISION": "System notification sent when a user is deprovisioned from apps", + "USER_LOCKED_OUT": "System notification sent when a user is locked out from logging in to Okta" + } + }, + "NumberFactorChallengeEmbeddedLinks": { + "description": "Contains the `challenge` and `correctAnswer` objects for `push` factors that use a number matching challenge", + "properties": { + "challenge": { + "description": "Number matching challenge for a `push` factor", + "nullable": true, + "properties": { + "correctAnswer": { + "description": "The correct answer for a `push` factor that uses a number matching challenge", + "example": 72, + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "OAUTH2_CLIENT_CREDENTIALS": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseEmailServer" + }, + { + "properties": { + "clientId": { + "description": "The client ID that's used to access your SMTP server. This client ID is obtained when you create an OAuth 2.0 app with your email provider.", + "type": "string" + }, + "clientSecret": { + "description": "The client secret that's used to access your SMTP server. This client secret is obtained when you create an OAuth 2.0 app with your email provider.", + "type": "string" + }, + "scopes": { + "description": "List of OAuth 2.0 scopes for your SMTP server. You must provide a scope that allows your email server to send emails.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "The email provider's specific URL where the OAuth 2.0 app sends its credentials (or signed JWT) to exchange them for an access token", + "type": "string" + }, + "tokenEndpointAuthMethod": { + "description": "This method determines how your OAuth 2.0 app sends its credentials (`client_id` and `client_secret`) to the provider's server when requesting an access token", + "enum": [ + "CLIENT_SECRET_BASIC", + "CLIENT_SECRET_POST" + ], + "type": "string", + "x-enumDescriptions": { + "CLIENT_SECRET_BASIC": "The `client_id` and `client_secret` are combined into a single string (separated by a colon), Base64 encoded, and sent in the `Authorization` header", + "CLIENT_SECRET_POST": "The `client_id` and `client_secret` are sent as standard form parameters in the payload of the POST request" + } + } + }, + "required": [ + "authType" + ], + "type": "object" + } + ], + "title": "OAUTH2_CLIENT_CREDENTIALS" + }, + "OAUTH2_CLIENT_CREDENTIALS_CREATE": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseEmailServerCreate" + }, + { + "properties": { + "clientId": { + "description": "The client ID that's used to access your SMTP server. This client ID is obtained when you create an OAuth 2.0 app with your email provider.", + "type": "string" + }, + "clientSecret": { + "description": "The client secret that's used to access your SMTP server. This client secret is obtained when you create an OAuth 2.0 app with your email provider.", + "type": "string" + }, + "scopes": { + "description": "List of OAuth 2.0 scopes for your SMTP server. You must provide a scope that allows your email server to send emails.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "The email provider's specific URL where the OAuth 2.0 app sends its credentials (or signed JWT) to exchange them for an access token", + "type": "string" + }, + "tokenEndpointAuthMethod": { + "description": "This method determines how your OAuth 2.0 app sends its credentials (`client_id` and `client_secret`) to the provider's server when requesting an access token.", + "enum": [ + "CLIENT_SECRET_BASIC", + "CLIENT_SECRET_POST" + ], + "type": "string", + "x-enumDescriptions": { + "CLIENT_SECRET_BASIC": "The `client_id` and `client_secret` are combined into a single string (separated by a colon), Base64 encoded, and sent in the `Authorization` header", + "CLIENT_SECRET_POST": "The `client_id` and `client_secret` are sent as standard form parameters in the payload of the POST request." + } + } + }, + "required": [ + "clientId", + "clientSecret", + "tokenEndpoint", + "tokenEndpointAuthMethod", + "scopes" + ], + "type": "object" + } + ], + "title": "OAUTH2_CLIENT_CREDENTIALS" + }, + "OAUTH2_JWT_BEARER_GRANT": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseEmailServer" + }, + { + "properties": { + "audience": { + "description": "The URI of the authorization server that verifies the token. This is typically the token URI of your JWT.", + "type": "string" + }, + "clientId": { + "description": "The client ID that's used to access your SMTP server. This client ID is obtained when you create an OAuth 2.0 app with your email provider.", + "type": "string" + }, + "issuer": { + "description": "The unique ID of the entity that creates the JWT. This can sometimes be the email address of the user who creates the JWT. Check with your email provider for the correct value.", + "type": "string" + }, + "keyId": { + "description": "The ID of the private key that's used to sign the JWT", + "type": "string" + }, + "privateKey": { + "description": "The secret RSA key that's used to cryptographically sign the JWT", + "type": "string" + }, + "scopes": { + "description": "List of OAuth 2.0 scopes for your SMTP server. You must provide a scope that allows your email server to send emails.", + "items": { + "type": "string" + }, + "type": "array" + }, + "signingAlgorithm": { + "description": "The signing algorithm that's used to sign the JWT", + "enum": [ + "RS256" + ], + "type": "string" + }, + "subject": { + "description": "The email address of the user account that the OAuth 2.0 app impersonates to send emails", + "type": "string" + }, + "tokenEndpoint": { + "description": "The email provider's specific URL where the OAuth 2.0 app sends its credentials (or signed JWT) to exchange them for an access token", + "type": "string" + } + }, + "required": [ + "authType" + ], + "type": "object" + } + ], + "title": "OAUTH2_JWT_BEARER_GRANT" + }, + "OAUTH2_JWT_BEARER_GRANT_CREATE": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseEmailServerCreate" + }, + { + "properties": { + "audience": { + "description": "The URI of the authorization server that verifies the token. This is typically the token URI of your JWT.", + "type": "string" + }, + "clientId": { + "description": "The client ID that's used to access your SMTP server. This client ID is obtained when you create an OAuth 2.0 app with your email provider.", + "type": "string" + }, + "issuer": { + "description": "The unique ID of the entity that creates the JWT. This can sometimes be the email address of the user who creates the JWT. Check with your email provider for the correct value.", + "type": "string" + }, + "keyId": { + "description": "The ID of the private key that's used to sign the JWT", + "type": "string" + }, + "privateKey": { + "description": "The secret RSA key that's used to cryptographically sign the JWT", + "type": "string" + }, + "scopes": { + "description": "List of OAuth 2.0 scopes for your SMTP server. You must provide a scope that allows your email server to send emails.", + "items": { + "type": "string" + }, + "type": "array" + }, + "signingAlgorithm": { + "description": "The signing algorithm that's used to sign the JWT", + "enum": [ + "RS256" + ], + "type": "string" + }, + "subject": { + "description": "The email address of the user account that the OAuth 2.0 app impersonates to send emails", + "type": "string" + }, + "tokenEndpoint": { + "description": "The email provider's specific URL where the OAuth 2.0 app sends its credentials (or signed JWT) to exchange them for an access token", + "type": "string" + } + }, + "required": [ + "tokenEndpoint", + "clientId", + "signingAlgorithm", + "keyId", + "issuer", + "subject", + "audience", + "scopes", + "privateKey" + ], + "type": "object" + } + ], + "title": "OAUTH2_JWT_BEARER_GRANT" + }, + "OAuth2Actor": { + "description": "User that created the object", + "properties": { + "id": { + "description": "User ID", + "example": "00u5t60iloOHN9pBi0h7", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Type of user", + "example": "User", + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "OAuth2Claim": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "alwaysIncludeInToken": { + "description": "Specifies whether to include Claims in the token. The value is always `TRUE` for access token Claims. If the value is set to `FALSE` for an ID token claim, the Claim isn't included in the ID token when the token is requested with the access token or with the `authorization_code`. The client instead uses the access token to get Claims from the `/userinfo` endpoint.", + "type": "boolean" + }, + "claimType": { + "$ref": "#/components/schemas/OAuth2ClaimType" + }, + "conditions": { + "$ref": "#/components/schemas/OAuth2ClaimConditions" + }, + "group_filter_type": { + "$ref": "#/components/schemas/OAuth2ClaimGroupFilterType" + }, + "id": { + "description": "ID of the Claim", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the Claim", + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/LifecycleStatus" + }, + "system": { + "description": "When `true`, indicates that Okta created the Claim", + "type": "boolean" + }, + "value": { + "description": "Specifies the value of the Claim. This value must be a string literal if `valueType` is `GROUPS`, and the string literal is matched with the selected `group_filter_type`. The value must be an Okta EL expression if `valueType` is `EXPRESSION`.", + "type": "string" + }, + "valueType": { + "$ref": "#/components/schemas/OAuth2ClaimValueType" + } + }, + "type": "object" + }, + "OAuth2ClaimConditions": { + "description": "Specifies the scopes for the Claim", + "properties": { + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "OAuth2ClaimGroupFilterType": { + "description": "Specifies the type of group filter if `valueType` is `GROUPS`\n\nIf `valueType` is `GROUPS`, then the groups returned are filtered according to the value of `group_filter_type`.\n\nIf you have complex filters for Groups, you can [create a Groups allowlist](https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/) to put them all in a Claim.", + "enum": [ + "CONTAINS", + "EQUALS", + "REGEX", + "STARTS_WITH" + ], + "type": "string", + "x-enumDescriptions": { + "CONTAINS": "Group names contain `value` (not case-sensitive). For example, if `value` is `group1`, then `MyGroup123` and `group1` are included.", + "EQUALS": "Group name is the same as `value` (not case-sensitive). For example, if `value` is `group1`, then `group1` and `Group1` are included, but `group123` isn't.", + "REGEX": "Group names match the regular expression in `value` (case-sensitive). For example if `value` is `/^[a-z0-9_-]{3,16}$/`, then any Group name that has at least three letters, no more than 16, and contains lowercase letters, a hyphen, or numbers is a match.", + "STARTS_WITH": "Group names start with `value` (not case-sensitive). For example, if `value` is `group1`, then `group123` and `Group123` are included." + } + }, + "OAuth2ClaimType": { + "description": "Specifies whether the Claim is for an access token (`RESOURCE`) or an ID token (`IDENTITY`)", + "enum": [ + "IDENTITY", + "RESOURCE" + ], + "type": "string" + }, + "OAuth2ClaimValueType": { + "description": "Specifies whether the Claim is an Okta Expression Language (EL) expression (`EXPRESSION`), a set of groups (`GROUPS`), or a system claim (`SYSTEM`)", + "enum": [ + "EXPRESSION", + "GROUPS", + "SYSTEM" + ], + "type": "string" + }, + "OAuth2Client": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "grants": { + "allOf": [ + { + "$ref": "#/components/schemas/GrantResourcesHrefObject" + } + ], + "description": "Link to the grant resources" + }, + "tokens": { + "allOf": [ + { + "$ref": "#/components/schemas/TokenResourcesHrefObject" + } + ], + "description": "Link to the token resources" + } + }, + "type": "object" + } + ] + }, + "client_id": { + "description": "Unique key for the client application. The `client_id` is immutable.", + "example": "0oabskvc6442nkvQO0h7", + "readOnly": true, + "type": "string" + }, + "client_name": { + "description": "Human-readable string name of the client application", + "example": "My App", + "readOnly": true, + "type": "string" + }, + "client_uri": { + "example": "https://www.example.com", + "readOnly": true, + "type": "string" + }, + "logo_uri": { + "description": "URL string that references a logo for the client consent dialog (not the sign-in dialog)", + "example": "https://www.example.com/logo.png", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OAuth2ClientJsonEncryptionKeyRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyRequestBase" + } + ], + "description": "A [JSON Web Key (JWK)](https://tools.ietf.org/html/rfc7517) is a JSON representation of a cryptographic key. Okta uses an encryption key to encrypt an ID token JWT minted by the org authorization server or custom authorization server. Okta supports only RSA keys for encrypting tokens.", + "properties": { + "alg": { + "description": "Algorithm used in the key", + "example": "RSA-OAEP", + "nullable": false, + "type": "string" + }, + "e": { + "description": "RSA key value (exponent) for key binding", + "example": "AQAB", + "nullable": false, + "type": "string" + }, + "kty": { + "description": "Cryptographic algorithm family for the certificate's key pair", + "enum": [ + "RSA" + ], + "example": "RSA", + "nullable": false, + "type": "string" + }, + "n": { + "description": "RSA key value (modulus) for key binding", + "example": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", + "nullable": false, + "type": "string" + }, + "use": { + "description": "Acceptable use of the JSON Web Key", + "enum": [ + "enc" + ], + "example": "enc", + "nullable": false, + "type": "string" + } + }, + "title": "Encryption key", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "OAuth2ClientJsonEncryptionKeyResponse": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyRequestBase" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyResponseBase" + } + ], + "description": "A [JSON Web Key (JWK)](https://tools.ietf.org/html/rfc7517) is a JSON representation of a cryptographic key. Okta uses an encryption key to encrypt an ID token JWT minted by the org authorization server or custom authorization server. Okta supports only RSA keys for encrypting tokens.", + "properties": { + "e": { + "description": "RSA key value (exponent) for key binding", + "example": "AQAB", + "nullable": false, + "type": "string" + }, + "kty": { + "description": "Cryptographic algorithm family for the certificate's key pair", + "enum": [ + "RSA" + ], + "example": "RSA", + "nullable": false, + "type": "string" + }, + "n": { + "description": "RSA key value (modulus) for key binding", + "example": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", + "nullable": false, + "type": "string" + }, + "use": { + "description": "Acceptable use of the JSON Web Key", + "enum": [ + "enc" + ], + "example": "enc", + "nullable": false, + "type": "string" + } + }, + "title": "Encryption Key", + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "OAuth2ClientJsonSigningKeyRequest": { + "description": "A [JSON Web Key (JWK)](https://tools.ietf.org/html/rfc7517) is a JSON representation of a cryptographic key. Okta uses signing keys to verify the signature of a JWT when provided for the `private_key_jwt` client authentication method or for a signed authorize request object. Okta supports both RSA and Elliptic Curve (EC) keys for signing tokens.", + "discriminator": { + "mapping": { + "EC": "#/components/schemas/OAuth2ClientJsonWebKeyECRequest", + "RSA": "#/components/schemas/OAuth2ClientJsonWebKeyRsaRequest" + }, + "propertyName": "kty" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyRsaRequest" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyECRequest" + } + ], + "properties": { + "alg": { + "description": "Algorithm used in the key", + "example": "RS256", + "nullable": false, + "type": "string" + }, + "use": { + "description": "Acceptable use of the JSON Web Key", + "enum": [ + "sig" + ], + "example": "sig", + "nullable": false, + "type": "string" + } + }, + "title": "Signing Key", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OAuth2ClientJsonSigningKeyResponse": { + "description": "A [JSON Web Key (JWK)](https://tools.ietf.org/html/rfc7517) is a JSON representation of a cryptographic key. Okta uses signing keys to verify the signature of a JWT when provided for the `private_key_jwt` client authentication method or for a signed authorize request object. Okta supports both RSA and Elliptic Curve (EC) keys for signing tokens.", + "discriminator": { + "mapping": { + "EC": "#/components/schemas/OAuth2ClientJsonWebKeyECResponse", + "RSA": "#/components/schemas/OAuth2ClientJsonWebKeyRsaResponse" + }, + "propertyName": "kty" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyRsaResponse" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyECResponse" + } + ], + "title": "Signing Key", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OAuth2ClientJsonWebKeyECRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyRequestBase" + } + ], + "description": "An EC signing key", + "properties": { + "kty": { + "description": "Cryptographic algorithm family for the certificate's key pair", + "enum": [ + "EC" + ], + "example": "RSA", + "nullable": false, + "type": "string" + }, + "x": { + "description": "The public x coordinate for the elliptic curve point", + "type": "string" + }, + "y": { + "description": "The public y coordinate for the elliptic curve point", + "type": "string" + } + }, + "title": "EC signing Key", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OAuth2ClientJsonWebKeyECResponse": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyRequestBase" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyResponseBase" + } + ], + "description": "An EC signing key", + "properties": { + "kty": { + "description": "Cryptographic algorithm family for the certificate's key pair", + "enum": [ + "EC" + ], + "example": "EC", + "nullable": false, + "type": "string" + }, + "x": { + "description": "The public x coordinate for the elliptic curve point", + "type": "string" + }, + "y": { + "description": "The public y coordinate for the elliptic curve point", + "type": "string" + } + }, + "title": "EC signing key", + "type": "object" + }, + "OAuth2ClientJsonWebKeyRequestBase": { + "properties": { + "kid": { + "description": "Unique identifier of the JSON Web Key in the OAUth 2.0 client's JWKS", + "example": "SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-FIbm4", + "nullable": true, + "type": "string" + }, + "status": { + "default": "ACTIVE", + "description": "Status of the OAuth 2.0 client JSON Web Key", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE", + "nullable": false, + "type": "string" + } + }, + "type": "object" + }, + "OAuth2ClientJsonWebKeyRequestBody": { + "properties": { + "alg": { + "description": "Algorithm used in the key", + "example": "RS256", + "nullable": false, + "type": "string" + }, + "e": { + "description": "RSA key value (exponent) for key binding", + "example": "AQAB", + "nullable": false, + "type": "string" + }, + "kid": { + "description": "Unique identifier of the JSON Web Key in the OAuth 2.0 client's JWKS", + "example": "SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-FIbm4", + "nullable": true, + "type": "string" + }, + "kty": { + "description": "Cryptographic algorithm family for the certificate's key pair", + "example": "RSA", + "nullable": false, + "type": "string" + }, + "n": { + "description": "RSA key value (modulus) for key binding", + "example": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", + "nullable": false, + "type": "string" + }, + "status": { + "description": "Status of the OAuth 2.0 client JSON Web Key", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE", + "type": "string" + }, + "use": { + "description": "Acceptable use of the JSON Web Key", + "example": "sig", + "nullable": false, + "type": "string" + } + }, + "type": "object" + }, + "OAuth2ClientJsonWebKeyResponseBase": { + "properties": { + "_links": { + "$ref": "#/components/schemas/OAuthClientSecretLinks", + "nullable": false, + "readOnly": true + }, + "created": { + "description": "Timestamp when the OAuth 2.0 client JSON Web Key was created", + "example": "2023-02-21T20:08:24.000Z", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The unique ID of the OAuth client JSON Web Key", + "example": "pks2f4zrZbs8nUa7p0g4", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the OAuth 2.0 client JSON Web Key was updated", + "example": "2023-02-21T20:08:24.000Z", + "nullable": false, + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "OAuth2ClientJsonWebKeyRsaRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyRequestBase" + } + ], + "description": "An RSA signing key", + "properties": { + "e": { + "description": "RSA key value (exponent) for key binding", + "example": "AQAB", + "nullable": false, + "type": "string" + }, + "kty": { + "description": "Cryptographic algorithm family for the certificate's key pair", + "enum": [ + "RSA" + ], + "example": "RSA", + "nullable": false, + "type": "string" + }, + "n": { + "description": "RSA key value (modulus) for key binding", + "example": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", + "nullable": false, + "type": "string" + } + }, + "title": "RSA signing key", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OAuth2ClientJsonWebKeyRsaResponse": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyRequestBase" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonWebKeyResponseBase" + } + ], + "description": "An RSA signing key", + "properties": { + "e": { + "description": "RSA key value (exponent) for key binding", + "example": "AQAB", + "nullable": false, + "type": "string" + }, + "kty": { + "description": "Cryptographic algorithm family for the certificate's key pair", + "enum": [ + "RSA" + ], + "example": "RSA", + "nullable": false, + "type": "string" + }, + "n": { + "description": "RSA key value (modulus) for key binding", + "example": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", + "nullable": false, + "type": "string" + } + }, + "title": "RSA signing key", + "type": "object" + }, + "OAuth2ClientSecret": { + "properties": { + "_links": { + "$ref": "#/components/schemas/OAuthClientSecretLinks", + "nullable": false, + "readOnly": true + }, + "client_secret": { + "description": "The OAuth 2.0 client secret string", + "example": "DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "created": { + "description": "Timestamp when the OAuth 2.0 client secret was created", + "example": "2023-02-21T20:08:24.000Z", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The unique ID of the OAuth 2.0 client secret", + "example": "ocs2f4zrZbs8nUa7p0g4", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the OAuth 2.0 client secret was updated", + "example": "2023-02-21T20:08:24.000Z", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "secret_hash": { + "description": "OAuth 2.0 client secret string hash", + "example": "yk4SVx4sUWVJVbHt6M-UPA", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "status": { + "default": "ACTIVE", + "description": "Status of the OAuth 2.0 client secret", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE", + "nullable": false, + "type": "string" + } + }, + "type": "object" + }, + "OAuth2ClientSecretRequestBody": { + "properties": { + "client_secret": { + "description": "The OAuth 2.0 client secret string", + "example": "DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B", + "type": "string" + }, + "status": { + "description": "Status of the OAuth 2.0 client secret", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE", + "type": "string" + } + }, + "type": "object" + }, + "OAuth2RefreshToken": { + "properties": { + "_embedded": { + "description": "The embedded resources related to the object if the `expand` query parameter is specified", + "properties": { + "scopes": { + "description": "The scope objects attached to the Token", + "items": { + "$ref": "#/components/schemas/OAuth2RefreshTokenScope" + }, + "type": "array" + } + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "app": { + "allOf": [ + { + "$ref": "#/components/schemas/AppResourceHrefObject" + } + ], + "description": "Link to the app resource" + }, + "authorizationServer": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthorizationServerResourceHrefObject" + } + ], + "description": "Link to the Token authorization server resource" + }, + "client": { + "allOf": [ + { + "$ref": "#/components/schemas/AppResourceHrefObject" + } + ], + "description": "Link to the client resource" + }, + "revoke": { + "allOf": [ + { + "$ref": "#/components/schemas/RevokeRefreshTokenHrefObject" + }, + { + "properties": { + "hints": { + "properties": { + "allow": { + "items": { + "default": "DELETE", + "enum": [ + "DELETE" + ] + } + } + } + } + } + } + ], + "description": "Link to revoke the refresh Token" + }, + "user": { + "allOf": [ + { + "$ref": "#/components/schemas/UserResourceHrefObject" + } + ], + "description": "Link to the user resource" + } + }, + "type": "object" + } + ] + }, + "clientId": { + "description": "Client ID", + "type": "string" + }, + "created": { + "$ref": "#/components/schemas/createdProperty" + }, + "expiresAt": { + "description": "Expiration time of the OAuth 2.0 Token", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "ID of the Token object", + "example": "oar579Mcp7OUsNTlo0g3", + "readOnly": true, + "type": "string" + }, + "issuer": { + "description": "The complete URL of the authorization server that issued the Token", + "example": "https://{yourOktaDomain}/oauth2/ausain6z9zIedDCxB0h7", + "type": "string" + }, + "lastUpdated": { + "$ref": "#/components/schemas/lastUpdatedProperty" + }, + "scopes": { + "description": "The scope names attached to the Token", + "items": { + "example": "offline_access", + "type": "string" + }, + "type": "array" + }, + "status": { + "$ref": "#/components/schemas/GrantOrTokenStatus" + }, + "userId": { + "description": "The ID of the user associated with the Token", + "example": "00u5t60iloOHN9pBi0h7", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OAuth2RefreshTokenScope": { + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of an application using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.", + "properties": { + "scope": { + "allOf": [ + { + "$ref": "#/components/schemas/OfflineAccessScopeResourceHrefObject" + } + ], + "description": "Link to Scope resource" + } + }, + "type": "object" + }, + "description": { + "description": "Description of the Scope", + "example": "Requests a refresh token by default, used to obtain more access tokens without re-prompting the user for authentication", + "type": "string" + }, + "displayName": { + "description": "Name of the end user displayed in a consent dialog", + "type": "string" + }, + "id": { + "description": "Scope object ID", + "example": "scppb56cIl4GvGxy70g3", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Scope name", + "example": "offline_access", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OAuth2ResourceServerJsonWebKey": { + "properties": { + "_links": { + "$ref": "#/components/schemas/OAuthResourceServerKeyLinks", + "nullable": false, + "readOnly": true + }, + "created": { + "description": "Timestamp when the JSON Web Key was created", + "example": "2023-02-21T20:08:24.000Z", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "e": { + "description": "RSA key value (exponent) for key binding", + "example": "AQAB", + "nullable": false, + "type": "string" + }, + "id": { + "description": "The unique ID of the JSON Web Key", + "example": "apk2f4zrZbs8nUa7p0g4", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "kid": { + "description": "Unique identifier of the JSON Web Key in the Custom Authorization Server's Public JWKS", + "example": "SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-FIbm4", + "nullable": true, + "type": "string" + }, + "kty": { + "description": "Cryptographic algorithm family for the certificate's key pair", + "example": "RSA", + "nullable": false, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the JSON Web Key was updated", + "example": "2023-02-21T20:08:24.000Z", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "n": { + "description": "RSA key value (modulus) for key binding", + "example": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", + "nullable": false, + "type": "string" + }, + "status": { + "default": "ACTIVE", + "description": "The status of the encryption key. You can use only an `ACTIVE` key to encrypt tokens issued by the authorization server.", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE", + "nullable": false, + "type": "string" + }, + "use": { + "description": "Acceptable use of the JSON Web Key", + "example": "enc", + "nullable": false, + "type": "string" + } + }, + "type": "object" + }, + "OAuth2ResourceServerJsonWebKeyRequestBody": { + "properties": { + "e": { + "description": "RSA key value (exponent) for key binding", + "example": "AQAB", + "nullable": false, + "type": "string" + }, + "kid": { + "description": "Unique identifier of the JSON web key in the custom authorization server's public JWKS", + "example": "SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-FIbm4", + "nullable": true, + "type": "string" + }, + "kty": { + "description": "Cryptographic algorithm family for the certificate's key pair", + "example": "RSA", + "nullable": false, + "type": "string" + }, + "n": { + "description": "RSA key value (modulus) for key binding", + "example": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", + "nullable": false, + "type": "string" + }, + "status": { + "description": "Status of the JSON Web Key", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE", + "type": "string" + }, + "use": { + "description": "Acceptable use of the JSON Web Key", + "example": "enc", + "nullable": false, + "type": "string" + } + }, + "type": "object" + }, + "OAuth2Scope": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "consent": { + "$ref": "#/components/schemas/OAuth2ScopeConsentType" + }, + "default": { + "default": false, + "description": "Indicates if this Scope is a default scope", + "type": "boolean" + }, + "description": { + "description": "Description of the Scope", + "type": "string" + }, + "displayName": { + "description": "Name of the end user displayed in a consent dialog", + "type": "string" + }, + "id": { + "description": "Scope object ID", + "readOnly": true, + "type": "string" + }, + "metadataPublish": { + "$ref": "#/components/schemas/OAuth2ScopeMetadataPublish" + }, + "name": { + "description": "Scope name", + "type": "string" + }, + "optional": { + "default": false, + "description": "Indicates whether the Scope is optional. When set to `true`, the user can skip consent for the scope.", + "type": "boolean" + }, + "system": { + "default": false, + "description": "Indicates if Okta created the Scope", + "type": "boolean" + } + }, + "required": [ + "name" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OAuth2ScopeConsentGrant": { + "description": "Grant object that represents an app consent scope grant", + "properties": { + "_embedded": { + "description": "Embedded resources related to the Grant", + "properties": { + "scope": { + "properties": { + "id": { + "description": "The name of the Okta scope for which consent is granted", + "example": "okta.users.read", + "type": "string" + } + }, + "type": "object" + } + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "app": { + "allOf": [ + { + "$ref": "#/components/schemas/AppResourceHrefObject" + } + ], + "description": "Link to the app resource" + }, + "authorizationServer": { + "allOf": [ + { + "$ref": "#/components/schemas/AuthorizationServerResourceHrefObject" + } + ], + "description": "Link to the authorization server resource" + }, + "client": { + "allOf": [ + { + "$ref": "#/components/schemas/AppResourceHrefObject" + } + ], + "description": "Link to the client resource" + }, + "scope": { + "allOf": [ + { + "$ref": "#/components/schemas/ScopeResourceHrefObject" + } + ], + "description": "Link to the scope resource" + }, + "user": { + "allOf": [ + { + "$ref": "#/components/schemas/UserResourceHrefObject" + } + ], + "description": "Link to the user resource" + } + }, + "type": "object" + }, + { + "readOnly": true + } + ] + }, + "clientId": { + "description": "Client ID of the app integration", + "example": "oag3ih1zrm1cBFOiq0h6", + "readOnly": true, + "type": "string" + }, + "created": { + "$ref": "#/components/schemas/createdProperty" + }, + "createdBy": { + "$ref": "#/components/schemas/OAuth2Actor" + }, + "id": { + "description": "ID of the Grant object", + "example": "oag3ih1zrm1cBFOiq0h6", + "readOnly": true, + "type": "string" + }, + "issuer": { + "description": "The issuer of your org authorization server. This is typically your Okta domain.", + "example": "https://my_test_okta_org.oktapreview.com", + "type": "string" + }, + "lastUpdated": { + "$ref": "#/components/schemas/lastUpdatedProperty" + }, + "scopeId": { + "description": "The name of the [Okta scope](https://developer.okta.com/docs/api/oauth2/#oauth-20-scopes) for which consent is granted", + "example": "okta.users.read", + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/OAuth2ScopeConsentGrantSource" + }, + "status": { + "$ref": "#/components/schemas/GrantOrTokenStatus" + }, + "userId": { + "description": "User ID that granted consent (if `source` is `END_USER`)", + "example": "00u5t60iloOHN9pBi0h7", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "issuer", + "scopeId" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OAuth2ScopeConsentGrantSource": { + "description": "User type source that granted consent", + "enum": [ + "ADMIN", + "END_USER" + ], + "example": "ADMIN", + "readOnly": true, + "type": "string" + }, + "OAuth2ScopeConsentType": { + "default": "IMPLICIT", + "description": "Indicates whether a consent dialog is needed for the Scope", + "enum": [ + "FLEXIBLE", + "IMPLICIT", + "REQUIRED" + ], + "type": "string" + }, + "OAuth2ScopeMetadataPublish": { + "default": "NO_CLIENTS", + "description": "Indicates whether the Scope is included in the metadata", + "enum": [ + "ALL_CLIENTS", + "NO_CLIENTS" + ], + "type": "string" + }, + "OAuth2ScopesMediationPolicyRuleCondition": { + "description": "Array of scopes that the condition includes", + "properties": { + "include": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "OAuth2Settings": { + "description": "OAuth 2.0 configuration used for authType `OAUTH2`", + "properties": { + "authorizeEndpoint": { + "description": "The URL to the authorization server's authorization endpoint", + "format": "uri", + "type": "string" + }, + "clientId": { + "description": "The OAuth 2.0 client identifier", + "type": "string" + }, + "clientSecret": { + "description": "The OAuth 2.0 client secret", + "type": "string" + }, + "publicKey": { + "additionalProperties": true, + "description": "The public key in JWK format. Returned when the OAuth authentication method is `PRIVATE_KEY_JWT`.", + "properties": { + "e": { + "description": "RSA public exponent", + "type": "string" + }, + "kid": { + "description": "Key ID", + "type": "string" + }, + "kty": { + "description": "Key type (e.g., `RSA`, `EC`)", + "type": "string" + }, + "n": { + "description": "RSA modulus", + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "scopes": { + "description": "List of OAuth 2.0 scopes", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenEndpoint": { + "description": "The URL to the authorization server's token endpoint", + "format": "uri", + "type": "string" + } + }, + "required": [ + "authorizeEndpoint", + "tokenEndpoint", + "clientId", + "clientSecret" + ], + "type": "object" + }, + "OAuth2Token": { + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "Embedded resources related to the object if the `expand` query parameter is specified", + "readOnly": true, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "clientId": { + "description": "Client ID", + "example": "0oabskvc6442nkvQO0h7", + "readOnly": true, + "type": "string" + }, + "created": { + "$ref": "#/components/schemas/createdProperty" + }, + "expiresAt": { + "description": "Expiration time of the OAuth 2.0 Token", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "ID of the Token object", + "readOnly": true, + "type": "string" + }, + "issuer": { + "description": "The complete URL of the authorization server that issued the Token", + "type": "string" + }, + "lastUpdated": { + "$ref": "#/components/schemas/lastUpdatedProperty" + }, + "scopes": { + "description": "Name of scopes attached to the Token", + "items": { + "type": "string" + }, + "type": "array" + }, + "status": { + "$ref": "#/components/schemas/GrantOrTokenStatus" + }, + "userId": { + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OAuthApplicationCredentials": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationCredentials" + }, + { + "properties": { + "oauthClient": { + "$ref": "#/components/schemas/ApplicationCredentialsOAuthClient" + } + }, + "type": "object" + } + ] + }, + "OAuthAuthorizationEndpoint": { + "description": "Endpoint for an [OAuth 2.0 Authorization Server (AS)](https://tools.ietf.org/html/rfc6749#page-18)", + "properties": { + "binding": { + "$ref": "#/components/schemas/ProtocolEndpointBinding" + }, + "url": { + "description": "URL of the IdP Authorization Server (AS) authorization endpoint", + "example": "https://idp.example.com/authorize", + "type": "string" + } + }, + "type": "object" + }, + "OAuthClientSecretLinks": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of an app using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.", + "properties": { + "activate": { + "$ref": "#/components/schemas/HrefObjectActivateLink" + }, + "deactivate": { + "$ref": "#/components/schemas/HrefObjectDeactivateLink" + }, + "delete": { + "$ref": "#/components/schemas/HrefObjectDeleteLink" + } + }, + "readOnly": true + }, + "OAuthCredentials": { + "description": "Client authentication credentials for an [OAuth 2.0 Authorization Server](https://tools.ietf.org/html/rfc6749#section-2.3)", + "properties": { + "client": { + "$ref": "#/components/schemas/OAuthCredentialsClient" + }, + "signing": { + "$ref": "#/components/schemas/AppleClientSigning" + } + }, + "type": "object" + }, + "OAuthCredentialsClient": { + "description": "OAuth 2.0 and OpenID Connect Client object\n> **Note:** You must complete client registration with the IdP Authorization Server for your Okta IdP instance to obtain client credentials.", + "properties": { + "client_id": { + "description": "The [Unique identifier](https://tools.ietf.org/html/rfc6749#section-2.2) issued by the AS for the Okta IdP instance", + "example": "your-client-id", + "maxLength": 1024, + "type": "string" + }, + "client_secret": { + "description": "The [Client secret](https://tools.ietf.org/html/rfc6749#section-2.3.1) issued by the AS for the Okta IdP instance", + "example": "your-client-secret", + "maxLength": 1024, + "type": "string" + }, + "pkce_required": { + "description": "Require Proof Key for Code Exchange (PKCE) for additional verification", + "type": "boolean" + }, + "token_endpoint_auth_method": { + "description": "Client authentication methods supported by the token endpoint", + "enum": [ + "private_key_jwt" + ], + "type": "string" + } + }, + "type": "object" + }, + "OAuthEndpointAuthenticationMethod": { + "default": "client_secret_basic", + "description": "Requested authentication method for the token endpoint", + "enum": [ + "client_secret_basic", + "client_secret_jwt", + "client_secret_post", + "none", + "private_key_jwt" + ], + "type": "string" + }, + "OAuthEndpoints": { + "description": "The `OAUTH2` and `OIDC` protocols support the `authorization` and `token` endpoints. Also, the `OIDC` protocol supports the `userInfo` and `jwks` endpoints.\n\nThe IdP Authorization Server (AS) endpoints are currently defined as part of the [IdP provider]((https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=type&t=request)) and are read-only.", + "properties": { + "authorization": { + "$ref": "#/components/schemas/OAuthAuthorizationEndpoint" + }, + "jwks": { + "$ref": "#/components/schemas/OidcJwksEndpoint" + }, + "slo": { + "$ref": "#/components/schemas/OidcSloEndpoint" + }, + "token": { + "$ref": "#/components/schemas/OAuthTokenEndpoint" + }, + "userInfo": { + "$ref": "#/components/schemas/OidcUserInfoEndpoint" + } + }, + "type": "object" + }, + "OAuthMetadata": { + "properties": { + "authorization_endpoint": { + "description": "URL of the authorization server's authorization endpoint.", + "type": "string" + }, + "backchannel_authentication_request_signing_alg_values_supported": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>A list of signing algorithms that this authorization server supports for signed requests.", + "items": { + "$ref": "#/components/schemas/SigningAlgorithm" + }, + "type": "array", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "backchannel_token_delivery_modes_supported": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>The delivery modes that this authorization server supports for Client-Initiated Backchannel Authentication.", + "items": { + "$ref": "#/components/schemas/TokenDeliveryMode" + }, + "type": "array", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "claims_supported": { + "description": "A list of the claims supported by this authorization server.", + "items": { + "$ref": "#/components/schemas/Claim" + }, + "type": "array" + }, + "code_challenge_methods_supported": { + "description": "A list of PKCE code challenge methods supported by this authorization server.", + "items": { + "$ref": "#/components/schemas/CodeChallengeMethod" + }, + "type": "array" + }, + "device_authorization_endpoint": { + "type": "string" + }, + "dpop_signing_alg_values_supported": { + "description": "A list of signing algorithms supported by this authorization server for Demonstrating Proof-of-Possession (DPoP) JWTs.", + "items": { + "enum": [ + "ES256", + "ES384", + "ES512", + "RS256", + "RS384", + "RS512" + ], + "type": "string" + }, + "type": "array", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "TOMBSTONE" + } + }, + "end_session_endpoint": { + "description": "URL of the authorization server's logout endpoint.", + "type": "string" + }, + "grant_types_supported": { + "description": "A list of the grant type values that this authorization server supports.", + "items": { + "$ref": "#/components/schemas/GrantType" + }, + "type": "array" + }, + "introspection_endpoint": { + "description": "URL of the authorization server's introspection endpoint.", + "type": "string" + }, + "introspection_endpoint_auth_methods_supported": { + "description": "A list of client authentication methods supported by this introspection endpoint.", + "items": { + "$ref": "#/components/schemas/EndpointAuthMethod" + }, + "type": "array" + }, + "issuer": { + "description": "The authorization server's issuer identifier. In the context of this document, this is your authorization server's base URL. This becomes the `iss` claim in an access token.", + "type": "string" + }, + "jwks_uri": { + "description": "URL of the authorization server's JSON Web Key Set document.", + "type": "string" + }, + "pushed_authorization_request_endpoint": { + "type": "string" + }, + "registration_endpoint": { + "description": "URL of the authorization server's JSON Web Key Set document.", + "type": "string" + }, + "request_object_signing_alg_values_supported": { + "description": "A list of signing algorithms that this authorization server supports for signed requests.", + "items": { + "$ref": "#/components/schemas/SigningAlgorithm" + }, + "type": "array" + }, + "request_parameter_supported": { + "description": "Indicates if Request Parameters are supported by this authorization server.", + "type": "boolean" + }, + "response_modes_supported": { + "description": "A list of the `response_mode` values that this authorization server supports. More information here.", + "items": { + "$ref": "#/components/schemas/ResponseMode" + }, + "type": "array" + }, + "response_types_supported": { + "description": "A list of the `response_type` values that this authorization server supports. Can be a combination of `code`, `token`, and `id_token`.", + "items": { + "$ref": "#/components/schemas/ResponseTypesSupported" + }, + "type": "array" + }, + "revocation_endpoint": { + "description": "URL of the authorization server's revocation endpoint.", + "type": "string" + }, + "revocation_endpoint_auth_methods_supported": { + "description": "A list of client authentication methods supported by this revocation endpoint.", + "items": { + "$ref": "#/components/schemas/EndpointAuthMethod" + }, + "type": "array" + }, + "scopes_supported": { + "description": "A list of the scope values that this authorization server supports.", + "items": { + "$ref": "#/components/schemas/Scope" + }, + "type": "array" + }, + "subject_types_supported": { + "description": "A list of the Subject Identifier types that this authorization server supports. Valid types include `pairwise` and `public`, but only `public` is currently supported. See the [Subject Identifier Types](https://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes) section in the OpenID Connect specification.", + "items": { + "$ref": "#/components/schemas/SubjectType" + }, + "type": "array" + }, + "token_endpoint": { + "description": "URL of the authorization server's token endpoint.", + "type": "string" + }, + "token_endpoint_auth_methods_supported": { + "description": "A list of client authentication methods supported by this token endpoint.", + "items": { + "$ref": "#/components/schemas/EndpointAuthMethod" + }, + "type": "array" + } + }, + "type": "object" + }, + "OAuthProvisioningEnabledApp": { + "description": "Application name for the provisioning connection", + "enum": [ + "google", + "office365", + "slack", + "zoomus" + ], + "type": "string" + }, + "OAuthResourceServerKeyLinks": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of a JSON Web Key using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.", + "properties": { + "activate": { + "$ref": "#/components/schemas/HrefObjectActivateLink" + }, + "delete": { + "$ref": "#/components/schemas/HrefObjectDeleteLink" + } + }, + "readOnly": true + }, + "OAuthResponseType": { + "description": "Array of OAuth 2.0 response type strings", + "enum": [ + "code", + "id_token", + "token" + ], + "type": "string" + }, + "OAuthScopes": { + "description": "IdP-defined permission bundles to request delegated access from the user.\n> **Note:** The [identity provider type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=type&t=request) table lists the scopes that are supported for each IdP.", + "items": { + "example": "public_profile", + "type": "string" + }, + "type": "array" + }, + "OAuthTokenEndpoint": { + "description": "Endpoint for an [OAuth 2.0 Authorization Server (AS)](https://tools.ietf.org/html/rfc6749#page-18)", + "properties": { + "binding": { + "$ref": "#/components/schemas/ProtocolEndpointBinding" + }, + "url": { + "description": "URL of the IdP Authorization Server (AS) token endpoint", + "example": "https://idp.example.com/token", + "type": "string" + } + }, + "type": "object" + }, + "OINApplication": { + "properties": { + "accessibility": { + "$ref": "#/components/schemas/ApplicationAccessibility" + }, + "credentials": { + "$ref": "#/components/schemas/SchemeApplicationCredentials" + }, + "label": { + "$ref": "#/components/schemas/ApplicationLabel" + }, + "licensing": { + "$ref": "#/components/schemas/ApplicationLicensing" + }, + "name": { + "description": "The key name for the OIN app definition", + "type": "string" + }, + "profile": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "Contains any valid JSON schema for specifying properties that can be referenced from a request (only available to OAuth 2.0 client apps)", + "type": "object" + }, + "signOnMode": { + "description": "Authentication mode for the app", + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ApplicationLifecycleStatus" + }, + "visibility": { + "$ref": "#/components/schemas/ApplicationVisibility" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OINSaml11ApplicationSettingsSignOn": { + "description": "Contains SAML 1.1 sign-on mode attributes", + "properties": { + "audienceOverride": { + "description": "Audience override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "type": "string" + }, + "defaultRelayState": { + "description": "Identifies a specific application resource in an IdP-initiated SSO scenario", + "type": "string" + }, + "recipientOverride": { + "description": "Recipient override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "type": "string" + }, + "ssoAcsUrlOverride": { + "description": "Assertion Consumer Service (ACS) URL override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "type": "string" + } + }, + "title": "SAML 1.1 settings", + "type": "object" + }, + "OINSaml20ApplicationSettingsSignOn": { + "description": "Contains SAML 2.0 sign-on mode attributes.\n> **Note:** Set `destinationOverride` to configure any other SAML 2.0 attributes in this section.", + "properties": { + "attributeStatements": { + "description": "A list of custom attribute statements for the app's SAML assertion. See [SAML 2.0 Technical Overview](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.html).\n\nThere are two types of attribute statements:\n| Type | Description |\n| ---- | ----------- |\n| EXPRESSION | Generic attribute statement that can be dynamic and supports [Okta Expression Language](https://developer.okta.com/docs/reference/okta-expression-language/) |\n| GROUP | Group attribute statement |\n", + "items": { + "$ref": "#/components/schemas/SamlAttributeStatement" + }, + "type": "array" + }, + "audienceOverride": { + "description": "Audience override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "nullable": true, + "type": "string" + }, + "defaultRelayState": { + "description": "Identifies a specific application resource in an IdP-initiated SSO scenario", + "nullable": true, + "type": "string" + }, + "destinationOverride": { + "description": "Destination override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "nullable": true, + "type": "string" + }, + "recipientOverride": { + "description": "Recipient override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "nullable": true, + "type": "string" + }, + "samlAssertionLifetimeSeconds": { + "description": "Determines the SAML app session lifetimes with Okta", + "example": 3600, + "type": "integer", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "ssoAcsUrlOverride": { + "description": "Assertion Consumer Service (ACS) URL override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "nullable": true, + "type": "string" + } + }, + "title": "SAML 2.0 settings", + "type": "object" + }, + "OSAccount": { + "discriminator": { + "mapping": { + "MACOS": "#/components/schemas/OSAccountMacOS", + "WINDOWS": "#/components/schemas/OSAccountWindows" + }, + "propertyName": "platform" + }, + "properties": { + "_embedded": { + "$ref": "#/components/schemas/OSAccountEmbedded" + }, + "_links": { + "$ref": "#/components/schemas/OSAccountLinks" + }, + "created": { + "description": "Timestamp when the OS account was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "deviceId": { + "description": "Unique identifier of the device this OS account belongs to", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the OS account", + "readOnly": true, + "type": "string" + }, + "lastSeenAt": { + "description": "Timestamp when the OS account was last seen", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the OS account was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "platform": { + "$ref": "#/components/schemas/OSAccountPlatform" + }, + "resourceAlternateId": { + "nullable": true, + "readOnly": true, + "type": "string" + }, + "resourceDisplayName": { + "$ref": "#/components/schemas/OSAccountDisplayName" + }, + "resourceId": { + "description": "Alternate key for the `id`", + "readOnly": true, + "type": "string" + }, + "resourceType": { + "default": "DOSAccount", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Status of the OS account", + "enum": [ + "ACTIVE", + "DELETED" + ], + "type": "string" + } + }, + "required": [ + "id", + "deviceId", + "created", + "lastUpdated", + "platform", + "status", + "_links" + ], + "type": "object" + }, + "OSAccountDisplayName": { + "description": "Display name of the OS account", + "properties": { + "sensitive": { + "default": false, + "description": "Indicates whether the associated value is Personal Identifiable Information (PII) and requires masking", + "type": "boolean" + }, + "value": { + "description": "Display name of the OS account", + "type": "string" + } + }, + "type": "object" + }, + "OSAccountEmbedded": { + "description": "Embedded resources related to the OS account", + "properties": { + "accountLinkedEnrollments": { + "description": "Enrollments linked to this OS account", + "items": { + "$ref": "#/components/schemas/AccountLinkedEnrollment" + }, + "type": "array" + }, + "users": { + "description": "Users associated with this OS account", + "items": { + "$ref": "#/components/schemas/User" + }, + "type": "array" + } + }, + "type": "object" + }, + "OSAccountLinks": { + "properties": { + "device": { + "$ref": "#/components/schemas/HrefObject" + }, + "self": { + "$ref": "#/components/schemas/HrefObject" + } + }, + "type": "object" + }, + "OSAccountMacOS": { + "allOf": [ + { + "$ref": "#/components/schemas/OSAccount" + }, + { + "properties": { + "profile": { + "$ref": "#/components/schemas/MacOSAccountProfile" + } + }, + "required": [ + "profile" + ], + "type": "object" + } + ] + }, + "OSAccountPlatform": { + "description": "OS platform for OS accounts (desktop platforms only)", + "enum": [ + "MACOS", + "WINDOWS" + ], + "type": "string", + "x-enumDescriptions": { + "MACOS": "macOS operating system", + "WINDOWS": "Windows operating system" + } + }, + "OSAccountWindows": { + "allOf": [ + { + "$ref": "#/components/schemas/OSAccount" + }, + { + "properties": { + "profile": { + "$ref": "#/components/schemas/WindowsOSAccountProfile" + } + }, + "required": [ + "profile" + ], + "type": "object" + } + ] + }, + "OSVersion": { + "description": "Specifies the OS requirement for the policy.\n\nThere are two types of OS requirements:\n\n* **Static**: A specific OS version requirement that doesn't change until you update the policy. A static OS requirement is specified with the `osVersion.minimum` property.\n* **Dynamic**: An OS version requirement that is relative to the latest major OS release and security patch. A dynamic OS requirement is specified with the `osVersion.dynamicVersionRequirement` property.\n> **Note:** Dynamic OS requirements are available only if the **Dynamic OS version compliance** [self-service EA](/openapi/okta-management/guides/release-lifecycle/#early-access-ea) feature is enabled. You can't specify both `osVersion.minimum` and `osVersion.dynamicVersionRequirement` properties at the same time.\n", + "properties": { + "dynamicVersionRequirement": { + "description": "Contains the necessary properties for a dynamic version requirement", + "properties": { + "distanceFromLatestMajor": { + "description": "Indicates the distance from the latest major version", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "latestSecurityPatch": { + "description": "Indicates whether the device needs to be on the latest security patch", + "type": "boolean" + }, + "type": { + "description": "Indicates the type of the dynamic OS version requirement", + "enum": [ + "MINIMUM", + "EXACT", + "EXACT_ANY_SUPPORTED" + ], + "type": "string", + "x-enumDescriptions": { + "EXACT": "The device version must be on the same major version as the dynamically determined version. `distanceFromLatestMajor` must be specified for this type.", + "EXACT_ANY_SUPPORTED": "The device version must be on a major version which is supported. You can't specify `distanceFromLatestMajor` for this type.", + "MINIMUM": "The device version must be equal to or newer than the dynamically determined version. `distanceFromLatestMajor` must be specified for this type." + } + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "minimum": { + "description": "The device version must be equal to or newer than the specified version string (maximum of three components for iOS and macOS, and maximum of four components for Android)", + "example": "12.4.5", + "type": "string" + } + }, + "type": "object" + }, + "OSVersionConstraint": { + "properties": { + "dynamicVersionRequirement": { + "description": "Contains the necessary properties for a dynamic Windows version requirement", + "properties": { + "distanceFromLatestMajor": { + "description": "Indicates the distance from the latest Windows major version", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "latestSecurityPatch": { + "description": "Indicates whether the policy requires Windows devices to be on the latest security patch", + "type": "boolean" + }, + "type": { + "description": "Indicates the type of the dynamic Windows version requirement", + "enum": [ + "MINIMUM", + "EXACT", + "EXACT_ANY_SUPPORTED", + "NOT_ALLOWED" + ], + "type": "string", + "x-enumDescriptions": { + "EXACT": "The device version must be on the same major version as the dynamically determined Windows version. `distanceFromLatestMajor` must be specified for this type.", + "EXACT_ANY_SUPPORTED": "The device version must be on a Windows major version which is supported. You can't specify `distanceFromLatestMajor` for this type.", + "MINIMUM": "The device version must be equal to or newer than the dynamically determined Windows version. `distanceFromLatestMajor` must be specified for this type.", + "NOT_ALLOWED": "The device version isn't allowed. You can't specify `distanceFromLatestMajor` or `latestSecurityPatch` for this type." + } + } + }, + "type": "object" + }, + "majorVersionConstraint": { + "description": "Indicates the Windows major version", + "enum": [ + "WINDOWS_11", + "WINDOWS_10" + ], + "type": "string", + "x-enumDescriptions": { + "WINDOWS_10": "The device is on Windows 10 or an older Windows version", + "WINDOWS_11": "The device is on Windows 11" + } + }, + "minimum": { + "description": "The Windows device version must be equal to or newer than the specified version", + "example": "12.4.5.9", + "type": "string" + } + }, + "required": [ + "majorVersionConstraint" + ], + "type": "object" + }, + "OSVersionFourComponents": { + "description": "Current version of the operating system (maximum of four components in the versioning scheme)", + "properties": { + "minimum": { + "example": "12.4.5.9", + "type": "string" + } + }, + "type": "object" + }, + "OSVersionThreeComponents": { + "description": "Current version of the operating system (maximum of three components in the versioning scheme)", + "properties": { + "minimum": { + "example": "12.4.5", + "type": "string" + } + }, + "type": "object" + }, + "Office365Application": { + "allOf": [ + { + "$ref": "#/components/schemas/OINApplication" + }, + { + "type": "object" + }, + { + "properties": { + "name": { + "enum": [ + "office365" + ], + "example": "office365", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/Office365ApplicationSettings" + }, + "signOnMode": { + "enum": [ + "BROWSER_PLUGIN", + "SAML_1_1" + ], + "example": "BROWSER_PLUGIN", + "type": "string" + } + }, + "required": [ + "name", + "label", + "settings" + ] + } + ], + "description": "Schema for the Microsoft Office 365 app (key name: `office365`)\n\nTo create a Microsoft Office 365 app, use the [Create an Application](/openapi/okta-management/management/tags/application/other/createapplication) request with the following parameters in the request body.\n> **Note:** The Office 365 app only supports `BROWSER_PLUGIN` and `SAML_1_1` sign-on modes.\n", + "example": { + "label": "Sample Office365 App", + "name": "office365", + "settings": { + "app": { + "domain": "myintegration.okta365test.net", + "msftTenant": "mycompanyinc" + } + }, + "signOnMode": "SAML_1_1" + }, + "title": "Microsoft Office 365", + "x-okta-defined-as": { + "name": "office365" + }, + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-tags": [ + "Application" + ] + }, + "Office365ApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "type": "object" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/Office365ApplicationSettingsApplication" + }, + "signOn": { + "$ref": "#/components/schemas/OINSaml11ApplicationSettingsSignOn" + } + }, + "required": [ + "app" + ] + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "Office365ApplicationSettingsApplication": { + "description": "Office365 app instance properties", + "properties": { + "domain": { + "description": "The domain for your Office 365 account", + "type": "string" + }, + "msftTenant": { + "description": "Microsoft tenant name", + "type": "string" + } + }, + "required": [ + "msftTenant", + "domain" + ], + "type": "object" + }, + "Office365ProvisioningSettings": { + "description": "Settings required for the Microsoft Office 365 provisioning connection", + "properties": { + "adminPassword": { + "description": "Microsoft Office 365 global administrator password", + "type": "string" + }, + "adminUsername": { + "description": "Microsoft Office 365 global administrator username", + "type": "string" + } + }, + "required": [ + "adminUsername", + "adminPassword" + ], + "title": "Microsoft Office 365 provisioning settings", + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "OfflineAccessScopeResourceHrefObject": { + "properties": { + "href": { + "description": "Link URI", + "example": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scppb56cIl4GvGxy70g3", + "type": "string" + }, + "title": { + "description": "Link name", + "example": "offline_access", + "type": "string" + } + }, + "type": "object" + }, + "Oidc": { + "description": "OIDC configuration details", + "properties": { + "doc": { + "description": "The URL to your customer-facing instructions for configuring your OIDC integration. See [Customer configuration document guidelines](https://developer.okta.com/docs/guides/submit-app-prereq/main/#customer-configuration-document-guidelines).", + "example": "https://example.com/strawberry/help/oidcSetup", + "format": "uri", + "type": "string" + }, + "initiateLoginUri": { + "description": "The URL to redirect users when they click on your app from their Okta End-User Dashboard", + "example": "https://{app.subdomain}.example.com/strawberry/oidc/sp-init", + "format": "uri", + "type": "string" + }, + "postLogoutUris": { + "description": "The sign-out redirect URIs for your app. You can send a request to `/v1/logout` to sign the user out and redirect them to one of these URIs.", + "items": { + "description": "A sign-out redirect URI. You can use the app-level properties you defined in the `config` array as variables in your URI. For example: `https://{app.subdomain}.example.com/strawberry/oidc/logged-out`", + "example": "https://{app.subdomain}.example.com/strawberry/oidc/logged-out", + "format": "uri", + "type": "string" + }, + "type": "array" + }, + "redirectUris": { + "description": "List of sign-in redirect URIs", + "items": { + "description": "Sign-in redirect URI", + "example": "https://{app.subdomain}.example.com/strawberry/oidc/login", + "format": "uri", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "redirectUris", + "doc" + ], + "type": "object" + }, + "OidcAlgorithms": { + "properties": { + "request": { + "$ref": "#/components/schemas/OidcRequestAlgorithm" + } + }, + "type": "object" + }, + "OidcIssuer": { + "description": "OIDC issuer identifier (issuer URL / expected `iss` value) for the external IdP", + "properties": { + "url": { + "description": "Issuer URL identifying the external IdP (the expected `iss` value in OIDC tokens)", + "example": "https://idp.example.com", + "type": "string" + } + }, + "type": "object" + }, + "OidcJwksEndpoint": { + "description": "Endpoint for the JSON Web Key Set (JWKS) document. This document contains signing keys that are used to validate the signatures from the provider. For more information on JWKS, see [JSON Web Key](https://tools.ietf.org/html/rfc7517).", + "properties": { + "binding": { + "$ref": "#/components/schemas/ProtocolEndpointBinding" + }, + "url": { + "description": "URL of the endpoint to the JWK Set", + "example": "https://idp.example.com/keys", + "type": "string" + } + }, + "type": "object" + }, + "OidcRequestAlgorithm": { + "description": "Algorithm settings used to sign an authorization request", + "properties": { + "signature": { + "$ref": "#/components/schemas/OidcRequestSignatureAlgorithm" + } + }, + "type": "object" + }, + "OidcRequestSignatureAlgorithm": { + "description": "Signature Algorithm settings for signing authorization requests sent to the IdP\n> **Note:** The `algorithm` property is ignored when you disable request signatures (`scope` set as `NONE`).", + "properties": { + "algorithm": { + "$ref": "#/components/schemas/OidcSigningAlgorithm" + }, + "scope": { + "$ref": "#/components/schemas/ProtocolAlgorithmRequestScope" + } + }, + "type": "object" + }, + "OidcSettings": { + "description": "Advanced settings for the OpenID Connect protocol", + "properties": { + "participateSlo": { + "description": "Set to `true` to have Okta send a logout request to the upstream IdP when a user signs out of Okta or a downstream app.", + "type": "boolean" + }, + "sendApplicationContext": { + "default": false, + "description": "Determines if the IdP should send the application context as `OktaAppInstanceId` and `OktaAppName` params in the request", + "type": "boolean" + } + }, + "type": "object" + }, + "OidcSigningAlgorithm": { + "enum": [ + "HS256", + "HS384", + "HS512", + "RS256", + "RS384", + "RS512" + ], + "type": "string" + }, + "OidcSloEndpoint": { + "description": "OIDC IdP logout endpoint", + "properties": { + "url": { + "description": "IdP logout endpoint URL", + "example": "https://idp.example.com/saml2/slo", + "maxLength": 1014, + "type": "string" + } + }, + "type": "object" + }, + "OidcUserInfoEndpoint": { + "description": "Endpoint for getting identity information about the user. For more information on the `/userinfo` endpoint, see [OpenID Connect](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo).", + "properties": { + "binding": { + "$ref": "#/components/schemas/ProtocolEndpointBinding" + }, + "url": { + "description": "URL of the resource server's `/userinfo` endpoint", + "example": "https://idp.example.com/userinfo", + "type": "string" + } + }, + "type": "object" + }, + "OktaActiveDirectoryGroupProfile": { + "description": "Profile for a group that is imported from Active Directory.\n\nThe `objectClass` for such groups is `okta:windows_security_principal`.\n\nYou can extend group profiles with custom properties, but you must first add the properties to the group profile schema before you can reference them. Use the Profile Editor in the Admin Console or the [Schemas API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/) to manage schema extensions.\n\nCustom properties can contain HTML tags. It is the client's responsibility to escape or encode this data before displaying it. Use [best-practices](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html) to prevent cross-site scripting.", + "properties": { + "description": { + "description": "Description of the Windows group", + "example": "All users in the engineering department", + "type": "string" + }, + "dn": { + "description": "The distinguished name of the Windows group", + "example": "CN=West Coast users,OU=West Coast,DC=example,DC=com", + "type": "string" + }, + "externalId": { + "description": "Base-64 encoded GUID (`objectGUID`) of the Windows group", + "example": "VKzYZ1C+IkSZxIWlrW5ITg==", + "type": "string" + }, + "name": { + "description": "Name of the Windows group", + "example": "West Coast users", + "type": "string" + }, + "samAccountName": { + "description": "Pre-Windows 2000 name of the Windows group", + "example": "West Coast users", + "type": "string" + }, + "windowsDomainQualifiedName": { + "description": "Fully qualified name of the Windows group", + "example": "EXAMPLE\\\\West Coast users", + "type": "string" + } + }, + "type": "object" + }, + "OktaDeviceRiskChangeEvent": { + "description": "The device risk level changed", + "properties": { + "current_level": { + "description": "Current risk level of the device", + "enum": [ + "low", + "medium", + "high", + "secure", + "none" + ], + "example": "low", + "type": "string" + }, + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "initiating_entity": { + "description": "The entity that initiated the event", + "enum": [ + "admin", + "user", + "policy", + "system" + ], + "type": "string" + }, + "previous_level": { + "description": "Previous risk level of the device", + "enum": [ + "low", + "medium", + "high", + "secure", + "none" + ], + "example": "medium", + "type": "string" + }, + "reason_admin": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized administrative message intended for logging and auditing.<br>Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "reason_user": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized message intended for the end user.<br>Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "subject": { + "$ref": "#/components/schemas/SecurityEventSubject" + } + }, + "required": [ + "event_timestamp", + "subject", + "current_level", + "previous_level" + ], + "type": "object" + }, + "OktaIpChangeEvent": { + "description": "IP changed for the subject's session", + "properties": { + "current_ip_address": { + "description": "Current IP address of the subject", + "example": "123.4.5.6", + "type": "string" + }, + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "initiating_entity": { + "description": "The entity that initiated the event", + "enum": [ + "admin", + "user", + "policy", + "system" + ], + "type": "string" + }, + "previous_ip_address": { + "description": "Previous IP address of the subject", + "example": "123.45.67.8", + "type": "string" + }, + "reason_admin": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized administrative message intended for logging and auditing.<br>Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "reason_user": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized message intended for the end user.<br>Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "subject": { + "$ref": "#/components/schemas/SecurityEventSubject" + } + }, + "required": [ + "event_timestamp", + "subject", + "current_ip_address", + "previous_ip_address" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OktaManagedUserAccountForUpdate": { + "description": "Request body for updating an Okta managed user account", + "properties": { + "description": { + "description": "The description of the Okta managed user account", + "example": "Updated description for AD integrations admin account", + "format": "regex", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The user-defined name for the Okta managed user account", + "example": "AD Integrations Admin - Updated", + "format": "regex", + "maxLength": 50, + "minLength": 1, + "pattern": "^[\\w\\-_. ]+$", + "type": "string" + }, + "ownerGroupIds": { + "description": "A list of IDs of the Okta groups who own the Okta managed user account", + "example": [ + "00g57qp78yZT2XBA40g7" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ownerUserIds": { + "description": "A list of IDs of the Okta users who own the Okta managed user account", + "example": [ + "00u11s48P9zGW8yqm0g5" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "OktaManagedUserAccountRequest": { + "description": "Request body for creating an Okta managed user account", + "properties": { + "description": { + "description": "The description of the Okta managed user account", + "example": "Shared admin account for managing AD integrations", + "format": "regex", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The user-defined name for the Okta managed user account", + "example": "AD Integrations Admin", + "format": "regex", + "maxLength": 50, + "minLength": 1, + "pattern": "^[\\w\\-_. ]+$", + "type": "string" + }, + "oktaUserId": { + "description": "The ID of the Okta user to manage as a service account. \nThis must be an existing user in your Okta org.", + "example": "00u11s48P9zGW8yqm0g5", + "maxLength": 20, + "minLength": 20, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ownerGroupIds": { + "description": "A list of IDs of the Okta groups who own the Okta managed user account", + "example": [ + "00g57qp78yZT2XBA40g7" + ], + "items": { + "maxLength": 20, + "minLength": 20, + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ownerUserIds": { + "description": "A list of IDs of the Okta users who own the Okta managed user account", + "example": [ + "00u11s48P9zGW8yqm0g5" + ], + "items": { + "maxLength": 20, + "minLength": 20, + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "name", + "oktaUserId" + ], + "type": "object" + }, + "OktaManagedUserAccountResponse": { + "description": "An Okta managed user account representing a Universal Directory user managed as a service account", + "properties": { + "created": { + "description": "Timestamp when the Okta managed user account was created", + "example": "2023-04-04T15:56:05.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the Okta managed user account", + "example": "Shared admin account for managing AD integrations", + "format": "regex", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email": { + "description": "The email address associated with the Okta user. This parameter is read-only, and it is derived from the Okta user profile.", + "example": "foo@bar.com", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The UUID of the Okta managed user account", + "example": "d1b65a78-21ed-429b-8ea3-eec96f2748d6", + "format": "regex", + "pattern": "(?i)^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the Okta managed user account was last updated", + "example": "2023-05-05T18:15:44.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The user-defined name for the Okta managed user account", + "example": "AD Integrations Admin", + "format": "regex", + "maxLength": 50, + "minLength": 1, + "pattern": "^[\\w\\-_. ]+$", + "type": "string" + }, + "oktaUserId": { + "description": "The ID of the Okta user being managed as a service account", + "example": "00u11s48P9zGW8yqm0g5", + "maxLength": 20, + "minLength": 20, + "type": "string" + }, + "ownerGroupIds": { + "description": "A list of IDs of the Okta groups who own the Okta managed user account", + "example": [ + "00g57qp78yZT2XBA40g7" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ownerUserIds": { + "description": "A list of IDs of the Okta users who own the Okta managed user account", + "example": [ + "00u11s48P9zGW8yqm0g5" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "status": { + "$ref": "#/components/schemas/ServiceAccountStatus" + }, + "statusDetail": { + "$ref": "#/components/schemas/ServiceAccountStatusDetail" + }, + "username": { + "description": "The username associated with the Okta user. This parameter is read-only, and it is derived from the Okta user profile.", + "example": "shr-ad-admin-01@example.com", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "id", + "name", + "oktaUserId", + "username", + "email" + ], + "type": "object" + }, + "OktaPersonalAdminFeatureSettings": { + "description": "Defines a list of Okta Personal settings that can be enabled or disabled for the org", + "properties": { + "enableEnduserEntryPoints": { + "description": "Allow entry points for an Okta Personal account in a Workforce org", + "type": "boolean" + }, + "enableExportApps": { + "description": "Allow users to migrate apps from a Workforce account to an Okta Personal account", + "type": "boolean" + } + }, + "type": "object" + }, + "OktaSignOnPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "conditions": { + "$ref": "#/components/schemas/OktaSignOnPolicyConditions" + } + }, + "type": "object" + } + ] + }, + "OktaSignOnPolicyConditions": { + "allOf": [ + { + "type": "object" + }, + { + "description": "Specifies the conditions that must be met during policy evaluation to apply the policy", + "properties": { + "people": { + "description": "Identifies users and groups that are used together", + "properties": { + "groups": { + "description": "Specifies a set of groups whose users are to be included or excluded", + "properties": { + "include": { + "description": "Groups to be included", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OktaSignOnPolicyFactorPromptMode": { + "description": "Indicates if the user is challenged for a second factor (MFA) based on the device used, a factor session lifetime expiration, or on every sign-in attempt.\n\nIf the [Behavior](https://help.okta.com/okta_help.htm?type=oie&id=behavior-detection-type) of the global session policy includes the **New Device** behavior type, then `requireFactor` must be `false` or `factorPromptMode` must be `ALWAYS`.\n\n> **Note:** Required only if `requireFactor` is set to `true`.\n", + "enum": [ + "ALWAYS", + "DEVICE", + "SESSION" + ], + "type": "string" + }, + "OktaSignOnPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "$ref": "#/components/schemas/OktaSignOnPolicyRuleActions" + }, + "conditions": { + "$ref": "#/components/schemas/OktaSignOnPolicyRuleConditions" + } + }, + "type": "object" + } + ] + }, + "OktaSignOnPolicyRuleActions": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRuleActions" + }, + { + "type": "object" + }, + { + "description": "Specifies how users are allowed to sign in to Okta", + "properties": { + "signon": { + "$ref": "#/components/schemas/OktaSignOnPolicyRuleSignonActions" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OktaSignOnPolicyRuleConditions": { + "allOf": [ + { + "type": "object" + }, + { + "description": "Specifies conditions that must be met during policy evaluation to apply the rule. All policy conditions and conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule.", + "properties": { + "authContext": { + "$ref": "#/components/schemas/PolicyRuleAuthContextCondition" + }, + "identityProvider": { + "$ref": "#/components/schemas/IdentityProviderPolicyRuleCondition" + }, + "network": { + "$ref": "#/components/schemas/PolicyNetworkCondition" + }, + "people": { + "$ref": "#/components/schemas/PolicyPeopleCondition" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OktaSignOnPolicyRuleSignonActions": { + "description": "Specifies settings for the policy rule", + "properties": { + "access": { + "description": "Indicates if a user is allowed to sign in", + "enum": [ + "ALLOW", + "DENY" + ], + "type": "string" + }, + "factorLifetime": { + "description": "Interval of time that must elapse before the user is challenged for MFA, if the factor prompt mode is set to `SESSION`\n\n> **Note:** Required only if `requireFactor` is `true`.\n", + "type": "integer" + }, + "factorPromptMode": { + "$ref": "#/components/schemas/OktaSignOnPolicyFactorPromptMode" + }, + "primaryFactor": { + "$ref": "#/components/schemas/OktaSignOnPolicyRuleSignonPrimaryFactor" + }, + "rememberDeviceByDefault": { + "default": false, + "description": "Indicates if Okta should automatically remember the device", + "type": "boolean" + }, + "requireFactor": { + "default": false, + "description": "Indicates if multifactor authentication is required", + "type": "boolean" + }, + "session": { + "$ref": "#/components/schemas/OktaSignOnPolicyRuleSignonSessionActions" + } + }, + "type": "object" + }, + "OktaSignOnPolicyRuleSignonPrimaryFactor": { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle> Indicates the primary factor used to establish a session for the org. Supported values: `PASSWORD_IDP_ANY_FACTOR` (users can use any factor required by the app's app sign-in policy to establish a session), `PASSWORD_IDP` (users must always use a password to establish a session).\n\n> **Note:** Required only if `access` is set to `ALLOW`.", + "enum": [ + "PASSWORD_IDP", + "PASSWORD_IDP_ANY_FACTOR" + ], + "type": "string" + }, + "OktaSignOnPolicyRuleSignonSessionActions": { + "description": "Properties governing the user's session lifetime", + "properties": { + "maxSessionIdleMinutes": { + "default": 120, + "description": "Maximum number of minutes that a user session can be idle before the session is ended", + "type": "integer" + }, + "maxSessionLifetimeMinutes": { + "default": 0, + "description": "Maximum number of minutes (from when the user signs in) that a user's session is active. Set this to force users to sign in again after the number of specified minutes. Disable by setting to `0`.", + "type": "integer" + }, + "usePersistentCookie": { + "default": false, + "description": "If set to `false`, user session cookies only last the length of a browser session. If set to `true`, user session cookies last across browser sessions. This setting doesn't impact administrators who can never have persistent session cookies. This property is read-only for the default rule of the default global session policy.", + "type": "boolean" + } + }, + "type": "object" + }, + "OktaSupportAccessStatus": { + "description": "Status of Okta Support access", + "enum": [ + "DISABLED", + "ENABLED", + "NOT_REQUESTED", + "REQUESTED" + ], + "type": "string", + "x-enumDescriptions": { + "DISABLED": "Okta Support access disabled", + "ENABLED": "Okta Support access enabled", + "NOT_REQUESTED": "Okta Support access not requested", + "REQUESTED": "Okta Support access requested" + } + }, + "OktaSupportCase": { + "properties": { + "caseNumber": { + "description": "Okta Support case number", + "readOnly": true, + "type": "string" + }, + "impersonation": { + "description": "Allows the Okta Support team to sign in to your org as an admin and troubleshoot issues", + "properties": { + "expiration": { + "description": "Expiration date of Okta Support access", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/OktaSupportAccessStatus" + } + }, + "type": "object" + }, + "selfAssigned": { + "description": "Customer allows Okta Support access to self-assigned cases. Support cases are self-assigned when an Okta Support team member creates and assigns the case to themselves.", + "properties": { + "status": { + "$ref": "#/components/schemas/SelfAssignedStatus" + } + }, + "type": "object" + }, + "subject": { + "description": "Subject of the support case", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "OktaSupportCases": { + "properties": { + "supportCases": { + "items": { + "$ref": "#/components/schemas/OktaSupportCase" + }, + "type": "array" + } + }, + "type": "object" + }, + "OktaUserGroupProfile": { + "description": "Profile for any group that is not imported from Active Directory. Specifies the standard\nand custom profile properties for a group.\n\nThe `objectClass` for these groups is `okta:user_group`.\n\nYou can extend group profiles with custom properties, but you must first add the properties to the group profile schema before you can reference them. Use the Profile Editor in the Admin Console or the [Schemas API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/) to manage schema extensions.\n\nCustom properties can contain HTML tags. It is the client's responsibility to escape or encode this data before displaying it. Use [best-practices](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html) to prevent cross-site scripting.", + "properties": { + "description": { + "description": "Description of the group", + "example": "All users West of The Rockies", + "type": "string" + }, + "name": { + "description": "Name of the group", + "example": "West Coast users", + "type": "string" + } + }, + "type": "object", + "x-okta-extensible": true + }, + "OktaUserRiskChangeEvent": { + "description": "The user risk level changed", + "properties": { + "current_level": { + "description": "Current risk level of the user", + "enum": [ + "low", + "medium", + "high", + "secure", + "none" + ], + "example": "low", + "type": "string" + }, + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "initiating_entity": { + "description": "The entity that initiated the event", + "enum": [ + "admin", + "user", + "policy", + "system" + ], + "type": "string" + }, + "previous_level": { + "description": "Previous risk level of the user", + "enum": [ + "low", + "medium", + "high", + "secure", + "none" + ], + "example": "medium", + "type": "string" + }, + "reason_admin": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized administrative message intended for logging and auditing.<br>Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "reason_user": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized message intended for the end user.<br>Either `reason_admin` or `reason_user` is required.", + "type": "object" + } + ] + }, + "subject": { + "$ref": "#/components/schemas/SecurityEventSubject" + } + }, + "required": [ + "event_timestamp", + "subject", + "current_level", + "previous_level" + ], + "type": "object" + }, + "OktaUserServiceAccountCredentials": { + "description": "Credentials for an Okta user", + "properties": { + "username": { + "description": "The username associated with the service account", + "example": "testuser@example.com", + "maxLength": 100, + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "OktaVerifyPayload": { + "description": "Payload data for the OktaVerify provider", + "properties": { + "clientVersion": { + "description": "The version of the Okta Verify client", + "example": "7.0", + "type": "string" + } + }, + "type": "object" + }, + "OpenIdConnectApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/Application" + }, + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/OAuthApplicationCredentials" + }, + "name": { + "description": "`oidc_client` is the key name for an OAuth 2.0 client app instance", + "enum": [ + "oidc_client" + ], + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/OpenIdConnectApplicationSettings" + } + }, + "required": [ + "name", + "settings", + "credentials" + ], + "type": "object" + } + ], + "x-okta-defined-as": { + "name": "oidc_client" + } + }, + "OpenIdConnectApplicationConsentMethod": { + "default": "TRUSTED", + "description": "Indicates whether user consent is required or implicit.\nA consent dialog appears for the end user depending on the values of three elements:\n\n* [prompt](/openapi/okta-oauth/oauth/orgas/authorize#orgas/authorize/t=request&in=query&path=prompt): A query parameter that is used in requests to `/authorize`\n* `consent_method` (this property)\n* [consent](/openapi/okta-management/management/authorizationserverscopes/createoauth2scope#authorizationserverscopes/createoauth2scope/t=request&path=consent): A [Scope](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/AuthorizationServerScopes/) property that allows you to enable or disable user consent for an individual scope\n\n| `prompt` | `consent_method` | `consent` | Result\n| ---------- | ----------- | ---------- | ----------- |\n| CONSENT | TRUSTED or REQUIRED | REQUIRED | Prompted |\n| CONSENT | TRUSTED or REQUIRED | FLEXIBLE | Prompted |\n| CONSENT | TRUSTED | IMPLICIT | Not prompted |\n| NONE | TRUSTED | FLEXIBLE, IMPLICIT, or REQUIRED | Not prompted |\n| NONE | REQUIRED | FLEXIBLE or REQUIRED | Prompted |\n| NONE | REQUIRED | IMPLICIT | Not prompted |\n\n> **Notes:**\n> * If you request a scope that requires consent while using the `client_credentials` flow, an error is returned because the flow doesn't support user consent.\n> * If the `prompt` value is set to `NONE`, but the `consent_method` and the consent values are set to `REQUIRED`, then an error occurs.\n> * When a scope is requested during a Client Credentials grant flow and `consent` is set to `FLEXIBLE`, the scope is granted in the access token with no consent prompt. This occurs because there is no user involved in a two-legged OAuth 2.0 [Client Credentials](https://developer.okta.com/docs/guides/implement-grant-type/clientcreds/main/) grant flow.\n", + "enum": [ + "REQUIRED", + "TRUSTED" + ], + "type": "string", + "x-enumDescriptions": { + "REQUIRED": "The client requires consent (for example, a third-party app). The default consent method for app instances created with a [Create a Client Application](/openapi/okta-oauth/oauth/client/createclient) request", + "TRUSTED": "The client is fully trusted (for example, a first-party app). The default consent method for app instances created with a [Create an Application](/openapi/okta-management/management/tags/application/other/createapplication) request" + } + }, + "OpenIdConnectApplicationIdpInitiatedLogin": { + "description": "The type of IdP-initiated sign-in flow that the client supports", + "properties": { + "default_scope": { + "description": "The scopes to use for the request when `mode` is `OKTA`", + "items": { + "type": "string" + }, + "type": "array" + }, + "mode": { + "description": "The mode to use for the IdP-initiated sign-in flow. For `OKTA` or `SPEC` modes, the client must have an `initiate_login_uri` registered.\n> **Note:** For web and SPA apps, if the mode is `SPEC` or `OKTA`, you must set `grant_types` to `authorization_code`, `implicit`, or `interaction_code`.\n", + "enum": [ + "DISABLED", + "SPEC", + "OKTA" + ], + "type": "string", + "x-enumDescriptions": { + "DISABLED": "The client doesn't support the IdP-initiated sign-in flow.", + "OKTA": "Tokens are directly sent to the Relying Party. This corresponds to the **Okta Simplified** option in the Admin Console.", + "SPEC": "The client is redirected to the Relying Party's `initiate_login_uri`." + } + } + }, + "required": [ + "mode" + ], + "type": "object" + }, + "OpenIdConnectApplicationIssuerMode": { + "description": "Indicates whether the Okta authorization server uses the original Okta org domain URL or a custom domain URL as the issuer of the ID token for this client", + "enum": [ + "CUSTOM_URL", + "DYNAMIC", + "ORG_URL" + ], + "type": "string", + "x-enumDescriptions": { + "CUSTOM_URL": "The issuer is returned in the appropriate OIDC token response. This is the default `issuer_mode` when you configured a custom domain for your org.", + "DYNAMIC": "A request for the ID token made from the custom domain has the custom URL as the issuer. A request for the ID token made from an Okta org has the Org URL as the issuer. You can only set `issuer_mode` as DYNAMIC if the Dynamic Issuer Mode feature is enabled. Contact Okta Support to enable this feature.", + "ORG_URL": "The issuer is returned based on the URL of your Okta organization. This is useful when you are using Okta\u2019s default domain and do not have a custom domain configured." + } + }, + "OpenIdConnectApplicationNetwork": { + "description": "The network restrictions of the client", + "properties": { + "connection": { + "description": "The connection type of the network. Can be `ANYWHERE` or `ZONE`.\n", + "enum": [ + "ANYWHERE", + "ZONE" + ], + "type": "string", + "x-enumDescriptions": { + "ANYWHERE": "There is no restrictions on network zones.", + "ZONE": "There are network restrictions on network zones. Zones are specified in the `include` or `exclude` array." + } + }, + "exclude": { + "description": "If `ZONE` is specified as a connection, then specify the excluded IP network zones here. Value can be \"ALL_IP_ZONES\" or an array of zone IDs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "include": { + "description": "If `ZONE` is specified as a connection, then specify the included IP network zones here. Value can be \"ALL_IP_ZONES\" or an array of zone IDs.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "connection" + ], + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "OpenIdConnectApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "properties": { + "oauthClient": { + "$ref": "#/components/schemas/OpenIdConnectApplicationSettingsClient" + } + }, + "type": "object" + } + ] + }, + "OpenIdConnectApplicationSettingsClient": { + "properties": { + "application_type": { + "$ref": "#/components/schemas/OpenIdConnectApplicationType" + }, + "backchannel_authentication_request_signing_alg": { + "description": "The signing algorithm for Client-Initiated Backchannel Authentication (CIBA) signed requests using JWT. If this value isn't set and a JWT-signed request is sent, the request fails.\n> **Note:** This property appears for clients with `urn:openid:params:grant-type:ciba` defined as one of the `grant_types`.\n", + "enum": [ + "HS256", + "HS384", + "HS512", + "RS256", + "RS384", + "RS512", + "ES256", + "ES384", + "ES512" + ], + "type": "string" + }, + "backchannel_custom_authenticator_id": { + "description": "The ID of the custom authenticator that authenticates the user\n> **Note:** This property appears for clients with `urn:openid:params:grant-type:ciba` defined as one of the `grant_types`.\n", + "maxLength": 20, + "minLength": 20, + "type": "string" + }, + "backchannel_token_delivery_mode": { + "description": "The delivery mode for Client-Initiated Backchannel Authentication (CIBA). Currently, only `poll` is supported.\n> **Note:** This property appears for clients with `urn:openid:params:grant-type:ciba` defined as one of the `grant_types`.\n", + "enum": [ + "poll", + "ping", + "push" + ], + "type": "string" + }, + "client_uri": { + "description": "URL string of a web page providing information about the client", + "maxLength": 1024, + "type": "string" + }, + "consent_method": { + "$ref": "#/components/schemas/OpenIdConnectApplicationConsentMethod" + }, + "dpop_bound_access_tokens": { + "default": false, + "description": "Indicates that the client application uses Demonstrating Proof-of-Possession (DPoP) for token requests. If `true`, the authorization server rejects token requests from this client that don't contain the DPoP header.\n> **Note:** If `dpop_bound_access_tokens` is true, then `client_credentials` and `implicit` aren't allowed in `grant_types`.\n", + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "TOMBSTONE" + } + }, + "frontchannel_logout_session_required": { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Determines whether Okta sends `sid` and `iss` in the logout request", + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "frontchannel_logout_uri": { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>URL where Okta sends the logout request", + "maxLength": 1024, + "type": "string", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "grant_types": { + "items": { + "$ref": "#/components/schemas/GrantType" + }, + "type": "array" + }, + "id_token_encrypted_response_alg": { + "$ref": "#/components/schemas/IdTokenKeyEncryptionAlgorithm" + }, + "idp_initiated_login": { + "$ref": "#/components/schemas/OpenIdConnectApplicationIdpInitiatedLogin" + }, + "initiate_login_uri": { + "description": "URL string that a third party can use to initiate the sign-in flow by the client", + "type": "string" + }, + "issuer_mode": { + "$ref": "#/components/schemas/OpenIdConnectApplicationIssuerMode" + }, + "jwks": { + "$ref": "#/components/schemas/OpenIdConnectApplicationSettingsClientKeys" + }, + "jwks_uri": { + "description": "URL string that references a JSON Web Key Set for validating JWTs presented to Okta or for encrypting ID tokens minted by Okta for the client", + "type": "string" + }, + "logo_uri": { + "description": "The URL string that references a logo for the client. This logo appears on the client tile in the End-User Dashboard. It also appears on the client consent dialog during the client consent flow.", + "maxLength": 1024, + "type": "string" + }, + "network": { + "$ref": "#/components/schemas/OpenIdConnectApplicationNetwork" + }, + "participate_slo": { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Allows the app to participate in front-channel Single Logout\n\n> **Note:** You can only enable `participate_slo` for `web` and `browser` application types (`application_type`).\n", + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "policy_uri": { + "description": "URL string of a web page providing the client's policy document", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Array of redirection URI strings for relying party-initiated logouts", + "items": { + "type": "string" + }, + "type": "array" + }, + "redirect_uris": { + "description": "Array of redirection URI strings for use in redirect-based flows.\n> **Note:** At least one `redirect_uris` and `response_types` are required for all client types, with exceptions: if the client uses the [Resource Owner Password ](https://tools.ietf.org/html/rfc6749#section-4.3)flow (`grant_types` contains `password`) or [Client Credentials](https://tools.ietf.org/html/rfc6749#section-4.4)flow (`grant_types` contains `client_credentials`), then no `redirect_uris` or `response_types` is necessary. In these cases, you can pass either null or an empty array for these attributes.", + "items": { + "type": "string" + }, + "type": "array" + }, + "refresh_token": { + "$ref": "#/components/schemas/OpenIdConnectApplicationSettingsRefreshToken" + }, + "request_object_signing_alg": { + "description": "The type of JSON Web Key Set (JWKS) algorithm that must be used for signing request objects", + "enum": [ + "HS256", + "HS384", + "HS512", + "RS256", + "RS384", + "RS512", + "ES256", + "ES384", + "ES512" + ], + "type": "string" + }, + "response_types": { + "description": "Array of OAuth 2.0 response type strings", + "items": { + "$ref": "#/components/schemas/OAuthResponseType" + }, + "type": "array" + }, + "sector_identifier_uri": { + "description": "The sector identifier used for pairwise `subject_type`. See [OIDC Pairwise Identifier Algorithm](https://openid.net/specs/openid-connect-messages-1_0-20.html#idtype.pairwise.alg)", + "maxLength": 1024, + "type": "string" + }, + "subject_type": { + "description": "Type of the subject", + "enum": [ + "public", + "pairwise" + ], + "type": "string" + }, + "tos_uri": { + "description": "URL string of a web page providing the client's terms of service document", + "type": "string" + }, + "wildcard_redirect": { + "description": "Indicates if the client is allowed to use wildcard matching of `redirect_uris`", + "enum": [ + "DISABLED", + "SUBDOMAIN" + ], + "type": "string", + "x-enumDescriptions": { + "DISABLED": "All redirect URIs must be absolute URIs and not include a fragment component.", + "SUBDOMAIN": "Any configured redirect URIs may contain a single `*` character in the lowest-level domain (for example, `https://redirect-*-domain.example.com/oidc/redirect`) to act as a wildcard.\nThe wildcard subdomain must have at least one subdomain between it and the top level domain.\nThe wildcard can match any valid hostname characters, but can't span more than one domain.\nFor example, if `https://redirect-*-domain.example.com/oidc/redirect` is configured as a redirect URI, then `https://redirect-1-domain.example.com/oidc/redirect` and `https://redirect-sub-domain.example.com/oidc/redirect` match, but `https://redirect-1.sub-domain.example.com/oidc/redirect` doesn't match.\nOnly the `https` URI scheme can use wildcard redirect URIs.\n> **Note:** The use of wildcard subdomains is discouraged as an insecure practice, since it may allow malicious actors to have tokens or authorization codes sent to unexpected or attacker-controlled pages. Exercise caution if you decide to include a wildcard redirect URI in your configuration.\n" + } + } + }, + "required": [ + "grant_types" + ], + "type": "object" + }, + "OpenIdConnectApplicationSettingsClientKeys": { + "description": "A [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) for validating JWTs presented to Okta or for encrypting ID tokens minted by Okta for the client", + "properties": { + "keys": { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonSigningKeyResponse" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonEncryptionKeyResponse" + } + ] + }, + "type": "array" + } + }, + "type": "object" + }, + "OpenIdConnectApplicationSettingsRefreshToken": { + "description": "Refresh token configuration for an OAuth 2.0 client\n\nWhen you create or update an OAuth 2.0 client, you can configure refresh token rotation by setting the `rotation_type` and `leeway` properties. If you don't set these properties when you create an app integration, the default values are used.\nWhen you update an app integration, your previously configured values are used.\n", + "properties": { + "leeway": { + "default": 30, + "description": "The leeway, in seconds, allowed for the OAuth 2.0 client.\nAfter the refresh token is rotated, the previous token remains valid for the specified period of time so clients can get the new token.\n\n> **Note:** A leeway of 0 doesn't necessarily mean that the previous token is immediately invalidated. The previous token is invalidated after the new token is generated and returned in the response.\n", + "example": 20, + "maximum": 60, + "minimum": 0, + "type": "integer" + }, + "rotation_type": { + "$ref": "#/components/schemas/OpenIdConnectRefreshTokenRotationType" + } + }, + "required": [ + "rotation_type" + ], + "type": "object" + }, + "OpenIdConnectApplicationType": { + "description": "The type of client app \nSpecific `grant_types` are valid for each `application_type`. See [Create a Client Application](/openapi/okta-oauth/oauth/client/createclient).", + "enum": [ + "browser", + "native", + "service", + "web" + ], + "type": "string", + "x-enumDescriptions": { + "browser": "Single-Page app (SPA)", + "native": "Native app", + "service": "API service app", + "web": "Web app" + } + }, + "OpenIdConnectRefreshTokenRotationType": { + "description": "The refresh token rotation mode for the OAuth 2.0 client", + "enum": [ + "ROTATE", + "STATIC" + ], + "example": "STATIC", + "type": "string", + "x-enumDescriptions": { + "ROTATE": "The default rotation type for single-page apps (SPAs)", + "STATIC": "The default rotation type for all clients, except SPAs" + } + }, + "OperationRequest": { + "properties": { + "assignmentId": { + "description": "ID of the realm", + "type": "string" + } + }, + "type": "object" + }, + "OperationResponse": { + "properties": { + "completed": { + "description": "Timestamp of when the operation completed", + "format": "date-time", + "type": "string" + }, + "created": { + "description": "Timestamp of when the operation was created", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID of the asynchronous operation", + "type": "string" + }, + "started": { + "description": "Timestamp of when the operation started", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The status of the asynchronous operation", + "enum": [ + "COMPLETED", + "SCHEDULED", + "IN_PROGRESS", + "FAILED" + ], + "type": "string" + }, + "type": { + "description": "The operation type", + "type": "string" + } + }, + "required": [ + "id", + "type", + "status", + "created" + ], + "type": "object" + }, + "OperationalStatus": { + "description": "Operational status of a given agent", + "enum": [ + "DEGRADED", + "DISRUPTED", + "INACTIVE", + "OPERATIONAL" + ], + "type": "string" + }, + "OptInStatusResponse": { + "properties": { + "_links": { + "description": "Link relations available", + "properties": { + "optInStatus": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the opt-in status resource" + } + ] + } + }, + "type": "object" + }, + "optInStatus": { + "description": "The entitlement management opt-in status for the Admin Console", + "enum": [ + "OPTING_IN", + "OPTED_IN", + "OPTING_OUT", + "OPTED_OUT" + ], + "type": "string", + "x-enumDescriptions": { + "OPTED_IN": "Entitlement management is enabled for the Admin Console", + "OPTED_OUT": "Entitlement management is disabled for the Admin Console", + "OPTING_IN": "Okta is enabling entitlement management for the Admin Console", + "OPTING_OUT": "Okta is disabling entitlement management for the Admin Console" + } + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "Org2OrgApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/OINApplication" + }, + { + "type": "object" + }, + { + "properties": { + "name": { + "enum": [ + "okta_org2org" + ], + "example": "okta_org2org", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/Org2OrgApplicationSettings" + }, + "signOnMode": { + "default": "SAML_2_0", + "enum": [ + "SAML_2_0", + "AUTO_LOGIN" + ], + "type": "string", + "x-enumDescriptions": { + "AUTO_LOGIN": "Secure Web Authentication (SWA)", + "SAML_2_0": "Federated Authentication with SAML 2.0 WebSSO" + } + } + }, + "required": [ + "name", + "label", + "settings" + ] + } + ], + "description": "Schema for the Okta Org2Org app (key name: `okta_org2org`)\n\nTo create an Org2Org app, use the [Create an Application](/openapi/okta-management/management/tags/application/other/createapplication) request with the following parameters in the request body.\n> **Notes:**\n> * The Okta Org2Org (`okta_org2org`) app isn't available in Okta Integrator Free Plan orgs. If you need to test this feature in your Integrator Free Plan org, contact your Okta account team.\n> * The Okta Org2Org app supports `SAML_2_0` and `AUTO_LOGIN` sign-on modes.\n", + "example": { + "label": "Okta Org2Org", + "name": "okta_org2org", + "settings": { + "app": { + "acsUrl": "https://example.okta.com/sso/saml2/exampleid", + "audRestriction": "https://www.okta.com/saml2/service-provider/exampleid", + "baseUrl": "https://example.okta.com" + } + }, + "signOnMode": "SAML_2_0" + }, + "title": "Org2Org", + "x-okta-defined-as": { + "name": "okta_org2org" + }, + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-tags": [ + "Application" + ] + }, + "Org2OrgApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "type": "object" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/Org2OrgApplicationSettingsApplication" + }, + "signOn": { + "$ref": "#/components/schemas/OINSaml20ApplicationSettingsSignOn" + } + }, + "required": [ + "app" + ] + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "Org2OrgApplicationSettingsApplication": { + "description": "Org2Org app instance properties", + "properties": { + "acsUrl": { + "description": "The Assertion Consumer Service (ACS) URL of the source org (for `SAML_2_0` sign-on mode)", + "type": "string" + }, + "audRestriction": { + "description": "The entity ID of the SP (for `SAML_2_0` sign-on mode)", + "example": "https://www.okta.com/saml2/service-provider/exampleid", + "type": "string" + }, + "baseUrl": { + "description": "The base URL of the target Okta org (for `SAML_2_0` sign-on mode)", + "type": "string" + }, + "creationState": { + "description": "Used to track and manage the state of the app's creation or the provisioning process between two Okta orgs", + "type": "string" + }, + "preferUsernameOverEmail": { + "description": "Indicates that you don't want to use an email address as the username", + "type": "boolean" + }, + "token": { + "description": "An API token from the target org that's used to secure the connection between the orgs", + "type": "string" + }, + "tokenEncrypted": { + "description": "Encrypted token to enhance security", + "type": "string" + } + }, + "required": [ + "baseUrl" + ], + "type": "object" + }, + "Org2OrgProvisioningOAuthSigningSettings": { + "description": "Only used for the Okta Org2Org (`okta_org2org`) app.\n\nThe signing key rotation setting.", + "properties": { + "rotationMode": { + "$ref": "#/components/schemas/ConnectionsSigningRotationMode" + } + }, + "required": [ + "rotationMode" + ], + "title": "Org2Org Provisioning OAuth Signing Settings", + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "OrgAerialConsent": { + "properties": { + "accountId": { + "description": "The unique ID of the Aerial account", + "type": "string" + } + }, + "required": [ + "accountId" + ], + "type": "object" + }, + "OrgAerialConsentDetails": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksAerialConsentGranted" + }, + "accountId": { + "description": "The unique ID of the Aerial account", + "type": "string" + }, + "grantedBy": { + "description": "Principal ID of the user who granted the permission", + "example": "00u23ej02I2RLFxS5406", + "type": "string" + }, + "grantedDate": { + "description": "Date when grant was created", + "example": "2024-07-24T16:01:13.000Z", + "type": "string" + } + }, + "required": [ + "accountId" + ], + "type": "object" + }, + "OrgAerialConsentRevoked": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksAerialConsentRevoked" + } + }, + "type": "object" + }, + "OrgAerialGrantNotFound": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksAerialConsentGranted" + }, + "accountId": { + "description": "The unique ID of the Aerial account", + "type": "string" + }, + "grantedBy": { + "description": "Principal ID of the user who granted the permission", + "example": "00u23ej02I2RLFxS5406", + "type": "string" + }, + "grantedDate": { + "description": "Date when grant was created", + "example": "2024-07-24T16:01:13.000Z", + "type": "string" + } + }, + "type": "object" + }, + "OrgCAPTCHASettings": { + "description": "", + "properties": { + "_links": { + "description": "Link relations for the CAPTCHA settings object", + "properties": { + "self": { + "$ref": "#/components/schemas/HrefObject" + } + }, + "readOnly": true, + "type": "object" + }, + "captchaId": { + "description": "The unique key of the associated CAPTCHA instance", + "type": "string" + }, + "enabledPages": { + "description": "An array of pages that have CAPTCHA enabled", + "items": { + "$ref": "#/components/schemas/enabledPagesType" + }, + "type": "array" + } + }, + "title": "OrgCAPTCHASettings", + "type": "object" + }, + "OrgContactType": { + "description": "Type of contact", + "enum": [ + "BILLING", + "TECHNICAL" + ], + "type": "string" + }, + "OrgContactTypeObj": { + "anyOf": [ + { + "$ref": "#/components/schemas/orgBillingContactType" + }, + { + "$ref": "#/components/schemas/orgTechnicalContactType" + } + ], + "discriminator": { + "mapping": { + "BILLING": "#/components/schemas/orgBillingContactType", + "TECHNICAL": "#/components/schemas/orgTechnicalContactType" + }, + "propertyName": "contactType" + }, + "properties": { + "contactType": { + "$ref": "#/components/schemas/OrgContactType" + } + }, + "type": "object" + }, + "OrgContactUser": { + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the contact type user object using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "properties": { + "user": { + "$ref": "#/components/schemas/HrefObjectUserLink" + } + }, + "readOnly": true, + "type": "object" + }, + "userId": { + "description": "Contact user ID", + "type": "string" + } + }, + "type": "object" + }, + "OrgCreationAdmin": { + "description": "Profile and credential information for the first super admin user of the child org.\nIf you plan to configure and manage the org programmatically, create a system user with a dedicated email address and a strong password.\n> **Note:** If you don't provide `credentials`, the super admin user is prompted to set up their credentials when they sign in to the org for the first time.", + "properties": { + "credentials": { + "description": "Specifies primary authentication and recovery credentials for a user. Credential types and requirements vary depending on the provider and security policy of the org.", + "properties": { + "password": { + "description": "Specifies a password for a user\n> **Note:** For information on defaults and configuring your password policies, see [Configure the password authenticator](https://help.okta.com/okta_help.htm?type=oie&id=ext-configure-password) in the help documentation.", + "properties": { + "value": { + "description": "Password value (which is validated by the password policy)", + "example": "pa$$word", + "format": "password", + "type": "string", + "writeOnly": true + } + }, + "type": "object" + }, + "recovery_question": { + "$ref": "#/components/schemas/RecoveryQuestionCredential" + } + }, + "type": "object" + }, + "profile": { + "additionalProperties": true, + "description": "Specifies the profile attributes for the first super admin user. The minimal set of required attributes are `email`, `firstName`, `lastName`, and `login`.\nSee [profile](/openapi/okta-management/management/user/getuser#user/getuser/t=response&c=200&path=profile) for additional profile attributes.", + "properties": { + "email": { + "description": "The primary email address of the User. For validation, see [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3).", + "format": "email", + "maxLength": 100, + "minLength": 5, + "type": "string" + }, + "firstName": { + "description": "Given name of the User (`givenName`)", + "maxLength": 50, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "lastName": { + "description": "The family name of the User (`familyName`)", + "maxLength": 50, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "login": { + "description": "The unique identifier for the User (`username`)", + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "email", + "login", + "firstName", + "lastName" + ], + "type": "object" + } + }, + "required": [ + "profile" + ], + "type": "object", + "writeOnly": true + }, + "OrgCrossAppAccessConnection": { + "description": "Connection object for Cross App Access connections", + "properties": { + "created": { + "description": "The ISO 8601 formatted date and time when the connection was created", + "example": "2024-10-15T10:30:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the connection", + "example": "cwofxqCAJWWGELFTYASJ", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "The ISO 8601 formatted date and time when the connection was last updated", + "example": "2024-10-15T14:20:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "requestingAppInstanceId": { + "description": "ID of the requesting app instance", + "example": "0oafxqCAJWWGELFTYASJ", + "type": "string" + }, + "resourceAppInstanceId": { + "description": "ID of the resource app instance", + "example": "0oafxqCBJWWGELFTYASK", + "type": "string" + }, + "status": { + "description": "Indicates if the Cross App Access connection is active or inactive", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE", + "type": "string" + } + }, + "type": "object" + }, + "OrgCrossAppAccessConnectionPatchRequest": { + "description": "Patch request object for Cross App Access Connections", + "properties": { + "status": { + "description": "Requested value of Cross App Access connection status", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE", + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" + }, + "OrgOktaCommunicationSetting": { + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for this object using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "properties": { + "optIn": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to opt users in to communication emails" + } + ] + }, + "optOut": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to opt users out of communication emails" + } + ] + } + }, + "readOnly": true, + "type": "object" + }, + "optOutEmailUsers": { + "description": "Indicates whether org users receive Okta communication emails", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OrgOktaSupportSetting": { + "description": "Status of Okta Support Settings", + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "OrgOktaSupportSettingsObj": { + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the Okta Support Settings object using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "properties": { + "case": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to [update an Okta Support case](/openapi/okta-management/management/tags/orgsettingsupport/other/updateoktasupportcase)" + } + ] + }, + "cases": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to [List all Okta Support cases](/openapi/okta-management/management/tags/orgsettingsupport/other/listoktasupportcases)" + } + ] + }, + "extend": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to [extend Okta Support Access](/openapi/okta-management/management/tags/orgsettingsupport/other/extendoktasupport)" + } + ] + }, + "grant": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to [grant Okta Support Access](/openapi/okta-management/management/tags/orgsettingsupport/other/grantoktasupport)" + } + ] + }, + "revoke": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to [revoke Okta Support Access](/openapi/okta-management/management/tags/orgsettingsupport/other/revokeoktasupport)" + } + ] + } + }, + "readOnly": true, + "type": "object" + }, + "caseNumber": { + "description": "Support case number for the Okta Support access grant", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "expiration": { + "description": "Expiration of Okta Support", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "support": { + "$ref": "#/components/schemas/OrgOktaSupportSetting" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OrgPreferences": { + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for this object using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "properties": { + "hideEndUserFooter": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to hide the footer in the End-User Dashboard" + } + ] + }, + "showEndUserFooter": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to show the footer on the End-User Dashboard" + } + ] + } + }, + "readOnly": true, + "type": "object" + }, + "showEndUserFooter": { + "description": "Indicates if the footer is shown on the End-User Dashboard", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "OrgSetting": { + "properties": { + "_links": { + "$ref": "#/components/schemas/orgGeneralSettingLinks" + }, + "address1": { + "description": "Primary address of the organization associated with the org", + "type": "string" + }, + "address2": { + "description": "Secondary address of the organization associated with the org", + "type": "string" + }, + "city": { + "description": "City of the organization associated with the org", + "type": "string" + }, + "companyName": { + "description": "Name of org", + "type": "string" + }, + "country": { + "description": "County of the organization associated with the org", + "type": "string" + }, + "created": { + "description": "When org was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "endUserSupportHelpURL": { + "description": "Support link of org", + "type": "string" + }, + "expiresAt": { + "description": "Expiration of org", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Org ID", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "When org was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "phoneNumber": { + "description": "Phone number of the organization associated with the org", + "type": "string" + }, + "postalCode": { + "description": "Postal code of the organization associated with the org", + "type": "string" + }, + "state": { + "description": "State of the organization associated with the org", + "type": "string" + }, + "status": { + "description": "Status of org", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "readOnly": true, + "type": "string" + }, + "subdomain": { + "description": "Subdomain of org", + "readOnly": true, + "type": "string" + }, + "supportPhoneNumber": { + "description": "Support help phone of the organization associated with the org", + "type": "string" + }, + "website": { + "description": "Website of the organization associated with the org", + "type": "string" + } + }, + "type": "object" + }, + "OrganizationalUnit": { + "properties": { + "name": { + "description": "The name of the organizational unit where privileged app users are present", + "example": "OU=example1,DN=globo,DN=com", + "maxLength": 1024, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "OtpProtocol": { + "description": "The protocol used", + "enum": [ + "SYMANTEC", + "TOTP", + "YUBICO" + ], + "type": "string" + }, + "OtpTotpAlgorithm": { + "description": "HMAC algorithm", + "enum": [ + "HMacSHA1", + "HMacSHA256", + "HMacSHA512" + ], + "type": "string" + }, + "OtpTotpEncoding": { + "description": "The shared secret encoding", + "enum": [ + "base32", + "base64", + "hexadecimal" + ], + "type": "string" + }, + "OtpTotpPassCodeLength": { + "description": "Number of digits in an OTP value", + "maximum": 10, + "minimum": 6, + "multipleOf": 2, + "type": "integer" + }, + "OtpTotpTimeIntervalInSeconds": { + "description": "Time interval for TOTP in seconds", + "type": "integer" + }, + "PageRoot": { + "properties": { + "_embedded": { + "properties": { + "customized": { + "$ref": "#/components/schemas/CustomizablePage" + }, + "customizedUrl": { + "format": "uri", + "type": "string" + }, + "default": { + "$ref": "#/components/schemas/CustomizablePage" + }, + "preview": { + "$ref": "#/components/schemas/CustomizablePage" + }, + "previewUrl": { + "format": "uri", + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "customized": { + "$ref": "#/components/schemas/HrefObject" + }, + "default": { + "$ref": "#/components/schemas/HrefObject" + }, + "preview": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "Parameters": { + "description": "Attributes used for processing Active Directory or LDAP group membership update", + "properties": { + "action": { + "description": "The update action to take", + "enum": [ + "ADD", + "REMOVE" + ], + "type": "string", + "x-enumDescriptions": { + "ADD": "Add to the membership of the group", + "REMOVE": "Remove from the membership of the group" + } + }, + "attribute": { + "description": "The attribute that tracks group memberships in Active Directory or LDAP. For Active Directory, use `member`. For LDAP, use the appropriate attribute found in the LDAP server such as, but not limited to, `uniqueMember` or `member`.", + "example": "member", + "type": "string" + }, + "values": { + "description": "List of user IDs whose group memberships to update", + "items": { + "description": "ID of an existing user", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "action", + "attribute", + "values" + ], + "type": "object" + }, + "PasswordCredential": { + "description": "Specifies a password for a user.\n\nWhen a user has a valid password, imported hashed password, or password hook, and a response object contains\na password credential, then the password object is a bare object without the value property defined (for example, `password: {}`). This indicates that a password value exists. You can modify password policy requirements in the Admin Console by editing the Password authenticator: **Security** > **Authenticators** > **Password** (or for Okta Classic orgs, use **Security** > **Authentication** > **Password**).\n\nFor information on defaults and configuring your password policies, see [Configure the password authenticator](https://help.okta.com/okta_help.htm?type=oie&id=ext-configure-password) in the help documentation.", + "properties": { + "hash": { + "$ref": "#/components/schemas/PasswordCredentialHash" + }, + "hook": { + "$ref": "#/components/schemas/PasswordCredentialHook" + }, + "value": { + "description": "Specifies the password for a user. The password policy validates this password.", + "example": "pa$$word", + "format": "password", + "type": "string", + "writeOnly": true + } + }, + "type": "object" + }, + "PasswordCredentialHash": { + "description": "Specifies a hashed password to import into Okta. This allows an existing password to be imported into Okta directly\nfrom some other store. Okta supports the BCRYPT, SHA-512, SHA-256, SHA-1, MD5, and PBKDF2 hash functions for password import.\n A hashed password may be specified in a password object when creating or updating a user, but not for other operations.\n See the [Create user with imported hashed password](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#create-user-with-imported-hashed-password) description. When you update a user with a hashed password, the user must be in the `STAGED` status.", + "properties": { + "algorithm": { + "$ref": "#/components/schemas/PasswordCredentialHashAlgorithm" + }, + "digestAlgorithm": { + "$ref": "#/components/schemas/DigestAlgorithm" + }, + "iterationCount": { + "description": "The number of iterations used when hashing passwords using PBKDF2. Must be >= 4096. Only required for PBKDF2 algorithm.", + "type": "integer" + }, + "keySize": { + "description": "Size of the derived key in bytes. Only required for PBKDF2 algorithm.", + "type": "integer" + }, + "salt": { + "description": "Only required for salted hashes. For BCRYPT, this specifies Radix-64 as the encoded salt used to generate the hash,\nwhich must be 22 characters long. For other salted hashes, this specifies the Base64-encoded salt used to\ngenerate the hash.", + "type": "string" + }, + "saltOrder": { + "description": "Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.", + "type": "string" + }, + "value": { + "description": "For SHA-512, SHA-256, SHA-1, MD5, and PBKDF2, this is the actual base64-encoded hash of the password (and salt, if used).\nThis is the Base64-encoded `value` of the SHA-512/SHA-256/SHA-1/MD5/PBKDF2 digest that was computed by either pre-fixing or post-fixing\nthe `salt` to the `password`, depending on the `saltOrder`. If a `salt` was not used in the `source` system, then this should just be\nthe Base64-encoded `value` of the password's SHA-512/SHA-256/SHA-1/MD5/PBKDF2 digest. For BCRYPT, this is the actual Radix-64 encoded hashed password.", + "type": "string" + }, + "workFactor": { + "description": "Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "PasswordCredentialHashAlgorithm": { + "description": "The algorithm used to generate the hash using the password (and salt, when applicable).", + "enum": [ + "BCRYPT", + "MD5", + "PBKDF2", + "SHA-1", + "SHA-256", + "SHA-512" + ], + "type": "string" + }, + "PasswordCredentialHook": { + "description": "Specify a [password import inline hook](/openapi/okta-management/management/tags/inlinehook/createpasswordimportinlinehook) to trigger verification of the user's password the first time the user signs in. This allows an existing password to be imported into Okta directly from some other store.", + "properties": { + "type": { + "description": "The type of password inline hook. Currently, must be set to default.", + "type": "string" + } + }, + "type": "object" + }, + "PasswordDictionary": { + "description": "Weak password dictionary lookup settings", + "properties": { + "common": { + "$ref": "#/components/schemas/PasswordDictionaryCommon" + } + }, + "type": "object" + }, + "PasswordDictionaryCommon": { + "description": "Lookup settings for commonly used passwords", + "properties": { + "exclude": { + "default": false, + "description": "Indicates whether to check passwords against the common password dictionary", + "type": "boolean" + } + }, + "type": "object" + }, + "PasswordExpirationPolicyRuleCondition": { + "properties": { + "number": { + "type": "integer" + }, + "unit": { + "type": "string" + } + }, + "type": "object" + }, + "PasswordImportRequest": { + "properties": { + "data": { + "$ref": "#/components/schemas/PasswordImportRequestData" + }, + "eventType": { + "description": "The type of inline hook. The password import inline hook type is `com.okta.user.credential.password.import`.", + "type": "string" + }, + "source": { + "description": "The ID and URL of the password import inline hook", + "type": "string" + } + }, + "type": "object" + }, + "PasswordImportRequestData": { + "properties": { + "action": { + "description": "This object specifies the default action Okta is set to take. Okta takes this action if your external service sends an empty HTTP 204 response. You can override the default action by returning a commands object in your response specifying the action to take.", + "properties": { + "credential": { + "default": "UNVERIFIED", + "description": "The status of the user credential, either `UNVERIFIED` or `VERIFIED`", + "type": "string" + } + }, + "type": "object" + }, + "context": { + "properties": { + "credential": { + "properties": { + "password": { + "description": "The `password` that the user supplied when attempting to sign in to Okta.", + "type": "string" + }, + "username": { + "description": "The `username` that the user supplied when attempting to sign in to Okta.", + "type": "string" + } + }, + "type": "object" + }, + "request": { + "$ref": "#/components/schemas/InlineHookRequestObject" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "PasswordImportRequestExecute": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/PasswordImportRequest" + } + ], + "description": "Password import inline hook request" + }, + "PasswordImportResponse": { + "description": "Password import inline hook response", + "properties": { + "commands": { + "description": "The `commands` object specifies whether Okta accepts the end user's sign-in credentials as valid or not. For the password import inline hook, you typically only return one `commands` object with one array element in it.", + "items": { + "properties": { + "type": { + "description": "The location where you specify the command. For the password import inline hook, there's only one command, `com.okta.action.update`." + }, + "value": { + "description": "The parameter value of the command.\n* To indicate that the supplied credentials are valid, supply a type property set to `com.okta.action.update` together with a value property set to `{\"credential\": \"VERIFIED\"}`.\n* To indicate that the supplied credentials are invalid, supply a type property set to `com.okta.action.update` together with a value property set to `{\"credential\": \"UNVERIFIED\"}`.\nAlternatively, you can send an empty response (`204`). By default, the `data.action.credential` is always set to `UNVERIFIED`.", + "properties": { + "credential": { + "enum": [ + "UNVERIFIED", + "VERIFIED" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "PasswordPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "conditions": { + "$ref": "#/components/schemas/PasswordPolicyConditions" + }, + "settings": { + "$ref": "#/components/schemas/PasswordPolicySettings" + } + }, + "type": "object" + } + ] + }, + "PasswordPolicyAuthenticationProviderCondition": { + "description": "Specifies an authentication provider that's the source of some or all users", + "properties": { + "include": { + "items": { + "type": "string" + }, + "type": "array" + }, + "provider": { + "$ref": "#/components/schemas/PasswordPolicyAuthenticationProviderType" + } + }, + "type": "object" + }, + "PasswordPolicyAuthenticationProviderType": { + "enum": [ + "ACTIVE_DIRECTORY", + "ANY", + "LDAP", + "OKTA" + ], + "type": "string" + }, + "PasswordPolicyConditions": { + "allOf": [ + { + "type": "object" + }, + { + "description": "Specifies the conditions that must be met during policy evaluation to apply the policy" + }, + { + "properties": { + "authProvider": { + "$ref": "#/components/schemas/PasswordPolicyAuthenticationProviderCondition" + }, + "people": { + "description": "Identifies users and groups that are used together", + "properties": { + "groups": { + "description": "Specifies a set of groups whose users are to be included or excluded", + "properties": { + "include": { + "description": "Groups to be included", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PasswordPolicyDelegationSettings": { + "description": "Specifies how to handle password delegation", + "properties": { + "options": { + "$ref": "#/components/schemas/PasswordPolicyDelegationSettingsOptions" + } + }, + "type": "object" + }, + "PasswordPolicyDelegationSettingsOptions": { + "properties": { + "skipUnlock": { + "default": false, + "description": "Indicates if, when performing an unlock operation on an Active Directory sourced User who is locked out of Okta, the system should also attempt to unlock the User's Windows account", + "type": "boolean" + } + }, + "type": "object" + }, + "PasswordPolicyPasswordSettings": { + "description": "Specifies the password settings for the policy", + "properties": { + "age": { + "$ref": "#/components/schemas/PasswordPolicyPasswordSettingsAge" + }, + "breachedProtection": { + "$ref": "#/components/schemas/PasswordPolicyPasswordSettingsBreachedProtection" + }, + "complexity": { + "$ref": "#/components/schemas/PasswordPolicyPasswordSettingsComplexity" + }, + "lockout": { + "$ref": "#/components/schemas/PasswordPolicyPasswordSettingsLockout" + } + }, + "type": "object" + }, + "PasswordPolicyPasswordSettingsAge": { + "description": "Age settings", + "properties": { + "expireWarnDays": { + "default": 0, + "description": "Specifies the number of days prior to password expiration when a User is warned to reset their password: `0` indicates no warning", + "type": "integer" + }, + "historyCount": { + "default": 0, + "description": "Specifies the number of distinct passwords that a User must create before they can reuse a previous password: `0` indicates none", + "type": "integer" + }, + "maxAgeDays": { + "default": 0, + "description": "Specifies how long (in days) a password remains valid before it expires: `0` indicates no limit", + "type": "integer" + }, + "minAgeMinutes": { + "default": 0, + "description": "Specifies the minimum time interval (in minutes) between password changes: `0` indicates no limit", + "type": "integer" + } + }, + "type": "object" + }, + "PasswordPolicyPasswordSettingsBreachedProtection": { + "description": "Breached Protection settings", + "properties": { + "delegatedWorkflowId": { + "default": null, + "description": "The `id` of the workflow that runs when a breached password is found during a sign-in attempt.", + "nullable": true, + "type": "string" + }, + "expireAfterDays": { + "default": null, + "description": "Specifies the number of days after a breached password is found during a sign-in attempt that the user's password should expire.\nValid values: 0 through 10. If set to 0, it happens immediately.", + "nullable": true, + "type": "integer" + }, + "logoutEnabled": { + "default": false, + "description": "(Optional, default is false) If true, you must also specify a value for `expireAfterDays`. When enabled, the user's session(s)\nare terminated immediately the first time the user's credentials are detected as part of a breach.", + "nullable": true, + "type": "boolean" + } + }, + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "PasswordPolicyPasswordSettingsComplexity": { + "description": "Complexity settings", + "properties": { + "dictionary": { + "$ref": "#/components/schemas/PasswordDictionary" + }, + "excludeAttributes": { + "default": [], + "description": "The User profile attributes whose values must be excluded from the password: currently only supports `firstName` and `lastName`", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeUsername": { + "default": true, + "description": "Indicates if the Username must be excluded from the password", + "type": "boolean" + }, + "maxConsecutiveCharacters": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Specifies the maximum number of consecutive repeating characters that can be used in a password", + "maximum": 72, + "minimum": 1, + "type": "integer", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "minLength": { + "default": 8, + "description": "Minimum password length", + "type": "integer" + }, + "minLowerCase": { + "default": 1, + "description": "Indicates if a password must contain at least one lower case letter: `0` indicates no, `1` indicates yes", + "type": "integer" + }, + "minNumber": { + "default": 1, + "description": "Indicates if a password must contain at least one number: `0` indicates no, `1` indicates yes", + "type": "integer" + }, + "minSymbol": { + "default": 1, + "description": "Indicates if a password must contain at least one symbol (For example: !@#$%^&*): `0` indicates no, `1` indicates yes", + "type": "integer" + }, + "minUpperCase": { + "default": 1, + "description": "Indicates if a password must contain at least one upper case letter: `0` indicates no, `1` indicates yes", + "type": "integer" + }, + "oelStatement": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Use an [Expression Language](https://developer.okta.com/docs/reference/okta-expression-language-in-identity-engine/) expression to block a word from being used in a password. You can only block one word per expression. Use the `OR` operator to connect multiple expressions to block multiple words.", + "example": [ + "password.value.contains('Word1') OR password.value.contains('Word2')" + ], + "type": "string", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "type": "object" + }, + "PasswordPolicyPasswordSettingsLockout": { + "description": "Lockout settings", + "properties": { + "autoUnlockMinutes": { + "default": 0, + "description": "Specifies the time interval (in minutes) a locked account remains locked before it is automatically unlocked: `0` indicates no limit", + "type": "integer" + }, + "maxAttempts": { + "default": 10, + "description": "Specifies the number of times Users can attempt to sign in to their accounts with an invalid password before their accounts are locked: `0` indicates no limit", + "type": "integer" + }, + "showLockoutFailures": { + "default": false, + "description": "Indicates if the User should be informed when their account is locked", + "type": "boolean" + }, + "userLockoutNotificationChannels": { + "default": [], + "description": "How the user is notified when their account becomes locked. The only acceptable values are `[]` and `['EMAIL']`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "PasswordPolicyRecoveryEmail": { + "properties": { + "properties": { + "$ref": "#/components/schemas/PasswordPolicyRecoveryEmailProperties" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "Whether or not the factor is active" + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PasswordPolicyRecoveryEmailProperties": { + "properties": { + "recoveryToken": { + "$ref": "#/components/schemas/PasswordPolicyRecoveryEmailRecoveryToken" + } + }, + "type": "object" + }, + "PasswordPolicyRecoveryEmailRecoveryToken": { + "properties": { + "tokenLifetimeMinutes": { + "default": 10080, + "description": "Lifetime (in minutes) of the recovery token", + "type": "integer" + } + }, + "type": "object" + }, + "PasswordPolicyRecoveryFactorSettings": { + "properties": { + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "Whether or not the factor is active" + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PasswordPolicyRecoveryFactors": { + "description": "Settings for the factors that can be used for recovery", + "properties": { + "okta_call": { + "$ref": "#/components/schemas/PasswordPolicyRecoveryFactorSettings", + "description": "Okta voice call" + }, + "okta_email": { + "$ref": "#/components/schemas/PasswordPolicyRecoveryEmail", + "description": "Okta email" + }, + "okta_sms": { + "$ref": "#/components/schemas/PasswordPolicyRecoveryFactorSettings", + "description": "Okta SMS" + }, + "recovery_question": { + "$ref": "#/components/schemas/PasswordPolicyRecoveryQuestion", + "description": "Okta security question" + } + }, + "type": "object" + }, + "PasswordPolicyRecoveryQuestion": { + "properties": { + "properties": { + "$ref": "#/components/schemas/PasswordPolicyRecoveryQuestionProperties" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "Whether or not the factor is active" + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PasswordPolicyRecoveryQuestionComplexity": { + "properties": { + "minLength": { + "default": 4, + "description": "Minimum length of the password recovery question answer", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "PasswordPolicyRecoveryQuestionProperties": { + "properties": { + "complexity": { + "$ref": "#/components/schemas/PasswordPolicyRecoveryQuestionComplexity" + } + }, + "type": "object" + }, + "PasswordPolicyRecoverySettings": { + "description": "Specifies the password recovery settings for the policy\n> **Note:** With Identity Engine, you can specify recovery factors inside the password policy rule instead of in the policy settings object. Recovery factors for the rule are defined inside the [`selfServicePasswordReset` action](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/policy/#tag/Policy/operation/createPolicyRule!path=1/actions/selfServicePasswordReset&t=request).", + "properties": { + "factors": { + "$ref": "#/components/schemas/PasswordPolicyRecoveryFactors" + } + }, + "type": "object" + }, + "PasswordPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "$ref": "#/components/schemas/PasswordPolicyRuleActions" + }, + "conditions": { + "$ref": "#/components/schemas/PasswordPolicyRuleConditions" + } + }, + "type": "object" + } + ] + }, + "PasswordPolicyRuleAction": { + "description": "Indicates if a password can be changed", + "properties": { + "access": { + "$ref": "#/components/schemas/PolicyAccess" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PasswordPolicyRuleActions": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRuleActions" + }, + { + "type": "object" + }, + { + "description": "Specifies how passwords and password recovery are handled", + "properties": { + "passwordChange": { + "$ref": "#/components/schemas/PasswordPolicyRuleAction" + }, + "selfServicePasswordReset": { + "$ref": "#/components/schemas/SelfServicePasswordResetAction" + }, + "selfServiceUnlock": { + "$ref": "#/components/schemas/PasswordPolicyRuleAction" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PasswordPolicyRuleConditions": { + "description": "Specifies conditions that must be met during policy evaluation to apply the rule. All policy conditions and conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule.", + "properties": { + "network": { + "$ref": "#/components/schemas/PolicyNetworkCondition" + }, + "people": { + "$ref": "#/components/schemas/PolicyPeopleCondition" + } + }, + "type": "object" + }, + "PasswordPolicySettings": { + "description": "Specifies the policy level settings", + "properties": { + "delegation": { + "$ref": "#/components/schemas/PasswordPolicyDelegationSettings" + }, + "password": { + "$ref": "#/components/schemas/PasswordPolicyPasswordSettings" + }, + "recovery": { + "$ref": "#/components/schemas/PasswordPolicyRecoverySettings" + } + }, + "type": "object" + }, + "PasswordProtectionWarningTrigger": { + "description": "Indicates whether the Password Protection Warning feature is enabled", + "enum": [ + "PASSWORD_PROTECTION_OFF", + "PASSWORD_REUSE", + "PHISHING_REUSE" + ], + "example": "PHISHING_REUSE", + "type": "string", + "x-enumDescriptions": { + "PASSWORD_PROTECTION_OFF": "Password protection warning is off", + "PASSWORD_REUSE": "Password protection warning is triggered by password reuse", + "PHISHING_REUSE": "Password protection warning is triggered by password reuse on a phishing page" + } + }, + "PasswordSettingObject": { + "description": "Determines whether Okta creates and pushes a password in the app for each assigned user", + "properties": { + "change": { + "$ref": "#/components/schemas/ChangeEnum" + }, + "seed": { + "$ref": "#/components/schemas/SeedEnum" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/EnabledStatus" + }, + { + "default": "DISABLED" + }, + { + "example": "ENABLED" + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PatchAction": { + "description": "The operation (PATCH action)", + "enum": [ + "remove", + "replace" + ], + "type": "string", + "x-enumDescriptions": { + "remove": "Removes the attribute in `path` if allowed", + "replace": "Replaces the attribute in content `path` with the content in `value`" + } + }, + "PerClientRateLimitMode": { + "enum": [ + "DISABLE", + "ENFORCE", + "PREVIEW" + ], + "type": "string" + }, + "PerClientRateLimitSettings": { + "description": "", + "properties": { + "defaultMode": { + "$ref": "#/components/schemas/PerClientRateLimitMode", + "description": "The default PerClientRateLimitMode that applies to any use case in the absence of a more specific override" + }, + "useCaseModeOverrides": { + "description": "A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode. Overrides the `defaultMode` property for the specified use cases.", + "properties": { + "LOGIN_PAGE": { + "$ref": "#/components/schemas/PerClientRateLimitMode" + }, + "OAUTH2_AUTHORIZE": { + "$ref": "#/components/schemas/PerClientRateLimitMode" + }, + "OIE_APP_INTENT": { + "$ref": "#/components/schemas/PerClientRateLimitMode" + } + }, + "type": "object" + } + }, + "required": [ + "defaultMode" + ], + "title": "PerClientRateLimitSettings", + "type": "object" + }, + "Permission": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "role": { + "$ref": "#/components/schemas/HrefObjectRoleLink" + } + } + } + ] + }, + "conditions": { + "$ref": "#/components/schemas/PermissionConditions" + }, + "created": { + "description": "Timestamp when the permission was assigned", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "label": { + "description": "The assigned Okta [permission](/openapi/okta-management/guides/permissions)", + "example": "okta.users.read", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the permission was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PermissionConditions": { + "description": "Conditions for further restricting a permission. See [Permission conditions](https://help.okta.com/okta_help.htm?type=oie&id=ext-permission-conditions).", + "nullable": true, + "properties": { + "exclude": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "Exclude attributes with specific values for the permission", + "nullable": true, + "type": "object" + }, + "include": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "Include attributes with specific values for the permission", + "nullable": true, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "Permissions": { + "description": "Permissions assigned to the role", + "properties": { + "permissions": { + "description": "Array of permissions assigned to the role. See [Permissions](/openapi/okta-management/guides/permissions).", + "items": { + "$ref": "#/components/schemas/Permission" + }, + "type": "array" + } + }, + "type": "object" + }, + "PersonalAppsBlockList": { + "description": "Defines a list of email domains with a subset of the properties for each domain", + "properties": { + "domains": { + "description": "List of blocked email domains", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PinRequest": { + "description": "Pin request", + "properties": { + "authenticatorEnrollmentId": { + "description": "ID for a WebAuthn preregistration factor in Okta", + "type": "string" + }, + "fulfillmentProvider": { + "description": "Name of the fulfillment provider for the WebAuthn preregistration factor", + "enum": [ + "yubico" + ], + "type": "string" + }, + "userId": { + "description": "ID of an existing Okta user", + "type": "string" + } + }, + "type": "object" + }, + "PipelineType": { + "description": "The Okta authentication pipeline of the org", + "enum": [ + "idx", + "v1" + ], + "type": "string", + "x-enumDescriptions": { + "idx": "[Identity Engine](https://help.okta.com/okta_help.htm?type=oie&id=ext-get-started-oie)", + "v1": "[Classic Engine](https://help.okta.com/en-us/content/index-admin.htm)" + } + }, + "Platform": { + "enum": [ + "ANDROID", + "CHROMEOS", + "IOS", + "MACOS", + "WINDOWS" + ], + "type": "string" + }, + "PlatformConditionEvaluatorPlatform": { + "properties": { + "os": { + "$ref": "#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystem" + }, + "type": { + "$ref": "#/components/schemas/PolicyPlatformType" + } + }, + "type": "object" + }, + "PlatformConditionEvaluatorPlatformOperatingSystem": { + "properties": { + "expression": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PolicyPlatformOperatingSystemType" + }, + "version": { + "$ref": "#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystemVersion" + } + }, + "type": "object" + }, + "PlatformConditionEvaluatorPlatformOperatingSystemVersion": { + "properties": { + "matchType": { + "$ref": "#/components/schemas/PlatformConditionOperatingSystemVersionMatchType" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "PlatformConditionOperatingSystemVersionMatchType": { + "enum": [ + "EXPRESSION", + "SEMVER" + ], + "type": "string" + }, + "PlatformPolicyRuleCondition": { + "description": "Specifies a particular platform or device to match on", + "properties": { + "exclude": { + "items": { + "$ref": "#/components/schemas/PlatformConditionEvaluatorPlatform" + }, + "type": "array" + }, + "include": { + "items": { + "$ref": "#/components/schemas/PlatformConditionEvaluatorPlatform" + }, + "type": "array" + } + }, + "type": "object" + }, + "PlayProtectVerdict": { + "description": "Indicates if Google Play Protect is enabled on the device and whether it has found known malware", + "enum": [ + "HIGH", + "LOW", + "MEDIUM" + ], + "type": "string", + "x-enumDescriptions": { + "HIGH": "Play Protect is turned on and has either found dangerous apps installed on the device or its verdict wasn't evaluated. That is, the device isn't trustworthy enough.", + "LOW": "Play Protect is turned on and didn't find any app issues on the device", + "MEDIUM": "Play Protect is turned on and either hasn't performed a scan yet or has found potentially harmful apps installed on the device" + } + }, + "Policy": { + "discriminator": { + "mapping": { + "ACCESS_POLICY": "#/components/schemas/AccessPolicy", + "CLIENT_UPDATE": "#/components/schemas/ClientUpdatePolicy", + "DEVICE_SIGNAL_COLLECTION": "#/components/schemas/DeviceSignalCollectionPolicy", + "ENTITY_RISK": "#/components/schemas/EntityRiskPolicy", + "IDENTITY_CLAIM_SOURCING": "#/components/schemas/IdentityClaimSourcingPolicy", + "IDP_DISCOVERY": "#/components/schemas/IdpDiscoveryPolicy", + "MFA_ENROLL": "#/components/schemas/AuthenticatorEnrollmentPolicy", + "OKTA_SIGN_ON": "#/components/schemas/OktaSignOnPolicy", + "PASSWORD": "#/components/schemas/PasswordPolicy", + "POST_AUTH_SESSION": "#/components/schemas/PostAuthSessionPolicy", + "PROFILE_ENROLLMENT": "#/components/schemas/ProfileEnrollmentPolicy", + "SESSION_VIOLATION_DETECTION": "#/components/schemas/SessionViolationDetectionPolicy" + }, + "propertyName": "type" + }, + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/PolicyLinks" + }, + "created": { + "default": "Assigned", + "description": "Timestamp when the policy was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "default": null, + "description": "Description of the policy", + "type": "string" + }, + "id": { + "default": "Assigned", + "description": "Identifier of the policy", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "default": "Assigned", + "description": "Timestamp when the policy was last modified", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the policy", + "type": "string" + }, + "priority": { + "default": "Last / Lowest Priority, for example `1`", + "description": "Specifies the order in which this policy is evaluated in relation to the other policies", + "type": "integer" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "Whether or not the policy is active. Use the `activate` query parameter to set the status of a policy." + } + ] + }, + "system": { + "default": false, + "description": "Specifies whether Okta created the policy", + "type": "boolean" + }, + "type": { + "$ref": "#/components/schemas/PolicyType" + } + }, + "required": [ + "name", + "type" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PolicyAccess": { + "enum": [ + "ALLOW", + "DENY" + ], + "type": "string" + }, + "PolicyAccountLink": { + "description": "Specifies the behavior for linking an IdP user to an existing Okta user", + "properties": { + "action": { + "$ref": "#/components/schemas/PolicyAccountLinkAction" + }, + "filter": { + "$ref": "#/components/schemas/PolicyAccountLinkFilter" + } + }, + "type": "object" + }, + "PolicyAccountLinkAction": { + "description": "Specifies the account linking action for an IdP user", + "enum": [ + "AUTO", + "DISABLED" + ], + "type": "string", + "x-enumDescriptions": { + "AUTO": "The IdP user is automatically linked to an Okta user when the transformed IdP user matches an existing Okta user according to [subject match rules](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=policy/subject&t=request).", + "DISABLED": "Okta never attempts to link the IdP user to an existing Okta user, but may still attempt to provision a new Okta user according to the [provisioning action type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=policy/provisioning/action&t=request)." + } + }, + "PolicyAccountLinkFilter": { + "description": "Specifies filters on which users are available for account linking by an IdP", + "properties": { + "groups": { + "$ref": "#/components/schemas/PolicyAccountLinkFilterGroups" + }, + "users": { + "$ref": "#/components/schemas/PolicyAccountLinkFilterUsers" + } + }, + "type": "object" + }, + "PolicyAccountLinkFilterGroups": { + "description": "Group memberships used to determine link candidates", + "properties": { + "include": { + "description": "Specifies the allowlist of Group identifiers to match against. Group memberships are restricted to type `OKTA_GROUP`.", + "items": { + "example": "00gjg5lzfBpn62wuF0g3", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "PolicyAccountLinkFilterUsers": { + "description": "Filters on which users are available for account linking", + "properties": { + "exclude": { + "description": "Specifies the blocklist of user identifiers to exclude from account linking", + "items": { + "example": "00u2c0nz7wj4UBs8V0g5", + "type": "string" + }, + "type": "array" + }, + "excludeAdmins": { + "default": false, + "description": "Specifies whether admin users should be excluded from account linking", + "type": "boolean" + } + }, + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "PolicyCommon": { + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/PolicyLinks" + }, + "created": { + "default": "Assigned", + "description": "Timestamp when the policy was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "default": null, + "description": "Description of the policy", + "type": "string" + }, + "id": { + "default": "Assigned", + "description": "Identifier of the policy", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "default": "Assigned", + "description": "Timestamp when the policy was last modified", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the policy", + "type": "string" + }, + "priority": { + "default": "Last / Lowest Priority, for example `1`", + "description": "Specifies the order in which this policy is evaluated in relation to the other policies", + "type": "integer" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "Whether or not the policy is active. Use the `activate` query parameter to set the status of a policy." + } + ] + }, + "system": { + "default": false, + "description": "Specifies whether Okta created the policy", + "type": "boolean" + }, + "type": { + "$ref": "#/components/schemas/PolicyType" + } + }, + "required": [ + "name", + "type" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PolicyContext": { + "properties": { + "device": { + "properties": { + "assuranceId": { + "description": "The device assurance policy ID for the simulation", + "type": "string" + }, + "managed": { + "description": "If the device is managed", + "type": "boolean" + }, + "platform": { + "description": "The platform of the device, for example, IOS.", + "type": "string" + }, + "registered": { + "description": "If the device is registered", + "type": "boolean" + } + }, + "type": "object" + }, + "groups": { + "description": "An array of Group IDs for the simulate operation. Only user IDs or Group IDs are allowed, not both.", + "properties": { + "ids": { + "items": { + "type": "string", + "uniqueItems": true + }, + "type": "array" + } + }, + "required": [ + "ids" + ], + "type": "object" + }, + "ip": { + "description": "The network rule condition, zone, or IP address", + "type": "string" + }, + "risk": { + "description": "The risk rule condition level", + "properties": { + "level": { + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ], + "type": "string" + }, + "minRiskLevel": { + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ], + "type": "string", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "type": "object" + }, + "user": { + "description": "The user ID for the simulate operation. Only user IDs or Group IDs are allowed, not both.", + "properties": { + "id": { + "description": "The unique ID number for the user.", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "zones": { + "description": "The zone ID under the network rule condition.", + "properties": { + "ids": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "required": [ + "user", + "groups" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PolicyLinks": { + "properties": { + "activate": { + "$ref": "#/components/schemas/HrefObjectActivateLink" + }, + "deactivate": { + "$ref": "#/components/schemas/HrefObjectDeactivateLink" + }, + "mappings": { + "$ref": "#/components/schemas/HrefObjectMappingsLink" + }, + "rules": { + "$ref": "#/components/schemas/HrefObjectRulesLink" + }, + "self": { + "$ref": "#/components/schemas/HrefObjectSelfLink" + } + }, + "readOnly": true, + "type": "object" + }, + "PolicyMapping": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "application": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the mapped application" + } + ] + }, + "policy": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the mapped policy" + } + ] + } + } + } + ] + }, + "id": { + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PolicyMappingRequest": { + "properties": { + "resourceId": { + "description": "[Policy ID](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/policy/#tag/Policy/operation/listPolicies!c=200&path=0/id&t=response) of the app sign-in policy that you want to map", + "type": "string" + }, + "resourceType": { + "$ref": "#/components/schemas/PolicyMappingResourceType" + } + }, + "type": "object" + }, + "PolicyMappingResourceType": { + "description": "Specifies the type of resource to map. You can only map an app sign-in policy to a device signal collection policy (the `policyId` path parameter).", + "enum": [ + "ACCESS_POLICY" + ], + "type": "string" + }, + "PolicyNetworkCondition": { + "description": "Specifies a network selection mode and a set of network zones to be included or excluded. If the connection parameter's data type is `ZONE`, one of the `include` or `exclude` arrays is required. Specific zone IDs to include or exclude are enumerated in the respective arrays.", + "properties": { + "connection": { + "$ref": "#/components/schemas/PolicyNetworkConnection" + }, + "exclude": { + "description": "The zones to exclude. Required only if connection data type is `ZONE`", + "items": { + "type": "string" + }, + "type": "array" + }, + "include": { + "description": "The zones to include. Required only if connection data type is `ZONE`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "PolicyNetworkConnection": { + "description": "Network selection mode", + "enum": [ + "ANYWHERE", + "ZONE" + ], + "type": "string" + }, + "PolicyPeopleCondition": { + "description": "Specifies the users and groups that are included or excluded by the policy rule", + "properties": { + "groups": { + "$ref": "#/components/schemas/GroupCondition" + }, + "users": { + "$ref": "#/components/schemas/UserCondition" + } + }, + "type": "object" + }, + "PolicyPlatformOperatingSystemType": { + "description": "The type of operating system", + "enum": [ + "ANDROID", + "ANY", + "CHROMEOS", + "IOS", + "MACOS", + "OTHER", + "WINDOWS", + "LINUX" + ], + "type": "string" + }, + "PolicyPlatformType": { + "description": "The type of platform", + "enum": [ + "ANY", + "DESKTOP", + "MOBILE", + "OTHER" + ], + "type": "string" + }, + "PolicyRule": { + "discriminator": { + "mapping": { + "ACCESS_POLICY": "#/components/schemas/AccessPolicyRule", + "CLIENT_UPDATE": "#/components/schemas/ClientUpdatePolicyRule", + "DEVICE_SIGNAL_COLLECTION": "#/components/schemas/DeviceSignalCollectionPolicyRule", + "ENTITY_RISK": "#/components/schemas/EntityRiskPolicyRule", + "IDENTITY_CLAIM_SOURCING": "#/components/schemas/IdentityClaimSourcingPolicyRule", + "IDP_DISCOVERY": "#/components/schemas/IdpDiscoveryPolicyRule", + "MFA_ENROLL": "#/components/schemas/AuthenticatorEnrollmentPolicyRule", + "PASSWORD": "#/components/schemas/PasswordPolicyRule", + "POST_AUTH_SESSION": "#/components/schemas/PostAuthSessionPolicyRule", + "PROFILE_ENROLLMENT": "#/components/schemas/ProfileEnrollmentPolicyRule", + "SESSION_VIOLATION_DETECTION": "#/components/schemas/SessionViolationDetectionPolicyRule", + "SIGN_ON": "#/components/schemas/OktaSignOnPolicyRule" + }, + "propertyName": "type" + }, + "properties": { + "_links": { + "$ref": "#/components/schemas/PolicyLinks" + }, + "created": { + "description": "Timestamp when the rule was created", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Identifier for the rule", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the rule was last modified", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the rule", + "type": "string" + }, + "priority": { + "description": "Priority of the rule", + "nullable": true, + "type": "integer" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "Whether or not the rule is active. Use the `activate` query parameter to set the status of a rule." + } + ] + }, + "system": { + "default": false, + "description": "Specifies whether Okta created the policy rule (`system=true`). You can't delete policy rules that have `system` set to `true`.", + "type": "boolean" + }, + "type": { + "$ref": "#/components/schemas/PolicyRuleType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PolicyRuleActions": { + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PolicyRuleActionsEnroll": { + "properties": { + "self": { + "$ref": "#/components/schemas/PolicyRuleActionsEnrollSelf" + } + }, + "type": "object" + }, + "PolicyRuleActionsEnrollSelf": { + "enum": [ + "CHALLENGE", + "LOGIN", + "NEVER", + "NEVER_INCLUDING_RECOVERY" + ], + "type": "string" + }, + "PolicyRuleAuthContextCondition": { + "description": "Specifies an authentication entry point", + "properties": { + "authType": { + "$ref": "#/components/schemas/PolicyRuleAuthContextType" + } + }, + "type": "object" + }, + "PolicyRuleAuthContextType": { + "description": "Specifies how the user is authenticated", + "enum": [ + "ANY", + "LDAP_INTERFACE", + "RADIUS" + ], + "type": "string" + }, + "PolicyRuleConditions": { + "properties": { + "app": { + "$ref": "#/components/schemas/AppAndInstancePolicyRuleCondition" + }, + "apps": { + "$ref": "#/components/schemas/AppInstancePolicyRuleCondition" + }, + "authContext": { + "$ref": "#/components/schemas/PolicyRuleAuthContextCondition" + }, + "authProvider": { + "$ref": "#/components/schemas/PasswordPolicyAuthenticationProviderCondition" + }, + "beforeScheduledAction": { + "$ref": "#/components/schemas/BeforeScheduledActionPolicyRuleCondition" + }, + "clients": { + "$ref": "#/components/schemas/ClientPolicyCondition" + }, + "context": { + "$ref": "#/components/schemas/ContextPolicyRuleCondition" + }, + "device": { + "$ref": "#/components/schemas/DevicePolicyRuleCondition" + }, + "grantTypes": { + "$ref": "#/components/schemas/GrantTypePolicyRuleCondition" + }, + "groups": { + "$ref": "#/components/schemas/GroupPolicyRuleCondition" + }, + "identityProvider": { + "$ref": "#/components/schemas/IdentityProviderPolicyRuleCondition" + }, + "mdmEnrollment": { + "$ref": "#/components/schemas/MDMEnrollmentPolicyRuleCondition" + }, + "network": { + "$ref": "#/components/schemas/PolicyNetworkCondition" + }, + "people": { + "$ref": "#/components/schemas/PolicyPeopleCondition" + }, + "platform": { + "$ref": "#/components/schemas/PlatformPolicyRuleCondition" + }, + "risk": { + "$ref": "#/components/schemas/RiskPolicyRuleCondition" + }, + "riskScore": { + "$ref": "#/components/schemas/RiskScorePolicyRuleCondition" + }, + "scopes": { + "$ref": "#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition" + }, + "userIdentifier": { + "$ref": "#/components/schemas/UserIdentifierPolicyRuleCondition" + }, + "userStatus": { + "$ref": "#/components/schemas/UserStatusPolicyRuleCondition" + }, + "users": { + "$ref": "#/components/schemas/UserPolicyRuleCondition" + } + }, + "type": "object" + }, + "PolicyRuleType": { + "description": "Rule type", + "enum": [ + "ACCESS_POLICY", + "DEVICE_SIGNAL_COLLECTION", + "ENTITY_RISK", + "IDP_DISCOVERY", + "MFA_ENROLL", + "PASSWORD", + "POST_AUTH_SESSION", + "PROFILE_ENROLLMENT", + "SIGN_ON", + "SESSION_VIOLATION_DETECTION", + "CLIENT_UPDATE", + "IDENTITY_CLAIM_SOURCING" + ], + "type": "string" + }, + "PolicyRuleVerificationMethodType": { + "description": "Verification method type", + "enum": [ + "ASSURANCE", + "AUTH_METHOD_CHAIN", + "ID_PROOFING" + ], + "type": "string" + }, + "PolicySubject": { + "description": "Specifies the behavior for establishing, validating, and matching a username for an IdP user", + "properties": { + "filter": { + "description": "Optional [regular expression pattern](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions) used to filter untrusted IdP usernames.\n* As a best security practice, you should define a regular expression pattern to filter untrusted IdP usernames. This is especially important if multiple IdPs are connected to your org. The filter prevents an IdP from issuing an assertion for any user, including partners or directory users in your Okta org.\n* For example, the filter pattern `(\\S+@example\\.com)` allows only Users that have an `@example.com` username suffix. It rejects assertions that have any other suffix such as `@corp.example.com` or `@partner.com`.\n* Only `SAML2` and `OIDC` IdP providers support the `filter` property.", + "example": "(\\S+@example\\.com)", + "maxLength": 1024, + "type": "string" + }, + "matchAttribute": { + "description": "Okta user profile attribute for matching a transformed IdP username. Only for matchType `CUSTOM_ATTRIBUTE`.\nThe `matchAttribute` must be a valid Okta user profile attribute of one of the following types:\n* String (with no format or 'email' format only)\n* Integer\n* Number", + "example": "login", + "type": "string" + }, + "matchType": { + "$ref": "#/components/schemas/PolicySubjectMatchType" + }, + "userNameTemplate": { + "$ref": "#/components/schemas/PolicyUserNameTemplate" + } + }, + "type": "object" + }, + "PolicySubjectMatchType": { + "description": "Determines the Okta user profile attribute match conditions for account linking and authentication of the transformed IdP username", + "enum": [ + "CUSTOM_ATTRIBUTE", + "EMAIL", + "USERNAME", + "USERNAME_OR_EMAIL" + ], + "type": "string" + }, + "PolicyType": { + "description": "All Okta orgs contain only one IdP discovery policy with an immutable default rule routing to your org's sign-in page. All Okta orgs also contain just one entity risk policy, one session protection policy, and one identity claims sourcing policy.", + "enum": [ + "ACCESS_POLICY", + "ENTITY_RISK", + "IDP_DISCOVERY", + "MFA_ENROLL", + "OKTA_SIGN_ON", + "PASSWORD", + "POST_AUTH_SESSION", + "PROFILE_ENROLLMENT", + "DEVICE_SIGNAL_COLLECTION", + "SESSION_VIOLATION_DETECTION", + "CLIENT_UPDATE", + "IDENTITY_CLAIM_SOURCING" + ], + "type": "string", + "x-enumDescriptions": { + "ACCESS_POLICY": "<x-lifecycle class=\"oie\"></x-lifecycle>App sign-in policy", + "CLIENT_UPDATE": "<x-lifecycle class=\"oie\"></x-lifecycle>(Read-only) Client update policy", + "DEVICE_SIGNAL_COLLECTION": "<x-lifecycle class=\"oie\"></x-lifecycle><x-lifecycle class=\"ea\"></x-lifecycle>Device signal collection policy", + "ENTITY_RISK": "<x-lifecycle class=\"oie\"></x-lifecycle>(Read-only) Entity risk policy", + "IDENTITY_CLAIM_SOURCING": "<x-lifecycle class=\"oie\"></x-lifecycle><x-lifecycle class=\"ea\"></x-lifecycle>(Read-only) Identity claims sourcing policy", + "IDP_DISCOVERY": "(Read-only) IdP discovery policy", + "MFA_ENROLL": "Authenticator enrollment policy", + "OKTA_SIGN_ON": "Global session policy", + "PASSWORD": "Password policy", + "POST_AUTH_SESSION": "<x-lifecycle class=\"oie\"></x-lifecycle>(Read-only) Session violation enforcement policy", + "PROFILE_ENROLLMENT": "<x-lifecycle class=\"oie\"></x-lifecycle>User profile policy", + "SESSION_VIOLATION_DETECTION": "<x-lifecycle class=\"oie\"></x-lifecycle>(Read-only) Session violation detection policy" + } + }, + "PolicyTypeSimulation": { + "enum": [ + "ACCESS_POLICY", + "MFA_ENROLL", + "OKTA_SIGN_ON", + "PROFILE_ENROLLMENT" + ], + "type": "string" + }, + "PolicyUserNameTemplate": { + "description": "[Okta Expression Language (EL) expression](https://developer.okta.com/docs/reference/okta-expression-language/) to generate or transform a unique username for the IdP user.\n* IdP user profile attributes can be referenced with the `idpuser` prefix such as `idpuser.subjectNameId`.\n* You must define an IdP user profile attribute before it can be referenced in an Okta EL expression. To define an IdP user attribute policy, you may need to create a new IdP instance without a base profile property. Then edit the IdP user profile to update the IdP instance with an expression that references the IdP user profile attribute that you just created.", + "properties": { + "template": { + "example": "idpuser.subjectNameId", + "maxLength": 1024, + "minLength": 9, + "type": "string" + } + }, + "type": "object" + }, + "PolicyUserStatus": { + "enum": [ + "ACTIVATING", + "ACTIVE", + "DELETED", + "DELETING", + "EXPIRED_PASSWORD", + "INACTIVE", + "PENDING", + "SUSPENDED" + ], + "type": "string" + }, + "PossessionConstraint": { + "allOf": [ + { + "$ref": "#/components/schemas/AccessPolicyConstraint" + }, + { + "properties": { + "deviceBound": { + "default": "OPTIONAL", + "description": "Indicates if device-bound Factors are required. This property is only set for `POSSESSION` constraints.", + "enum": [ + "OPTIONAL", + "REQUIRED" + ], + "type": "string" + }, + "hardwareProtection": { + "default": "OPTIONAL", + "description": "Indicates if any secrets or private keys used during authentication must be hardware protected and not exportable. This property is only set for `POSSESSION` constraints.", + "enum": [ + "OPTIONAL", + "REQUIRED" + ], + "type": "string" + }, + "phishingResistant": { + "default": "OPTIONAL", + "description": "Indicates if phishing-resistant Factors are required. This property is only set for `POSSESSION` constraints.", + "enum": [ + "OPTIONAL", + "REQUIRED" + ], + "type": "string" + }, + "userPresence": { + "default": "REQUIRED", + "description": "Indicates if the user needs to approve an Okta Verify prompt or provide biometrics (meets NIST AAL2 requirements). This property is only set for `POSSESSION` constraints.", + "enum": [ + "OPTIONAL", + "REQUIRED" + ], + "type": "string" + }, + "userVerification": { + "default": "OPTIONAL", + "description": "Indicates the user interaction requirement (PIN or biometrics) to ensure verification of a possession factor", + "enum": [ + "OPTIONAL", + "REQUIRED" + ], + "type": "string" + }, + "userVerificationMethods": { + "description": "Indicates which methods can be used for user verification. `userVerificationMethods` can only be used when `userVerification` is `REQUIRED`. `BIOMETRICS` is currently the only supported method.", + "items": { + "enum": [ + "BIOMETRICS", + "PIN" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "PostAuthKeepMeSignedInPrompt": { + "properties": { + "acceptButtonText": { + "description": "The label on the accept button when prompting for Stay signed in", + "type": "string" + }, + "rejectButtonText": { + "description": "The label on the reject button when prompting for Stay signed in", + "type": "string" + }, + "subtitle": { + "description": "The subtitle on the Sign-In Widget when prompting for Stay signed in", + "type": "string" + }, + "title": { + "description": "The title on the Sign-In Widget when prompting for Stay signed in", + "type": "string" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "PostAuthSessionFailureActionsObject": { + "discriminator": { + "mapping": { + "RUN_WORKFLOW": "#/components/schemas/PostAuthSessionPolicyRuleRunWorkflow", + "TERMINATE_SESSION": "#/components/schemas/PostAuthSessionPolicyRuleTerminateSession" + }, + "propertyName": "action" + }, + "properties": { + "action": { + "enum": [ + "RUN_WORKFLOW", + "TERMINATE_SESSION" + ], + "type": "string" + } + }, + "type": "object" + }, + "PostAuthSessionPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "conditions": { + "default": null, + "description": "Policy conditions aren't supported for this policy type", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "PostAuthSessionPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "description": "The action to take in response to a failure of the reevaluated global session policy or authentication polices", + "properties": { + "postAuthSession": { + "description": "This object contains a `failureActions` array that defines the specific action to take when the session protection policy detects a failure", + "properties": { + "failureActions": { + "description": "An array of objects that define the action. It can be empty or contain two `action` value pairs.", + "items": { + "$ref": "#/components/schemas/PostAuthSessionFailureActionsObject" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "conditions": { + "description": "Specifies conditions that must be met during policy evaluation to apply the rule. All policy conditions and conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule.", + "properties": { + "people": { + "$ref": "#/components/schemas/PolicyPeopleCondition" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "PostAuthSessionPolicyRuleRunWorkflow": { + "properties": { + "action": { + "enum": [ + "RUN_WORKFLOW" + ], + "type": "string" + }, + "workflow": { + "description": "This action runs a workflow", + "properties": { + "id": { + "description": "The `id` of the workflow that runs.", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "PostAuthSessionPolicyRuleTerminateSession": { + "properties": { + "action": { + "description": "The action to take when the session protection policy detects a failure.", + "enum": [ + "TERMINATE_SESSION" + ], + "type": "string" + } + }, + "type": "object" + }, + "PreRegistrationInlineHook": { + "properties": { + "inlineHookId": { + "type": "string" + } + }, + "type": "object" + }, + "PrincipalRateLimitEntity": { + "description": "", + "properties": { + "createdBy": { + "description": "The Okta user ID of the user who created the principle rate limit entity", + "readOnly": true, + "type": "string" + }, + "createdDate": { + "description": "The date and time the principle rate limit entity was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "defaultConcurrencyPercentage": { + "description": "The default percentage of a given concurrency limit threshold that the owning principal can consume", + "type": "integer" + }, + "defaultPercentage": { + "description": "The default percentage of a given rate limit threshold that the owning principal can consume", + "type": "integer" + }, + "id": { + "description": "The unique identifier of the principle rate limit entity", + "readOnly": true, + "type": "string" + }, + "lastUpdate": { + "description": "The date and time the principle rate limit entity was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastUpdatedBy": { + "description": "The Okta user ID of the user who last updated the principle rate limit entity", + "readOnly": true, + "type": "string" + }, + "orgId": { + "description": "The unique identifier of the Okta org", + "readOnly": true, + "type": "string" + }, + "principalId": { + "description": "The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.", + "type": "string" + }, + "principalType": { + "$ref": "#/components/schemas/PrincipalType" + } + }, + "required": [ + "principalId", + "principalType" + ], + "title": "PrincipalRateLimitEntity", + "type": "object" + }, + "PrincipalType": { + "description": "The type of principal, either an API token or an OAuth 2.0 app", + "enum": [ + "OAUTH_CLIENT", + "SSWS_TOKEN" + ], + "type": "string" + }, + "PrivilegedResource": { + "description": "Base class for PrivilegedResourceRequest and PrivilegedResourceResponse", + "discriminator": { + "mapping": { + "APP_ACCOUNT": "#/components/schemas/PrivilegedResourceAccountAppRequest", + "OKTA_USER_ACCOUNT": "#/components/schemas/PrivilegedResourceAccountOkta" + }, + "propertyName": "resourceType" + }, + "properties": { + "created": { + "description": "Timestamp when the object was created", + "example": "2024-06-10T11:11:01.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "credentialSyncInfo": { + "$ref": "#/components/schemas/CredentialSyncInfo" + }, + "id": { + "description": "ID of the privileged resource", + "example": "opa100xTfFs4MasRf0g4", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the object was last updated", + "example": "2024-06-10T11:13:01.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resourceType": { + "$ref": "#/components/schemas/PrivilegedResourceType" + }, + "status": { + "$ref": "#/components/schemas/PrivilegedResourceStatus" + } + }, + "required": [ + "resourceType" + ], + "type": "object" + }, + "PrivilegedResourceAccountAppRequest": { + "allOf": [ + { + "properties": { + "containerDetails": { + "$ref": "#/components/schemas/AppAccountContainerDetails" + }, + "credentials": { + "$ref": "#/components/schemas/PrivilegedResourceCredentials" + } + }, + "type": "object" + }, + { + "$ref": "#/components/schemas/PrivilegedResource" + } + ], + "required": [ + "containerId" + ] + }, + "PrivilegedResourceAccountAppResponse": { + "allOf": [ + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/PrivilegedResourceCredentials" + }, + "profile": { + "$ref": "#/components/schemas/profile" + } + }, + "type": "object" + }, + { + "$ref": "#/components/schemas/PrivilegedResource" + } + ] + }, + "PrivilegedResourceAccountOkta": { + "allOf": [ + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/PrivilegedResourceCredentials" + }, + "profile": { + "$ref": "#/components/schemas/profile" + }, + "resourceId": { + "description": "The user ID associated with the Okta privileged resource", + "example": "00u100xTfFs4MasRf0g4", + "type": "string" + } + }, + "type": "object" + }, + { + "$ref": "#/components/schemas/PrivilegedResource" + } + ] + }, + "PrivilegedResourceCredentials": { + "description": "Credentials for the privileged resource", + "properties": { + "password": { + "description": "The password associated with the privileged resource", + "example": "xf1bs9am2", + "format": "password", + "type": "string", + "writeOnly": true + }, + "userName": { + "description": "The username associated with the privileged resource", + "example": "testuser@example.com", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "userName" + ], + "type": "object" + }, + "PrivilegedResourceFilters": { + "properties": { + "appGroups": { + "description": "Array of app groups whose members might be privileged app users", + "items": { + "$ref": "#/components/schemas/AppGroup" + }, + "type": "array" + }, + "organizationalUnits": { + "description": "Array of organizational units where privileged app users are present", + "items": { + "$ref": "#/components/schemas/OrganizationalUnit" + }, + "type": "array" + } + }, + "type": "object" + }, + "PrivilegedResourceStatus": { + "description": "Current status of the privileged resource", + "enum": [ + "ACTIVE", + "CREATED", + "CREATION_FAILED", + "INACTIVE", + "PENDING" + ], + "readOnly": true, + "type": "string", + "x-enumDescriptions": { + "ACTIVE": "The privileged resource is currently managed by OPA", + "CREATED": "The privileged resource is created but not yet managed by OPA", + "CREATION_FAILED": "The privileged resource creation failed", + "INACTIVE": "The privileged resource is `INACTIVE` and not currently managed by OPA", + "PENDING": "The privileged resource is pending creation in Okta" + } + }, + "PrivilegedResourceType": { + "description": "The type of the resource", + "enum": [ + "APP_ACCOUNT", + "OKTA_USER_ACCOUNT" + ], + "type": "string", + "x-enumDescriptions": { + "APP_ACCOUNT": "Represents a privileged resource that belongs to an app", + "OKTA_USER_ACCOUNT": "Represents a privileged resource that belongs to Okta" + } + }, + "PrivilegedResourceUpdateRequest": { + "description": "Update request for a privileged resource", + "properties": { + "profile": { + "$ref": "#/components/schemas/profile" + }, + "userName": { + "description": "The username associated with the privileged resource", + "example": "testuser@example.com", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ProfileEnrollmentPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "conditions": { + "default": null, + "description": "Policy conditions aren't supported for this policy type", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "ProfileEnrollmentPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "$ref": "#/components/schemas/ProfileEnrollmentPolicyRuleActions" + }, + "conditions": { + "default": null, + "description": "Policy rule conditions aren't supported for this policy type.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "ProfileEnrollmentPolicyRuleAction": { + "properties": { + "access": { + "description": "Indicates if the user profile is granted access\n\n> **Note:** You can't set the `access` property to `DENY` after you create the policy", + "enum": [ + "ALLOW", + "DENY" + ], + "type": "string" + }, + "activationRequirements": { + "$ref": "#/components/schemas/ProfileEnrollmentPolicyRuleActivationRequirement" + }, + "allowedIdentifiers": { + "default": [ + "login" + ], + "description": "A list of attributes to identify an end user. Can be used across Okta sign-in, unlock, and recovery flows.", + "items": { + "type": "string" + }, + "type": "array" + }, + "enrollAuthenticatorTypes": { + "description": "Additional authenticator fields that can be used on the first page of user registration. Valid values only includes `'password'`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "preRegistrationInlineHooks": { + "description": "(Optional) The `id` of at most one registration inline hook", + "items": { + "$ref": "#/components/schemas/PreRegistrationInlineHook" + }, + "type": "array" + }, + "profileAttributes": { + "description": "A list of attributes to prompt the user for during registration or progressive profiling. Where defined on the user schema, these attributes are persisted in the user profile. You can also add non-schema attributes, which aren't persisted to the user's profile, but are included in requests to the registration inline hook. A maximum of 10 profile properties is supported.", + "items": { + "$ref": "#/components/schemas/ProfileEnrollmentPolicyRuleProfileAttribute" + }, + "type": "array" + }, + "progressiveProfilingAction": { + "description": "Progressive profile enrollment helps evaluate the user profile policy at every user login. Users can be prompted to provide input for newly required attributes.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "targetGroupIds": { + "description": "(Optional, max 1 entry) The `id` of a group that this user should be added to", + "items": { + "type": "string" + }, + "type": "array" + }, + "uiSchemaId": { + "description": "Value created by the backend. If present, all policy updates must include this attribute/value.", + "type": "string" + }, + "unknownUserAction": { + "description": "Which action should be taken if this user is new", + "enum": [ + "DENY", + "REGISTER" + ], + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ProfileEnrollmentPolicyRuleActions": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRuleActions" + }, + { + "type": "object" + }, + { + "description": "Specifies the settings that govern which profile attributes are required for creating new users", + "properties": { + "profileEnrollment": { + "$ref": "#/components/schemas/ProfileEnrollmentPolicyRuleAction" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ProfileEnrollmentPolicyRuleActivationRequirement": { + "description": "Contains a single Boolean property that indicates whether `emailVerification` should occur (`true`) or not (`false`, default)", + "properties": { + "emailVerification": { + "type": "boolean" + } + }, + "type": "object" + }, + "ProfileEnrollmentPolicyRuleProfileAttribute": { + "properties": { + "label": { + "description": "A display-friendly label for this property", + "type": "string" + }, + "name": { + "description": "The name of a user profile property. Can be an existing property.", + "type": "string" + }, + "required": { + "default": false, + "description": "(Optional, default `FALSE`) Indicates if this property is required for enrollment", + "type": "boolean" + } + }, + "type": "object" + }, + "ProfileMapping": { + "description": "The profile mapping object describes a mapping between an Okta user's and an app user's properties using [JSON Schema Draft 4](https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-04).\n\n> **Note:** Same type source/target mappings aren't supported by this API. Profile mappings must be between Okta and an app.", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "id": { + "description": "Unique identifier for a profile mapping", + "readOnly": true, + "type": "string" + }, + "properties": { + "$ref": "#/components/schemas/ProfileMappingProperty", + "readOnly": false, + "type": "object" + }, + "source": { + "$ref": "#/components/schemas/ProfileMappingSource" + }, + "target": { + "$ref": "#/components/schemas/ProfileMappingTarget" + } + }, + "type": "object" + }, + "ProfileMappingProperty": { + "description": "A target property, in string form, that maps to a valid [JSON Schema Draft](https://tools.ietf.org/html/draft-zyp-json-schema-04) document.", + "properties": { + "expression": { + "description": "Combination or single source properties that are mapped to the target property. See [Okta Expression Language](https://developer.okta.com/docs/reference/okta-expression-language/).", + "type": "string" + }, + "pushStatus": { + "$ref": "#/components/schemas/ProfileMappingPropertyPushStatus" + } + }, + "type": "object" + }, + "ProfileMappingPropertyPushStatus": { + "description": "Indicates whether to update target properties for user create and update or just for user create.\n\n- Having a pushStatus of `PUSH` causes properties in the target to be updated on create and update. \n- Having a pushStatus of `DONT_PUSH` causes properties in the target to be updated only on create.", + "enum": [ + "DONT_PUSH", + "PUSH" + ], + "type": "string" + }, + "ProfileMappingRequest": { + "description": "The updated request body properties", + "properties": { + "properties": { + "$ref": "#/components/schemas/ProfileMappingProperty", + "type": "object" + } + }, + "required": [ + "properties", + "expression", + "pushStatus" + ], + "type": "object" + }, + "ProfileMappingSource": { + "description": "The parameter is the source of a profile mapping and is a valid [JSON Schema Draft 4](https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-04) document with the following properties. The data type can be an app instance or an Okta object.\n\n> **Note:** If the source is Okta and the UserTypes feature isn't enabled, then the source `_links` only has a link to the schema.", + "properties": { + "_links": { + "$ref": "#/components/schemas/SourceLinks" + }, + "id": { + "description": "Unique identifier for the application instance or userType", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Variable name of the application instance or name of the referenced UserType", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Type of user referenced in the mapping", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ProfileMappingTarget": { + "description": "The parameter is the target of a profile mapping and is a valid [JSON Schema Draft 4](https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-04) document with the following properties. The data type can be an app instance or an Okta object.\n\n > **Note:** If the target is Okta and the UserTypes feature isn't enabled, then the target `_links` only has a link to the schema.", + "properties": { + "_links": { + "$ref": "#/components/schemas/SourceLinks" + }, + "id": { + "description": "Unique identifier for the application instance or UserType", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Variable name of the application instance or name of the referenced userType", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Type of user referenced in the mapping", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ProfileSettingObject": { + "description": "This setting determines whether a user in the app gets updated when they're updated in Okta.\n\nIf enabled, Okta updates a user's attributes in the app when the app is assigned.\nFuture changes made to the Okta user's profile automatically overwrite the corresponding attribute value in the app.\n", + "properties": { + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/EnabledStatus" + }, + { + "example": "DISABLED" + }, + { + "default": "DISABLED" + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "Protocol": { + "enum": [ + "ACTIONS", + "GTR", + "ID_PROOFING", + "OAUTH2", + "OIDC", + "SAML", + "SCIM" + ], + "type": "string" + }, + "ProtocolAlgorithmRequestScope": { + "description": "Specifies whether to digitally sign authorization requests to the IdP", + "enum": [ + "NONE", + "REQUEST" + ], + "example": "REQUEST", + "type": "string" + }, + "ProtocolAlgorithmResponseScope": { + "description": "Specifies whether to verify responses from the IdP", + "enum": [ + "ANY", + "RESPONSE", + "TOKEN" + ], + "example": "ANY", + "type": "string" + }, + "ProtocolCredentialsKeyId": { + "description": "IdP key credential reference to the Okta X.509 signature certificate", + "example": "your-key-id", + "type": "string" + }, + "ProtocolEndpointBinding": { + "enum": [ + "HTTP-POST", + "HTTP-REDIRECT" + ], + "type": "string" + }, + "ProtocolIdVerification": { + "description": "Protocol settings for the IDV vendor", + "properties": { + "credentials": { + "$ref": "#/components/schemas/IDVCredentials" + }, + "endpoints": { + "$ref": "#/components/schemas/IDVEndpoints" + }, + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "type": { + "description": "ID verification protocol", + "enum": [ + "ID_PROOFING" + ], + "type": "string" + } + }, + "title": "ID Verification", + "type": "object" + }, + "ProtocolMtls": { + "description": "Protocol settings for the [MTLS Protocol](https://tools.ietf.org/html/rfc5246#section-7.4.4)", + "properties": { + "credentials": { + "$ref": "#/components/schemas/MtlsCredentials" + }, + "endpoints": { + "$ref": "#/components/schemas/MtlsEndpoints" + }, + "type": { + "description": "Mutual TLS", + "enum": [ + "MTLS" + ], + "type": "string" + } + }, + "title": "Mutual TLS Protocol", + "type": "object" + }, + "ProtocolOAuth": { + "description": "Protocol settings for authentication using the [OAuth 2.0 Authorization Code flow](https://tools.ietf.org/html/rfc6749#section-4.1)", + "properties": { + "credentials": { + "$ref": "#/components/schemas/OAuthCredentials" + }, + "endpoints": { + "$ref": "#/components/schemas/OAuthEndpoints" + }, + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "type": { + "description": "OAuth 2.0 Authorization Code flow", + "enum": [ + "OAUTH2" + ], + "type": "string" + } + }, + "title": "OAuth 2.0 Protocol", + "type": "object" + }, + "ProtocolOidc": { + "description": "Protocol settings for authentication using the [OpenID Connect Protocol](http://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth)", + "properties": { + "algorithms": { + "$ref": "#/components/schemas/OidcAlgorithms" + }, + "credentials": { + "$ref": "#/components/schemas/OAuthCredentials" + }, + "endpoints": { + "$ref": "#/components/schemas/OAuthEndpoints" + }, + "issuer": { + "$ref": "#/components/schemas/OidcIssuer" + }, + "oktaIdpOrgUrl": { + "description": "URL of the IdP org", + "example": "https://idp.example.com", + "type": "string" + }, + "scopes": { + "description": "OpenID Connect and IdP-defined permission bundles to request delegated access from the user\n> **Note:** The [IdP type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=type&t=request) table lists the scopes that are supported for each IdP.", + "items": { + "example": "openid", + "type": "string" + }, + "type": "array" + }, + "settings": { + "$ref": "#/components/schemas/OidcSettings" + }, + "type": { + "description": "OpenID Connect Authorization Code flow", + "enum": [ + "OIDC" + ], + "type": "string" + } + }, + "title": "OpenID Connect Protocol", + "type": "object" + }, + "ProtocolSaml": { + "description": "Protocol settings for the [SAML 2.0 Authentication Request Protocol](http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf)", + "properties": { + "algorithms": { + "$ref": "#/components/schemas/SamlAlgorithms" + }, + "credentials": { + "$ref": "#/components/schemas/SamlCredentials" + }, + "endpoints": { + "$ref": "#/components/schemas/SamlEndpoints" + }, + "relayState": { + "$ref": "#/components/schemas/SamlRelayState" + }, + "settings": { + "$ref": "#/components/schemas/SamlSettings" + }, + "type": { + "description": "SAML 2.0 protocol", + "enum": [ + "SAML2" + ], + "type": "string" + } + }, + "title": "SAML 2.0 Protocol", + "type": "object" + }, + "ProviderType": { + "enum": [ + "APNS", + "FCM" + ], + "type": "string" + }, + "Provisioning": { + "description": "Specifies the behavior for just-in-time (JIT) provisioning of an IdP user as a new Okta user and their group memberships", + "properties": { + "action": { + "$ref": "#/components/schemas/ProvisioningAction" + }, + "conditions": { + "$ref": "#/components/schemas/ProvisioningConditions" + }, + "groups": { + "$ref": "#/components/schemas/ProvisioningGroups" + }, + "profileMaster": { + "description": "Determines if the IdP should act as a source of truth for user profile attributes", + "type": "boolean" + } + }, + "type": "object" + }, + "ProvisioningAction": { + "description": "Specifies the user provisioning action during authentication when an IdP user isn't linked to an existing Okta user.\n* To successfully provision a new Okta user, you must enable just-in-time (JIT) provisioning in your org security settings.\n* If the target username isn't unique or the resulting Okta user profile is missing a required profile attribute, JIT provisioning may fail.\n* New Okta users are provisioned with either a `FEDERATION` or `SOCIAL` authentication provider depending on the IdP type.", + "enum": [ + "AUTO", + "DISABLED" + ], + "type": "string", + "x-enumDescriptions": { + "AUTO": "The IdP user profile is transformed through defined universal directory profile mappings to an Okta user profile and automatically provisioned as an Okta user.", + "DISABLED": "Okta rejects the authentication request and skips provisioning of a new Okta user if the IdP user isn't linked to an existing Okta user." + } + }, + "ProvisioningCapability": { + "description": "Provisioning capability configuration with embedded protocol details.\n\n*Protocol validation rule:**\n- The `actions` parameter is required when `supportedProtocols` is set to `ACTIONS`.\n", + "properties": { + "actions": { + "description": "Configuration for the Actions protocol. This parameter is required when `supportedProtocols` is set to `ACTIONS`.", + "items": { + "$ref": "#/components/schemas/SubmissionAction" + }, + "type": "array" + }, + "capability": { + "description": "Provisioning capability identifier", + "enum": [ + "PROVISIONING" + ], + "type": "string" + }, + "supportedProtocols": { + "description": "List of supported provisioning protocols", + "items": { + "enum": [ + "SCIM", + "ACTIONS", + "OAUTH2" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "capability", + "supportedProtocols" + ], + "type": "object" + }, + "ProvisioningConditions": { + "description": "Conditional behaviors for an IdP user during authentication", + "properties": { + "deprovisioned": { + "$ref": "#/components/schemas/ProvisioningDeprovisionedCondition" + }, + "suspended": { + "$ref": "#/components/schemas/ProvisioningSuspendedCondition" + } + }, + "type": "object" + }, + "ProvisioningConnectionAuthScheme": { + "description": "Defines the method of authentication", + "enum": [ + "OAUTH2", + "TOKEN", + "UNKNOWN" + ], + "type": "string", + "x-enumDescriptions": { + "OAUTH2": "OAuth 2.0 is used to authenticate with the app.", + "TOKEN": "A token is used to authenticate with the app.", + "UNKNOWN": "The authentication scheme used by the app isn't supported, or the app doesn't support provisioning." + } + }, + "ProvisioningConnectionOauthAuthScheme": { + "description": "OAuth 2.0 is used to authenticate with the app.", + "enum": [ + "OAUTH2" + ], + "type": "string" + }, + "ProvisioningConnectionOauthRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/ProvisioningConnectionRequest" + }, + { + "description": "OAuth 2.0-based provisioning connection request", + "properties": { + "profile": { + "$ref": "#/components/schemas/ProvisioningConnectionOauthRequestProfile" + } + }, + "required": [ + "profile" + ] + } + ], + "title": "OAuth 2.0-based connection", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ProvisioningConnectionOauthRequestProfile": { + "properties": { + "authScheme": { + "$ref": "#/components/schemas/ProvisioningConnectionOauthAuthScheme" + }, + "clientId": { + "description": "Only used for the Okta Org2Org (`okta_org2org`) app. The unique client identifier for the OAuth 2.0 service app from the target org.", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/Office365ProvisioningSettings" + }, + "signing": { + "$ref": "#/components/schemas/Org2OrgProvisioningOAuthSigningSettings" + } + }, + "required": [ + "authScheme" + ] + }, + "ProvisioningConnectionProfileOauth": { + "description": "The app provisioning connection profile used to configure the method of authentication and the credentials.\nCurrently, token-based and OAuth 2.0-based authentication are supported.\n", + "properties": { + "authScheme": { + "$ref": "#/components/schemas/ProvisioningConnectionOauthAuthScheme" + }, + "clientId": { + "type": "string" + } + }, + "required": [ + "authScheme" + ] + }, + "ProvisioningConnectionRequest": { + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ProvisioningConnectionRequestAuthScheme": { + "enum": [ + "OAUTH2", + "TOKEN" + ], + "type": "string" + }, + "ProvisioningConnectionResponse": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelfLifecycleAndAuthorize" + }, + "authScheme": { + "$ref": "#/components/schemas/ProvisioningConnectionTokenAuthScheme" + }, + "baseUrl": { + "description": "Base URL", + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/ProvisioningConnectionResponseProfile" + }, + "status": { + "$ref": "#/components/schemas/ProvisioningConnectionStatus" + } + }, + "required": [ + "profile", + "status" + ], + "type": "object" + }, + "ProvisioningConnectionResponseProfile": { + "properties": { + "authScheme": { + "$ref": "#/components/schemas/ProvisioningConnectionAuthScheme" + }, + "signing": { + "$ref": "#/components/schemas/Org2OrgProvisioningOAuthSigningSettings" + } + }, + "required": [ + "authScheme" + ] + }, + "ProvisioningConnectionStatus": { + "default": "DISABLED", + "description": "Provisioning connection status", + "enum": [ + "DISABLED", + "ENABLED", + "UNKNOWN" + ], + "type": "string", + "x-enumDescriptions": { + "DISABLED": "The provisioning connection is disabled.", + "ENABLED": "The provisioning connection is enabled.", + "UNKNOWN": "Provisioning isn't supported by the app, or the authentication method is unknown." + } + }, + "ProvisioningConnectionTokenAuthScheme": { + "description": "A token is used to authenticate with the app. This property is only returned for the `TOKEN` authentication scheme.", + "enum": [ + "TOKEN" + ], + "type": "string" + }, + "ProvisioningConnectionTokenRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/ProvisioningConnectionRequest" + }, + { + "description": "Token-based provisioning connection request", + "properties": { + "baseUrl": { + "description": "Only used for the Zscaler 2.0 (`zscalerbyz`) app. The base URL for the Zscaler 2.0 target app, which also contains the Zscaler ID.", + "type": "string", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "profile": { + "$ref": "#/components/schemas/ProvisioningConnectionTokenRequestProfile" + } + }, + "required": [ + "profile" + ] + } + ], + "title": "Token-based connection", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ProvisioningConnectionTokenRequestProfile": { + "properties": { + "authScheme": { + "$ref": "#/components/schemas/ProvisioningConnectionTokenAuthScheme" + }, + "token": { + "description": "Token used to authenticate with the app", + "type": "string" + } + }, + "required": [ + "authScheme" + ] + }, + "ProvisioningDeprovisionedAction": { + "description": "Specifies the action during authentication when an IdP user is linked to a previously deprovisioned Okta user", + "enum": [ + "NONE", + "REACTIVATE" + ], + "type": "string", + "x-enumDescriptions": { + "NONE": "Take no action. If an IdP user that matches a previously deprovisioned Okta user attempts to authenticate, authentication fails.", + "REACTIVATE": "If an IdP user that matches a previously deprovisioned Okta user attempts to authenticate, reactivate the matching user in Okta and allow the authentication attempt to proceed." + } + }, + "ProvisioningDeprovisionedCondition": { + "description": "Behavior for a previously deprovisioned IdP user during authentication", + "properties": { + "action": { + "$ref": "#/components/schemas/ProvisioningDeprovisionedAction" + } + }, + "type": "object" + }, + "ProvisioningDetails": { + "description": "Supported provisioning configurations for your integration", + "properties": { + "features": { + "description": "List of provisioning features supported in this integration", + "items": { + "description": "Feature", + "enum": [ + "CREATE_USER", + "READ_USER", + "UPDATE_USER", + "DEACTIVATE_USER", + "IMPORT_USER_SCHEMA", + "CREATE_GROUP", + "READ_GROUP", + "UPDATE_GROUP", + "DEACTIVATE_GROUP" + ], + "type": "string", + "x-enumDescriptions": { + "CREATE_GROUP": "Assigns new group in the external app for existing Okta groups", + "CREATE_USER": "Assigns a new external app account to each user managed by Okta. Okta doesn't create an account if it detects that the username specified in Okta exists in the external app.", + "DEACTIVATE_GROUP": "Automatically deactivates groups when they're unassigned in Okta", + "DEACTIVATE_USER": "Automatically deactivates user accounts when they're unassigned in Okta or their Okta accounts are deactivated. Okta also reactivates the external app account if the app integration is reassigned to a user in Okta.", + "IMPORT_USER_SCHEMA": "Imports the user profile schema from an external app to Okta.", + "READ_GROUP": "Imports groups from the external app to Okta. This feature is required.", + "READ_USER": "Imports users and their profiles from the external app to Okta. This feature is required.", + "UPDATE_GROUP": "Updates the groups and their memberships", + "UPDATE_USER": "Updates the profiles of users assigned to that app integration and synchronizes those changes to downstream apps. Profile changes made in the external app are overwritten with their respective Okta profile values." + } + }, + "minItems": 1, + "type": "array" + }, + "scim": { + "$ref": "#/components/schemas/Scim" + } + }, + "required": [ + "features", + "scim" + ], + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "ProvisioningGroups": { + "description": "Provisioning settings for a user's group memberships", + "properties": { + "action": { + "$ref": "#/components/schemas/ProvisioningGroupsAction" + }, + "assignments": { + "description": "List of `OKTA_GROUP` group identifiers to add an IdP user as a member with the `ASSIGN` action", + "items": { + "example": "00gak46y5hydV6NdM0g4", + "type": "string" + }, + "type": "array" + }, + "filter": { + "description": "Allowlist of `OKTA_GROUP` group identifiers for the `APPEND` or `SYNC` provisioning action", + "items": { + "example": "00gak46y5hydV6NdM0g4", + "type": "string" + }, + "type": "array" + }, + "sourceAttributeName": { + "description": "IdP user profile attribute name (case-insensitive) for an array value that contains group memberships", + "example": "Groups", + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "ProvisioningGroupsAction": { + "description": "Provisioning action for the IdP user's group memberships\n\n| Enum | Description | Existing OKTA_GROUP Memberships | Existing APP_GROUP Memberships | Existing BUILT_IN Memberships |\n| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------ | ----------------------------- |\n| `APPEND` | Adds a user to any group defined by the IdP as a value of the `sourceAttributeName` array that matches the name of the allow listed group defined in the `filter` | Unchanged | Unchanged | Unchanged |\n| `ASSIGN` | Assigns a user to groups defined in the `assignments` array | Unchanged | Unchanged | Unchanged |\n| `NONE` | Skips processing of group memberships | Unchanged | Unchanged | Unchanged |\n| `SYNC` | Group memberships are sourced by the IdP as a value of the `sourceAttributeName` array that matches the name of the group defined in the `filter` | Removed if not defined by the IdP in `sourceAttributeName` and matching name of the group in `filter` | Unchanged | Unchanged |\n\n> **Note:** Group provisioning action is processed independently from profile sourcing. You can sync group memberships through SAML with profile sourcing disabled.", + "enum": [ + "APPEND", + "ASSIGN", + "NONE", + "SYNC" + ], + "type": "string" + }, + "ProvisioningSuspendedAction": { + "description": "Specifies the action during authentication when an IdP user is linked to a previously suspended Okta user", + "enum": [ + "NONE", + "UNSUSPEND" + ], + "type": "string", + "x-enumDescriptions": { + "NONE": "Take no action. If an IdP user that matches a previously suspended Okta user attempts to authenticate, authentication fails.", + "UNSUSPEND": "If an IdP user that matches a previously suspended Okta user attempts to authenticate, unsuspend the matching user in Okta and allow the authentication attempt to proceed." + } + }, + "ProvisioningSuspendedCondition": { + "description": "Behavior for a previously suspended IdP user during authentication", + "properties": { + "action": { + "$ref": "#/components/schemas/ProvisioningSuspendedAction" + } + }, + "type": "object" + }, + "PublicAppleAppSiteWellKnownURI": { + "description": "The well-known URI content in JSON object format", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PublicAssetLinksWellKnownURI": { + "description": "The well-known URI content in a JSON array of objects format", + "items": { + "type": "object" + }, + "type": "array", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PublicWebauthnSiteWellKnownURI": { + "description": "The well-known URI content in JSON object format", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "PushMethodKeyProtection": { + "description": "Indicates whether you must use a hardware key store", + "enum": [ + "ANY", + "HARDWARE" + ], + "type": "string" + }, + "PushProvider": { + "discriminator": { + "mapping": { + "APNS": "#/components/schemas/APNSPushProvider", + "FCM": "#/components/schemas/FCMPushProvider" + }, + "propertyName": "providerType" + }, + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "id": { + "description": "Unique key for the Push Provider", + "readOnly": true, + "type": "string" + }, + "lastUpdatedDate": { + "description": "Timestamp when the Push Provider was last modified", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Display name of the push provider", + "type": "string" + }, + "providerType": { + "$ref": "#/components/schemas/ProviderType" + } + }, + "title": "PushProvider", + "type": "object" + }, + "RateLimitAdminNotifications": { + "description": "", + "properties": { + "notificationsEnabled": { + "type": "boolean" + } + }, + "required": [ + "notificationsEnabled" + ], + "title": "RateLimitAdminNotifications", + "type": "object" + }, + "RateLimitWarningThresholdRequest": { + "description": "", + "properties": { + "warningThreshold": { + "description": "The threshold value (percentage) of a rate limit that, when exceeded, triggers a warning notification. By default, this value is 90 for Workforce orgs and 60 for CIAM orgs.", + "maximum": 90, + "minimum": 30, + "type": "integer" + } + }, + "required": [ + "warningThreshold" + ], + "title": "RateLimitWarningThreshold", + "type": "object" + }, + "RateLimitWarningThresholdResponse": { + "description": "", + "properties": { + "warningThreshold": { + "description": "The threshold value (percentage) of a rate limit that, when exceeded, triggers a warning notification. By default, this value is 90 for Workforce orgs and 60 for CIAM orgs.", + "maximum": 90, + "minimum": 30, + "type": "integer" + } + }, + "title": "RateLimitWarningThreshold", + "type": "object" + }, + "Realm": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "created": { + "description": "Timestamp when the realm was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique ID for the realm", + "readOnly": true, + "type": "string" + }, + "isDefault": { + "description": "Indicates the default realm. Existing users will start out in the default realm and can be moved to other realms individually or through realm assignments. See [Realms Assignments API](/openapi/okta-management/management/tags/realmassignment/).", + "readOnly": true, + "type": "boolean" + }, + "lastUpdated": { + "description": "Timestamp when the realm was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/RealmProfile" + } + }, + "type": "object" + }, + "RealmAssignment": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "actions": { + "$ref": "#/components/schemas/Actions" + }, + "conditions": { + "$ref": "#/components/schemas/Conditions" + }, + "created": { + "description": "Timestamp when the realm assignment was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "domains": { + "description": "Array of allowed domains. No user in this realm can be created or updated unless they have a username and email from one of these domains.\n\nThe following characters aren't allowed in the domain name: `!$%^&()=*+,:;<>'[]|/?\\`", + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "Unique ID of the realm assignment", + "readOnly": true, + "type": "string" + }, + "isDefault": { + "description": "Indicates the default realm. Existing users will start out in the default realm and can be moved individually to other realms.", + "readOnly": true, + "type": "boolean" + }, + "lastUpdated": { + "description": "Timestamp of when the realm assignment was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the realm", + "type": "string" + }, + "priority": { + "description": "The priority of the realm assignment. The lower the number, the higher the priority. This helps resolve conflicts between realm assignments.\n> **Note:** When you create realm assignments in bulk, realm assignment priorities must be unique.", + "type": "integer" + }, + "status": { + "$ref": "#/components/schemas/LifecycleStatus" + } + }, + "type": "object" + }, + "RealmAssignmentOperationResponse": { + "allOf": [ + { + "$ref": "#/components/schemas/OperationResponse" + }, + { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "assignmentOperation": { + "description": "Definition of the realm assignment operation", + "properties": { + "configuration": { + "description": "Configuration defintion of the realm", + "properties": { + "actions": { + "description": "Realm assignment action", + "properties": { + "assignUserToRealm": { + "description": "Action that assigns a user to a realm", + "properties": { + "realmId": { + "description": "ID of the realm", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "conditions": { + "$ref": "#/components/schemas/Conditions" + }, + "id": { + "description": "ID of the realm assignment operation", + "type": "string" + }, + "name": { + "description": "Name of the realm assignment operation", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "numUserMoved": { + "description": "Number of users moved", + "readOnly": true, + "type": "number" + }, + "realmId": { + "description": "ID of the realm", + "readOnly": true, + "type": "string" + }, + "realmName": { + "description": "Name of the realm", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "RealmProfile": { + "properties": { + "domains": { + "description": "Array of allowed domains. No user in this realm can be created or updated unless they have a username and email from one of these domains.\n\nThe following characters aren't allowed in the domain name: `!$%^&()=*+,:;<>'[]|/?\\`", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name of a realm", + "type": "string" + }, + "realmType": { + "description": "Used to store partner users. This property must be set to `PARTNER` to access Okta's external partner portal.", + "enum": [ + "PARTNER", + "DEFAULT" + ], + "type": "string", + "x-enumDescriptions": { + "DEFAULT": "Default", + "PARTNER": "Realm with external partner portal" + } + } + }, + "required": [ + "name" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "RecoveryQuestionCredential": { + "description": "Specifies a secret question and answer that's validated (case insensitive) when a user forgets their\npassword or unlocks their account. The answer property is write-only.", + "properties": { + "answer": { + "description": "The answer to the recovery question", + "example": "se7en", + "maximum": 100, + "minimum": 1, + "type": "string", + "writeOnly": true + }, + "question": { + "description": "The recovery question", + "example": "what is your favourite movie?", + "maximum": 100, + "minimum": 1, + "type": "string" + } + }, + "type": "object" + }, + "RefreshToken": { + "description": "The refresh token", + "properties": { + "jti": { + "description": "The refresh token ID", + "type": "string" + } + }, + "type": "object" + }, + "RegistrationInlineHook": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHook" + }, + { + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "RegistrationInlineHookCommand": { + "properties": { + "type": { + "enum": [ + "com.okta.user.profile.update", + "com.okta.action.update", + "com.okta.user.progressive.profile.update" + ], + "type": "string" + } + }, + "type": "object" + }, + "RegistrationInlineHookPPData": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/RegistrationInlineHookRequest" + }, + { + "properties": { + "data": { + "properties": { + "action": { + "description": "The default action the system takes. Set to `ALLOW`. `DENY` is never sent to your external service", + "type": "string" + }, + "context": { + "properties": { + "request": { + "$ref": "#/components/schemas/InlineHookRequestObject" + }, + "user": { + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of the user. These links are used to discover what groups the user is a part of and what factors they have enrolled.", + "properties": { + "factors": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to retrieve individual user's factor enrollments" + }, + "groups": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to retrieve the individual user's group memberships" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "passwordChanged": { + "description": "The last time the user's password was updated", + "format": "date-time", + "type": "string" + }, + "profile": { + "additionalProperties": true, + "description": "The user to update's current attributes", + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "userProfileUpdate": { + "additionalProperties": true, + "description": "Name-value pairs for each new attribute supplied by the user in the Progressive Profile form", + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "RegistrationInlineHookRequest": { + "description": "Registration inline hook request", + "discriminator": { + "mapping": { + "progressive.profile": "#/components/schemas/RegistrationInlineHookPPData", + "self.service.registration": "#/components/schemas/RegistrationInlineHookSSRData" + }, + "propertyName": "requestType" + }, + "properties": { + "eventType": { + "description": "The type of inline hook. The registration inline hook type is `com.okta.user.pre-registration`.", + "type": "string" + }, + "requestType": { + "$ref": "#/components/schemas/RegistrationInlineHookRequestType" + }, + "source": { + "description": "The ID of the registration inline hook", + "type": "string" + } + }, + "type": "object" + }, + "RegistrationInlineHookRequestType": { + "description": "The type of registration hook. Use either `self.service.registration` or `progressive.profile`.", + "enum": [ + "progressive.profile", + "self.service.registration" + ], + "type": "string" + }, + "RegistrationInlineHookResponse": { + "description": "Registration inline hook response", + "properties": { + "commands": { + "type": "array" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "RegistrationInlineHookSSRData": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/RegistrationInlineHookRequest" + }, + { + "properties": { + "data": { + "properties": { + "action": { + "description": "The default action the system will take. Will be `ALLOW`. `DENY` will never be sent to your external service.", + "type": "string" + }, + "context": { + "properties": { + "request": { + "$ref": "#/components/schemas/InlineHookRequestObject" + } + }, + "type": "object" + }, + "userProfile": { + "additionalProperties": true, + "description": "The name-value pairs for each registration-related attribute supplied by the user in the Profile Enrollment form.", + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "RegistrationResponse": { + "properties": { + "Error": { + "description": "For the registration inline hook, the `error` object provides a way of displaying an error message to the end user who is trying to register or update their profile.\n\n* If you're using the Okta Sign-In Widget for Profile Enrollment, only the `errorSummary` messages of the `errorCauses` objects that your external service returns appear as inline errors, given the following:\n * You don't customize the error handling behavior of the widget.\n * The `location` of `errorSummary` in the `errorCauses` object specifies the request object's user profile attribute.\n* If you don't return a value for the `errorCauses` object, and deny the user's registration attempt through the `commands` object in your response to Okta, one of the following generic messages appears to the end user:\n * \"Registration cannot be completed at this time.\" (SSR)\n * \"We found some errors. Please review the form and make corrections.\" (Progressive Enrollment)\n* If you don't return an `error` object at all and the registration is denied, the following generic message appears to the end user:\n * \"Registration denied.\" (SSR)\n * \"Profile update denied.\" (Progressive Enrollment)\n\n>**Note:** If you include an error object in your response, no commands are executed and the registration fails. This holds true even if the top-level `errorSummary` and the `errorCauses` objects are omitted.", + "properties": { + "errorCauses": { + "items": { + "properties": { + "domain": { + "description": "Indicates the source of the error. If the error was in the user's profile, for example, you might use `end-user`. If the error occurred in the external service, you might use `external-service`.", + "type": "string" + }, + "errorSummary": { + "description": "Human-readable summary of the error.", + "type": "string" + }, + "location": { + "description": "The valid JSON path to the location of the error. For example, if there was an error in the user's `login` field, the `location` might be `data.userProfile.login`.", + "type": "string" + }, + "locationType": { + "description": "Where in the request the error was found (`body`, `header`, `url`, or `query`).", + "type": "string" + }, + "reason": { + "description": "A brief, enum-like string that indicates the nature of the error. For example, `UNIQUE_CONSTRAINT` for a property uniqueness violation.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "errorSummary": { + "description": "Human-readable summary of one or more errors", + "type": "string" + } + }, + "type": "object" + }, + "commands": { + "description": "The `commands` object lets you invoke commands to modify or add values to the attributes in the Okta user profile that are created for this user. The object also lets you control whether or not the registration attempt is allowed to proceed.\n\nThis object is an array, allowing you to send multiple commands in your response. Each array element requires a `type` property and a `value` property. The `type` property is where you specify which of the supported commands you wish to execute, and `value` is where you supply parameters for that command.\n\nThe registration inline hook supports these three commands:\n* `com.okta.user.profile.update`: Change attribute values in the user's Okta user profile. For SSR only. Invalid if used with a Progressive Profile response.\n* `com.okta.action.update`: Allow or deny the user's registration.\n* `com.okta.user.progressive.profile.update`: Change attribute values in the user's Okta Progressive Profile.", + "items": { + "properties": { + "type": { + "description": "The location where you specify the command. To set attributes in the user's Okta profile, supply a `type` property set to `com.okta.user.profile.update`, together with a `value` property set to a list of key-value pairs corresponding to the Okta user profile attributes you want to set. The attributes must already exist in your user profile schema.\n\nTo explicitly allow or deny registration to the user, supply a type property set to `com.okta.action.update`, together with a value property set to `{\"registration\": \"ALLOW\"}` or `{\"registration\": \"DENY\"}`. The default is to allow registration.\n\nIn Okta Identity Engine, to set attributes in the user's profile, supply a `type` property set to `com.okta.user.progressive.profile.update`, together with a `value` property set to a list of key-value pairs corresponding to the Progressive Enrollment attributes that you want to set. See [Registration inline hook - Send response](https://developer.okta.com/docs/guides/registration-inline-hook/nodejs/main/#send-response).\n\nCommands are applied in the order that they appear in the array. Within a single `com.okta.user.profile.update` or `com.okta.user.progressive.profile.update command`, attributes are updated in the order that they appear in the `value` object.\n\nYou can never use a command to update the user's password, but you are allowed to set the values of attributes other than password that are designated sensitive in your Okta user schema. However, the values of those sensitive attributes, if included as fields in the Profile Enrollment form, aren't included in the `data.userProfile` object sent to your external service by Okta. See [data.userProfile](/openapi/okta-management/management/tags/inlinehook/#tag/InlineHook/operation/create-registration-hook!path=0/data/userProfile&t=request).", + "type": "string" + }, + "value": { + "additionalProperties": true, + "description": "The `value` object is the parameter to pass to the command.\n\nFor `com.okta.user.profile.update` commands, `value` should be an object containing one or more name-value pairs for the attributes you wish to update.\n\nFor `com.okta.action.update` commands, the value should be an object containing the attribute `action` set to a value of either `ALLOW` or `DENY`, indicating whether the registration should be permitted or not.\n\nRegistrations are allowed by default, so setting a value of `ALLOW` for the action field is valid but superfluous.", + "type": "object" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ReleaseChannel": { + "description": "Release channel for auto-update", + "enum": [ + "BETA", + "EA", + "GA", + "TEST" + ], + "type": "string" + }, + "ReplaceUserClassification": { + "properties": { + "type": { + "$ref": "#/components/schemas/ClassificationType" + } + }, + "type": "object" + }, + "RequiredEnum": { + "enum": [ + "ALWAYS", + "HIGH_RISK_ONLY", + "NEVER" + ], + "type": "string" + }, + "ResendUserFactor": { + "discriminator": { + "mapping": { + "call": "#/components/schemas/UserFactorCall", + "email": "#/components/schemas/UserFactorEmail", + "sms": "#/components/schemas/UserFactorSMS" + }, + "propertyName": "factorType" + }, + "properties": { + "factorType": { + "description": "Type of the factor", + "enum": [ + "call", + "email", + "sms" + ], + "type": "string" + } + }, + "type": "object" + }, + "ResetPasswordToken": { + "properties": { + "resetPasswordUrl": { + "example": "https://{yourOktaDomain}/signin/reset-password/XE6wE17zmphl3KqAPFxO", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ResourceConditions": { + "description": "Conditions for further restricting a resource.", + "nullable": false, + "properties": { + "Exclude": { + "description": "Specific resources to exclude", + "properties": { + "okta:ORN": { + "description": "List of specific resources to exclude in ORN format", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "ResourceServerJsonWebKey": { + "description": "A [JSON Web Key (JWK)](https://tools.ietf.org/html/rfc7517) is a JSON representation of a cryptographic key. Okta can use the active key to encrypt the access token minted by the authorization server. Okta supports only RSA keys with 'use: enc'.", + "properties": { + "e": { + "description": "The key exponent of a RSA key", + "type": "string" + }, + "kid": { + "description": "The unique identifier of the key", + "type": "string" + }, + "kty": { + "$ref": "#/components/schemas/JsonWebKeyType" + }, + "n": { + "description": "The modulus of the RSA key", + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/JsonWebKeyStatus" + }, + "use": { + "$ref": "#/components/schemas/JsonWebKeyUse" + } + }, + "type": "object" + }, + "ResourceServerJsonWebKeys": { + "description": "A [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) for encrypting JWTs minted by the custom authorization server", + "properties": { + "keys": { + "items": { + "$ref": "#/components/schemas/ResourceServerJsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "ResourceSet": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "bindings": { + "$ref": "#/components/schemas/HrefObjectBindingsLink" + }, + "resources": { + "$ref": "#/components/schemas/HrefObjectResourceSetResourcesLink" + } + } + } + ] + }, + "created": { + "description": "Timestamp when the role was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of the resource set", + "type": "string" + }, + "id": { + "description": "Unique ID for the resource set object", + "readOnly": true, + "type": "string" + }, + "label": { + "description": "Unique label for the resource set", + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the role was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ResourceSetBindingAddMembersRequest": { + "properties": { + "additions": { + "description": "A list of member resources to add to the role resource set binding", + "items": { + "description": "User or group resources", + "example": "https://{yourOktaDomain}/api/v1/groups/{groupId}", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResourceSetBindingCreateRequest": { + "properties": { + "members": { + "description": "URLs to user and/or group instances that are assigned to the role", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Unique key for the role", + "type": "string" + } + }, + "type": "object" + }, + "ResourceSetBindingEditResponse": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "bindings": { + "$ref": "#/components/schemas/HrefObjectBindingsLink" + }, + "resource-set": { + "$ref": "#/components/schemas/HrefObjectResourceSetLink" + } + } + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ResourceSetBindingMember": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "created": { + "description": "Timestamp when the member was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Role resource set binding member ID", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the member was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ResourceSetBindingMembers": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "binding": { + "$ref": "#/components/schemas/HrefObjectBindingLink" + }, + "next": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the next list of binding members for the specified role and resource set" + } + ] + } + } + } + ] + }, + "members": { + "description": "The members of the role resource set binding. If there are more than 100 members for the binding, then the `_links.next` resource is returned with the next list of members.", + "items": { + "$ref": "#/components/schemas/ResourceSetBindingMember" + }, + "type": "array" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ResourceSetBindingResponse": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "members": { + "$ref": "#/components/schemas/HrefObjectMembersLink" + }, + "resource-set": { + "$ref": "#/components/schemas/HrefObjectResourceSetLink" + } + } + } + ] + }, + "id": { + "description": "`id` of the role resource set binding", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ResourceSetBindingRole": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "members": { + "$ref": "#/components/schemas/HrefObjectMembersLink" + } + } + } + ] + }, + "id": { + "description": "`id` of the role", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ResourceSetBindings": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "next": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the next list of bindings for the specified resource set" + } + ] + }, + "resource-set": { + "$ref": "#/components/schemas/HrefObjectResourceSetLink" + } + } + } + ] + }, + "roles": { + "description": "Roles associated with the resource set binding. If there are more than 100 bindings for the specified resource set, then the `_links.next` resource is returned with the next list of bindings.", + "items": { + "$ref": "#/components/schemas/ResourceSetBindingRole" + }, + "type": "array" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ResourceSetResource": { + "properties": { + "_links": { + "description": "Related discoverable resources", + "properties": { + "groups": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "If applicable, the REST API URL of the related groups resource" + } + ] + }, + "resource": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to this resource set resource object (self)" + } + ] + }, + "self": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "The REST API URL of the related resource" + } + ] + }, + "users": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "If applicable, the REST API URL of the related users resource" + } + ] + } + }, + "readOnly": true + }, + "conditions": { + "$ref": "#/components/schemas/ResourceConditions" + }, + "created": { + "description": "Timestamp when the resource set resource object was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique ID of the resource set resource object", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when this object was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "orn": { + "description": "The Okta Resource Name (ORN) of the resource", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ResourceSetResourcePatchRequest": { + "properties": { + "additions": { + "description": "A list of resources to add to the resource set", + "items": { + "description": "Resource in ORN or REST API URL format", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResourceSetResourcePostRequest": { + "properties": { + "conditions": { + "$ref": "#/components/schemas/ResourceConditions" + }, + "resourceOrnOrUrl": { + "description": "Resource in ORN or REST API URL format", + "type": "string" + } + }, + "required": [ + "resourceOrnOrUrl", + "conditions" + ], + "type": "object" + }, + "ResourceSetResourcePutRequest": { + "properties": { + "conditions": { + "$ref": "#/components/schemas/ResourceConditions" + } + }, + "type": "object" + }, + "ResourceSetResources": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksNext" + }, + { + "properties": { + "resource-set": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + }, + "resources": { + "items": { + "$ref": "#/components/schemas/ResourceSetResource" + }, + "type": "array" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ResourceSets": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksNext" + }, + "resource-sets": { + "items": { + "$ref": "#/components/schemas/ResourceSet" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResponseLinks": { + "description": "Link objects", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + } + }, + "type": "object" + }, + "ResponseMode": { + "enum": [ + "form_post", + "fragment", + "okta_post_message", + "query" + ], + "type": "string", + "x-enumDescriptions": { + "form_post": "Parameters are encoded as HTML form values (`application/x-www-form-urlencoded` format) and are transmitted through the HTTP POST method to the client.", + "fragment": "Parameters are encoded in the URL fragment added to the `redirect_uri` when redirecting back to the client.", + "okta_post_message": "Uses [HTML5 Web Messaging](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) (for example, `window.postMessage()`) instead of the redirect for the authorization response from the `/authorize` endpoint.\n\n`okta_post_message` is an adaptation of the [Web Message Response Mode](https://tools.ietf.org/html/draft-sakimura-oauth-wmrm-00#section-4.1).\nThis value provides a secure way for a single-page application to perform a sign-in flow in a pop-up window or an iFrame and receive the ID token, access token, and/or authorization code back in the parent page without leaving the context of that page. The data object for the `postMessage` call is in the next section.", + "query": "Parameters are encoded in the query string added to the `redirect_uri` when redirecting back to the client." + } + }, + "ResponseType": { + "enum": [ + "code", + "id_token", + "none", + "token" + ], + "type": "string" + }, + "ResponseTypesSupported": { + "enum": [ + "code", + "code id_token", + "code id_token token", + "code token", + "id_token", + "id_token token", + "token" + ], + "type": "string" + }, + "RevokeRefreshTokenHrefObject": { + "properties": { + "href": { + "description": "Link URI", + "example": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7/clients/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3", + "type": "string" + } + }, + "type": "object" + }, + "RiscIdentifierChangedEvent": { + "description": "The subject's identifier has changed, which is either an email address or a phone number change", + "properties": { + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "new-value": { + "description": "The new identifier value", + "example": "new.email@okta.example.com", + "type": "string" + }, + "subject": { + "$ref": "#/components/schemas/SecurityEventSubject" + } + }, + "required": [ + "event_timestamp", + "subject" + ], + "type": "object" + }, + "RiskDetectionTypesPolicyRuleCondition": { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle> An object that references detected risk events. This object can have an `include` parameter or an `exclude` parameter, but not both.", + "properties": { + "exclude": { + "description": "An array of detected risk events to exclude in the entity policy rule", + "items": { + "$ref": "#/components/schemas/DetectedRiskEvents" + }, + "type": "array" + }, + "include": { + "description": "An array of detected risk events to include in the entity policy rule", + "items": { + "$ref": "#/components/schemas/DetectedRiskEvents" + }, + "type": "array" + } + }, + "type": "object" + }, + "RiskEvent": { + "properties": { + "expiresAt": { + "description": "Timestamp at which the event expires (expressed as a UTC time zone using ISO 8601 format: yyyy-MM-dd`T`HH:mm:ss.SSS`Z`). If this optional field isn't included, Okta automatically expires the event 24 hours after the event is consumed.", + "format": "date-time", + "type": "string" + }, + "subjects": { + "description": "List of risk event subjects", + "items": { + "$ref": "#/components/schemas/RiskEventSubject" + }, + "type": "array" + }, + "timestamp": { + "description": "Timestamp of when the event is produced (expressed as a UTC time zone using ISO 8601 format: yyyy-MM-dd`T`HH:mm:ss.SSS`Z`)", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "subjects" + ], + "type": "object" + }, + "RiskEventSubject": { + "properties": { + "ip": { + "description": "The risk event subject IP address (either an IPv4 or IPv6 address)", + "type": "string" + }, + "message": { + "description": "Additional reasons for the risk level of the IP", + "maxLength": 512, + "pattern": "^[a-zA-Z0-9 .\\-_]*$", + "type": "string" + }, + "riskLevel": { + "$ref": "#/components/schemas/RiskEventSubjectRiskLevel" + } + }, + "required": [ + "ip", + "riskLevel" + ], + "type": "object" + }, + "RiskEventSubjectRiskLevel": { + "description": "The risk level associated with the IP", + "enum": [ + "HIGH", + "LOW", + "MEDIUM" + ], + "type": "string" + }, + "RiskPolicyRuleCondition": { + "properties": { + "behaviors": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "RiskProvider": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "action": { + "$ref": "#/components/schemas/RiskProviderAction" + }, + "clientId": { + "description": "The ID of the [OAuth 2.0 service app](https://developer.okta.com/docs/guides/implement-oauth-for-okta-serviceapp/main/#create-a-service-app-and-grant-scopes) that's used to send risk events to Okta", + "example": "00cjkjjkkgjkdkjdkkljjsd", + "type": "string" + }, + "created": { + "description": "Timestamp when the risk provider object was created", + "example": "2021-01-05 22:18:30", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the risk provider object", + "example": "00rp12r4skkjkjgsn", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the risk provider object was last updated", + "example": "2021-01-05 22:18:30", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the risk provider", + "example": "Risk-Partner-X", + "maxLength": 50, + "type": "string" + } + }, + "required": [ + "name", + "clientId", + "action", + "id", + "_links" + ], + "type": "object" + }, + "RiskProviderAction": { + "default": "log_only", + "description": "Action taken by Okta during authentication attempts based on the risk events sent by this provider", + "enum": [ + "enforce_and_log", + "log_only", + "none" + ], + "type": "string", + "x-enumDescriptions": { + "enforce_and_log": "Use risk event information to evaluate risks during authentication attempts and include risk event information in the System Log", + "log_only": "Include risk event information in the System Log", + "none": "No action" + } + }, + "RiskScorePolicyRuleCondition": { + "description": "Specifies a particular level of risk to match on", + "properties": { + "level": { + "description": "The level to match", + "enum": [ + "ANY", + "LOW", + "MEDIUM", + "HIGH" + ], + "type": "string" + } + }, + "required": [ + "level" + ], + "type": "object" + }, + "Role": { + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "assignmentType": { + "$ref": "#/components/schemas/RoleAssignmentType" + }, + "created": { + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "type": "string" + }, + "id": { + "readOnly": true, + "type": "string" + }, + "label": { + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/LifecycleStatus" + }, + "type": { + "$ref": "#/components/schemas/RoleType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "RoleAssignedUser": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelfAndRoles" + }, + "id": { + "description": "The ID of the user", + "readOnly": true, + "type": "string" + }, + "orn": { + "description": "ORN representing the assignee", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RoleAssignedUsers": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksNextForRoleAssignments" + }, + "value": { + "items": { + "$ref": "#/components/schemas/RoleAssignedUser" + }, + "type": "array" + } + }, + "type": "object" + }, + "RoleAssignmentType": { + "description": "Role assignment type", + "enum": [ + "CLIENT", + "GROUP", + "USER" + ], + "type": "string", + "x-enumDescriptions": { + "CLIENT": "The role is assigned to a client app", + "GROUP": "The role is assigned to a group", + "USER": "The role is assigned to a user" + } + }, + "RoleGovernance": { + "description": "List of all user role governance sources", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksGovernanceSources" + }, + "grants": { + "items": { + "$ref": "#/components/schemas/RoleGovernanceSource" + }, + "type": "array" + } + }, + "type": "object" + }, + "RoleGovernanceResource": { + "description": "The resource of a grant", + "properties": { + "label": { + "description": "The resource name", + "type": "string" + }, + "resource": { + "description": "The resources id", + "type": "string" + } + }, + "type": "object" + }, + "RoleGovernanceResources": { + "description": "The resources of a grant", + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "$ref": "#/components/schemas/LinksNext" + } + ] + }, + "resources": { + "items": { + "$ref": "#/components/schemas/RoleGovernanceResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "RoleGovernanceSource": { + "description": "User role governance source", + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksGovernanceResources" + }, + { + "$ref": "#/components/schemas/LinksSelf" + } + ] + }, + "bundleId": { + "description": "`id` of the entitlement bundle", + "readOnly": true, + "type": "string" + }, + "expirationDate": { + "description": "The expiration date of the entitlement bundle", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "grantId": { + "description": "`id` of the grant", + "readOnly": true, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/GovernanceSourceType" + } + }, + "required": [ + "type", + "grantId" + ], + "type": "object" + }, + "RoleId": { + "title": "roleId", + "type": "string" + }, + "RoleTarget": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "assignmentType": { + "description": "The assignment type of how the user receives this target", + "example": "GROUP", + "readOnly": true, + "type": "string" + }, + "expiration": { + "description": "The expiry time stamp of the associated target. It's only included in the response if the associated target will expire.", + "example": "2023-08-25T12:00:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "orn": { + "description": "The [Okta Resource Name (ORN)](https://support.okta.com/help/s/article/understanding-okta-resource-name-orn) of the app target or group target", + "example": "orn:okta:directory:00o5v1t2W4OSF9r4N0g4:groups:00g5vhi3rEJMOog1S0g4", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RoleType": { + "description": "| Role type | Description |\n|------------------------------|-------------------------------------------------------------|\n| ACCESS_CERTIFICATIONS_ADMIN | Access Certifications Administrator IAM-based standard role |\n| ACCESS_REQUESTS_ADMIN | Access Requests Administrator IAM-based standard role |\n| API_ACCESS_MANAGEMENT_ADMIN | Access Management Administrator standard role |\n| APP_ADMIN | Application Administrator standard role |\n| CUSTOM | Custom admin role |\n| GROUP_MEMBERSHIP_ADMIN | Group Membership Administrator standard role |\n| HELP_DESK_ADMIN | Help Desk Administrator standard role |\n| ORG_ADMIN | Organizational Administrator standard role |\n| READ_ONLY_ADMIN | Read-Only Administrator standard role |\n| REPORT_ADMIN | Report Administrator standard role |\n| SUPER_ADMIN | Super Administrator standard role |\n| USER_ADMIN | User Administrator standard role |\n| WORKFLOWS_ADMIN | Workflows Administrator IAM-based standard role |", + "enum": [ + "ACCESS_CERTIFICATIONS_ADMIN", + "ACCESS_REQUESTS_ADMIN", + "API_ACCESS_MANAGEMENT_ADMIN", + "APP_ADMIN", + "CUSTOM", + "GROUP_MEMBERSHIP_ADMIN", + "HELP_DESK_ADMIN", + "ORG_ADMIN", + "READ_ONLY_ADMIN", + "REPORT_ADMIN", + "SUPER_ADMIN", + "USER_ADMIN", + "WORKFLOWS_ADMIN" + ], + "title": "roleType", + "type": "string" + }, + "RotatePasswordRequest": { + "description": "Rotate password request for the privileged resource", + "properties": { + "password": { + "description": "The password associated with the privileged resource", + "example": "xf1bs9am2", + "format": "password", + "type": "string", + "writeOnly": true + }, + "secretVersionId": { + "description": "The version ID of the password secret from the OPA vault", + "example": "9f8400-e29b-41d4-a716-926655440034", + "maxLength": 36, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "password", + "secretVersionId" + ], + "type": "object" + }, + "SAMLHookResponse": { + "properties": { + "commands": { + "description": "The `commands` object is where you tell Okta to add additional claims to the assertion or to modify the existing assertion statements.\n\n`commands` is an array, allowing you to send multiple commands. In each array element, include a `type` property and a `value` property. The `type` property is where you specify which of the supported commands you want to execute, and `value` is where you supply an operand for that command.\nIn the case of the SAML assertion inline hook, the `value` property is itself a nested object, in which you specify a particular operation, a path to act on, and a value.", + "items": { + "properties": { + "type": { + "description": "One of the supported commands `com.okta.assertion.patch`", + "type": "string" + }, + "value": { + "items": { + "properties": { + "op": { + "description": "The name of one of the supported ops:\n`add`: Add a new claim to the assertion\n`replace`: Modify any element of the assertion\n > **Note:** If a response to the SAML assertion inline hook request isn't received from your external service within three seconds, a timeout occurs. In this scenario, the Okta process flow continues with the original SAML assertion returned.", + "type": "string" + }, + "path": { + "description": "Location, within the assertion, to apply the operation", + "type": "string" + }, + "value": { + "description": "The value of the claim that you add or replace, and can also include other attributes. If adding to a claim, add another `value` attribute residing within an array called `attributeValues`.\n\nSee the following examples:\n\n#### Simple value (integer or string)\n\n`\"value\": 300` or `\"value\": \"replacementString\"`\n\n#### Attribute value (object)\n\n` \"value\": {\n \"authContextClassRef\": \"replacementValue\"\n }`\n\n#### AttributeValues array value (object)\n\n` \"value\": {\n \"attributes\": {\n \"NameFormat\": \"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\"\n },\n \"attributeValues\": [\n {\"attributes\": {\n \"xsi:type\": \"xs:string\"\n },\n \"value\": \"4321\"}\n ]\n }`", + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "object" + } + ] + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "error": { + "description": "An object to return an error. Returning an error causes Okta to record a failure event in the Okta System Log.\nThe string supplied in the `errorSummary` property is recorded in the System Log event.\n> **Note:** If the error object doesn't include the defined `errorSummary` property, the following common default message\nis returned to the end user: `The callback service returned an error`.\n\n> **Note:** If a response to a SAML inline hook request isn't received from your external service within three seconds, a timeout occurs. In this scenario, the Okta SAML inline hook process continues, and the user is created.", + "properties": { + "errorSummary": { + "description": "A human-readable summary of the error", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "SAMLPayLoad": { + "properties": { + "data": { + "properties": { + "assertion": { + "description": "Details of the SAML assertion that was generated", + "properties": { + "authentication": { + "description": "Provides a JSON representation of the `<saml:AuthnStatement>` element of the SAML assertion", + "properties": { + "authnContext": { + "description": "Details of the authentication methods used for the SAML assertion", + "properties": { + "authnContextClassRef": { + "description": "Describes the identity provider's supported authentication context classes", + "example": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "type": "string" + } + }, + "type": "object" + }, + "sessionIndex": { + "description": "The unique identifier describing the assertion statement", + "example": "id1553800523546.312669168", + "type": "string" + } + }, + "type": "object" + }, + "claims": { + "additionalProperties": { + "properties": { + "attributeValues": { + "items": { + "properties": { + "attributes": { + "properties": { + "xsi:type": { + "description": "Used to derive the type of the attribute", + "type": "string" + } + }, + "type": "object" + }, + "value": { + "description": "The actual value of the attribute", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "attributes": { + "properties": { + "NameFormat": { + "description": "Indicates how to interpret the attribute name", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "description": "Provides a JSON representation of the `<saml:AttributeStatement>` element contained in the generated SAML assertion. Contains any optional SAML attribute statements that you have defined for the app using the Admin Console's **SAML Settings**.", + "type": "object" + }, + "conditions": { + "description": "Provides a JSON representation of the `<saml:Conditions>` element of the SAML assertion", + "properties": { + "audienceRestriction": { + "description": "Describes which service providers the assertion is valid for", + "items": { + "example": [ + "urn:example:sp" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "lifetime": { + "description": "Specifies the expiration time, in seconds, of the SAML assertion", + "properties": { + "expiration": { + "description": "The expiration time in seconds", + "example": 300, + "type": "integer" + } + }, + "type": "object" + }, + "subject": { + "description": "Provides a JSON representation of the `<saml:Subject>` element of the SAML assertion", + "properties": { + "confirmation": { + "properties": { + "data": { + "properties": { + "recipient": { + "description": "The token endpoint URL of the authorization server", + "example": "http://www.example.com:7070/saml/sso", + "type": "string" + } + }, + "type": "object" + }, + "method": { + "description": "Used to indicate how the authorization server confirmed the SAML assertion", + "example": "urn:oasis:names:tc:SAML:2.0:cm:bearer", + "type": "string" + } + }, + "type": "object" + }, + "nameFormat": { + "description": "Indicates how to interpret the attribute name", + "example": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "type": "string" + }, + "nameId": { + "description": "The unique identifier of the user", + "example": "user@example.com", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "context": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseContext" + }, + { + "properties": { + "protocol": { + "description": "Details of the assertion protocol being used", + "properties": { + "issuer": { + "properties": { + "id": { + "description": "The unique identifier of the issuer that provided the SAML assertion", + "example": "0oath92zlO60urQOP0g3", + "type": "string" + }, + "name": { + "description": "The name of the issuer that provided the SAML assertion", + "example": "SAML 2.0 App", + "type": "string" + }, + "uri": { + "description": "The base URI of the SAML endpoint that's used to assert the authorization", + "example": "http://www.okta.com/exkth8lMzFm0HZOTU0g3", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "The type of authentication protocol being used for the assertion", + "example": "SAML2.0", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + }, + "eventType": { + "description": "The type of inline hook. The SAML assertion inline hook type is `com.okta.saml.tokens.transform`.", + "type": "string" + }, + "source": { + "description": "The ID and URL of the SAML assertion inline hook", + "type": "string" + } + }, + "type": "object" + }, + "SAMLPayloadExecute": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/SAMLPayLoad" + } + ], + "description": "SAML assertion inline hook request" + }, + "SafeBrowsingProtectionLevel": { + "description": "Represents the current value of the Safe Browsing protection level", + "enum": [ + "ENHANCED_PROTECTION", + "NO_SAFE_BROWSING", + "STANDARD_PROTECTION" + ], + "example": "ENHANCED_PROTECTION", + "type": "string", + "x-enumDescriptions": { + "ENHANCED_PROTECTION": "Safe Browsing is active in the enhanced mode", + "NO_SAFE_BROWSING": "Safe Browsing is never active", + "STANDARD_PROTECTION": "Safe Browsing is active in the standard mode" + } + }, + "SalesforceApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/OINApplication" + }, + { + "type": "object" + }, + { + "properties": { + "name": { + "enum": [ + "salesforce" + ], + "example": "salesforce", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/SalesforceApplicationSettings" + }, + "signOnMode": { + "enum": [ + "BROWSER_PLUGIN", + "BOOKMARK", + "SAML_2_0" + ], + "example": "BROWSER_PLUGIN", + "type": "string" + } + }, + "required": [ + "name", + "label", + "settings" + ] + } + ], + "description": "Schema for the Salesforce app (key name: `salesforce`)\n\nTo create a Salesforce app, use the [Create an Application](/openapi/okta-management/management/tags/application/other/createapplication) request with the following parameters in the request body.\n> **Note:** The Salesforce app only supports `BROWSER_PLUGIN`, `BOOKMARK`, and `SAML_2_0` sign-on modes.\n", + "example": { + "label": "Sample Salesforce App", + "name": "salesforce", + "settings": { + "app": { + "instanceType": "SANDBOX", + "integrationType": "STANDARD" + } + }, + "signOnMode": "SAML_2_0" + }, + "title": "Salesforce", + "x-okta-defined-as": { + "name": "salesforce" + }, + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-tags": [ + "Application" + ] + }, + "SalesforceApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "type": "object" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/SalesforceApplicationSettingsApplication" + }, + "signOn": { + "$ref": "#/components/schemas/OINSaml20ApplicationSettingsSignOn" + } + }, + "required": [ + "app" + ] + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "SalesforceApplicationSettingsApplication": { + "description": "Salesforce app instance properties", + "properties": { + "instanceType": { + "description": "Salesforce instance that you want to connect to", + "enum": [ + "SANDBOX", + "PRODUCTION", + "GOVERNMENT" + ], + "type": "string" + }, + "integrationType": { + "description": "Salesforce integration type", + "enum": [ + "STANDARD", + "PORTAL", + "COMMUNITY" + ], + "type": "string" + }, + "loginUrl": { + "description": "The Login URL specified in your Salesforce Single Sign-On settings", + "type": "string" + }, + "logoutUrl": { + "description": "Salesforce Logout URL", + "type": "string" + } + }, + "required": [ + "integrationType", + "instanceType" + ], + "type": "object" + }, + "Saml": { + "description": "SAML configuration details", + "properties": { + "acs": { + "description": "List of Assertion Consumer Service (ACS) URLs. The default ACS URL is required and is indicated by a null `index` value. You can use the org-level variables you defined in the `config` array in the URL. For example: `https://${org.subdomain}.example.com/saml/login`", + "items": { + "properties": { + "index": { + "description": "Index of ACS URL. You can't reuse the same index in the ACS URL array.", + "example": 0, + "maximum": 65535, + "minimum": 0, + "type": "number" + }, + "url": { + "description": "Assertion Consumer Service (ACS) URL", + "example": "https://${org.subdomain}.example.com/saml/login", + "format": "uri", + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "claims": { + "description": "Attribute statements to appear in the Okta SAML assertion", + "items": { + "properties": { + "name": { + "description": "The attribute name", + "example": "Address", + "type": "string" + }, + "values": { + "description": "The Okta values inserted in the attribute statement", + "items": { + "example": "${user.homeAddress}", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "doc": { + "description": "The URL to your customer-facing instructions for configuring your SAML integration. See [Customer configuration document guidelines](https://developer.okta.com/docs/guides/submit-app-prereq/main/#customer-configuration-document-guidelines).", + "example": "https://example.com/strawberry/help/samlSetup", + "format": "uri", + "type": "string" + }, + "entityId": { + "description": "Globally unique name for your SAML entity. For instance, your Identity Provider (IdP) or Service Provider (SP) URL.", + "example": "https://${org.subdomain}.example.com", + "type": "string" + }, + "groups": { + "description": "Defines the group attribute names for the SAML assertion statement. Okta inserts the list of Okta user groups into the attribute names in the statement.", + "items": { + "description": "A group attribute name in your SAML app", + "example": "groups", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "acs", + "entityId", + "doc" + ], + "type": "object" + }, + "Saml11Application": { + "allOf": [ + { + "$ref": "#/components/schemas/Application" + }, + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/ApplicationCredentials" + }, + "name": { + "description": "The key name for the SAML 1.1 app definition. You can't create a custom SAML 1.1 app integration instance. Only existing OIN SAML 1.1 app integrations are supported.", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/Saml11ApplicationSettings" + } + }, + "required": [ + "name" + ], + "type": "object" + } + ] + }, + "Saml11ApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "properties": { + "app": { + "additionalProperties": true, + "type": "object" + }, + "signOn": { + "$ref": "#/components/schemas/Saml11ApplicationSettingsSignOn" + } + }, + "type": "object" + } + ] + }, + "Saml11ApplicationSettingsSignOn": { + "description": "SAML 1.1 sign-on mode attributes", + "properties": { + "audienceOverride": { + "description": "The intended audience of the SAML assertion. This is usually the Entity ID of your application.", + "type": "string" + }, + "defaultRelayState": { + "description": "The URL of the resource to direct users after they successfully sign in to the SP using SAML. See the SP documentation to check if you need to specify a RelayState. In most instances, you can leave this field blank.", + "type": "string" + }, + "recipientOverride": { + "description": "The location where the application can present the SAML assertion. This is usually the Single Sign-On (SSO) URL.", + "type": "string" + }, + "ssoAcsUrlOverride": { + "description": "Assertion Consumer Services (ACS) URL value for the Service Provider (SP). This URL is always used for Identity Provider (IdP) initiated sign-on requests.", + "type": "string" + } + }, + "title": "SAML 1.1 settings", + "type": "object" + }, + "SamlAcsEndpoint": { + "description": "Okta's `SPSSODescriptor` endpoint where the IdP sends a `<SAMLResponse>` message", + "properties": { + "binding": { + "$ref": "#/components/schemas/ProtocolEndpointBinding" + }, + "type": { + "$ref": "#/components/schemas/SamlEndpointType" + } + }, + "type": "object" + }, + "SamlAlgorithms": { + "description": "Settings for signing and verifying SAML messages", + "properties": { + "request": { + "$ref": "#/components/schemas/SamlRequestAlgorithm" + }, + "response": { + "$ref": "#/components/schemas/SamlResponseAlgorithm" + } + }, + "type": "object" + }, + "SamlApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/Application" + }, + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/ApplicationCredentials" + }, + "name": { + "description": "A unique key is generated for the custom app instance when you use SAML_2_0 `signOnMode`.", + "readOnly": true, + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/SamlApplicationSettings" + } + }, + "type": "object" + } + ] + }, + "SamlApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "properties": { + "signOn": { + "$ref": "#/components/schemas/SamlApplicationSettingsSignOn" + } + }, + "type": "object" + } + ] + }, + "SamlApplicationSettingsSignOn": { + "description": "SAML 2.0 sign-on attributes.\n> **Note:** Set either `destinationOverride` or `ssoAcsUrl` to configure any other SAML 2.0 attributes in this section.", + "properties": { + "acsEndpoints": { + "description": "An array of ACS endpoints. You can configure a maximum of 100 endpoints.", + "items": { + "$ref": "#/components/schemas/AcsEndpoint" + }, + "type": "array" + }, + "allowMultipleAcsEndpoints": { + "description": "Determines whether the app allows you to configure multiple ACS URIs", + "type": "boolean" + }, + "assertionEncryption": { + "$ref": "#/components/schemas/SamlAssertionEncryption" + }, + "assertionSigned": { + "description": "Determines whether the SAML assertion is digitally signed", + "type": "boolean" + }, + "attributeStatements": { + "description": "A list of custom attribute statements for the app's SAML assertion. See [SAML 2.0 Technical Overview](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.html).\n\nThere are two types of attribute statements:\n| Type | Description |\n| ---- | ----------- |\n| EXPRESSION | Generic attribute statement that can be dynamic and supports [Okta Expression Language](https://developer.okta.com/docs/reference/okta-expression-language/) |\n| GROUP | Group attribute statement |\n", + "items": { + "$ref": "#/components/schemas/SamlAttributeStatement" + }, + "type": "array" + }, + "audience": { + "description": "The entity ID of the SP. Use the entity ID value exactly as provided by the SP.", + "type": "string" + }, + "audienceOverride": { + "description": "Audience override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "type": "string" + }, + "authnContextClassRef": { + "description": "Identifies the SAML authentication context class for the assertion's authentication statement", + "enum": [ + "urn:federation:authentication:windows", + "oasis:names:tc:SAML:2.0:ac:classes:Kerberos", + "urn:oasis:names:tc:SAML:2.0:ac:classes:Password", + "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", + "urn:oasis:names:tc:SAML:2.0:ac:classes:TLSClient", + "urn:oasis:names:tc:SAML:2.0:ac:classes:unspecified", + "urn:oasis:names:tc:SAML:2.0:ac:classes:X509" + ], + "type": "string", + "x-enumDescriptions": { + "oasis:names:tc:SAML:2.0:ac:classes:Kerberos": "Kerberos", + "urn:federation:authentication:windows": "Integrated Windows Authentication", + "urn:oasis:names:tc:SAML:2.0:ac:classes:Password": "Password", + "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport": "PasswordProtectedTransport", + "urn:oasis:names:tc:SAML:2.0:ac:classes:TLSClient": "TLS Client", + "urn:oasis:names:tc:SAML:2.0:ac:classes:X509": "X509 Certificate", + "urn:oasis:names:tc:SAML:2.0:ac:classes:unspecified": "Unspecified" + } + }, + "configuredAttributeStatements": { + "description": "The list of dynamic attribute statements for the SAML assertion inherited from app metadata (apps from the OIN) during app creation.\n\nThere are two types of attribute statements: `EXPRESSION` and `GROUP`.\n", + "items": { + "$ref": "#/components/schemas/SamlAttributeStatement" + }, + "type": "array" + }, + "defaultRelayState": { + "description": "Identifies a specific application resource in an IdP-initiated SSO scenario", + "type": "string" + }, + "destination": { + "description": "Identifies the location inside the SAML assertion where the SAML response should be sent", + "type": "string" + }, + "destinationOverride": { + "description": "Destination override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "type": "string" + }, + "digestAlgorithm": { + "description": "Determines the digest algorithm used to digitally sign the SAML assertion and response", + "enum": [ + "SHA1", + "SHA256" + ], + "type": "string" + }, + "honorForceAuthn": { + "description": "Set to `true` to prompt users for their credentials when a SAML request has the `ForceAuthn` attribute set to `true`", + "type": "boolean" + }, + "idpIssuer": { + "description": "SAML Issuer ID", + "type": "string" + }, + "inlineHooks": { + "description": "Associates the app with SAML inline hooks. See [the SAML assertion inline hook reference](https://developer.okta.com/docs/reference/saml-hook/).", + "items": { + "$ref": "#/components/schemas/SignOnInlineHook" + }, + "type": "array" + }, + "participateSlo": { + "$ref": "#/components/schemas/SloParticipate" + }, + "recipient": { + "description": "The location where the app may present the SAML assertion", + "type": "string" + }, + "recipientOverride": { + "description": "Recipient override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "type": "string" + }, + "requestCompressed": { + "description": "Determines whether the SAML request is expected to be compressed", + "type": "boolean" + }, + "responseSigned": { + "description": "Determines whether the SAML authentication response message is digitally signed by the IdP\n> **Note:** Either (or both) `responseSigned` or `assertionSigned` must be `TRUE`.", + "type": "boolean" + }, + "samlAssertionLifetimeSeconds": { + "description": "Determines the SAML app session lifetimes with Okta", + "example": 3600, + "type": "integer", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "signatureAlgorithm": { + "description": "Determines the signing algorithm used to digitally sign the SAML assertion and response", + "enum": [ + "RSA_SHA1", + "RSA_SHA256" + ], + "type": "string" + }, + "slo": { + "$ref": "#/components/schemas/SingleLogout" + }, + "spCertificate": { + "$ref": "#/components/schemas/SamlSpCertificate" + }, + "spIssuer": { + "description": "The issuer ID for the Service Provider. This property appears when SLO is enabled.", + "type": "string" + }, + "ssoAcsUrl": { + "description": "Single Sign-On Assertion Consumer Service (ACS) URL", + "type": "string" + }, + "ssoAcsUrlOverride": { + "description": "Assertion Consumer Service (ACS) URL override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).", + "type": "string" + }, + "subjectNameIdFormat": { + "description": "Identifies the SAML processing rules. Supported values:", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "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:unspecified", + "urn:oasis:names:tc:SAML:1.1:nameid-format:x509SubjectName" + ], + "type": "string", + "x-enumDescriptions": { + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress": "Email Address", + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified": "Unspecified", + "urn:oasis:names:tc:SAML:1.1:nameid-format:x509SubjectName": "x509SubjectName", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent": "Persistent", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient": "Transient" + } + }, + "subjectNameIdTemplate": { + "description": "Template for app user's username when a user is assigned to the app", + "type": "string" + } + }, + "required": [ + "allowMultipleAcsEndpoints", + "assertionSigned", + "honorForceAuthn", + "requestCompressed", + "responseSigned" + ], + "type": "object" + }, + "SamlAssertionEncryption": { + "description": "Determines if the app supports encrypted assertions", + "properties": { + "enabled": { + "description": "Indicates whether Okta encrypts the assertions that it sends to the Service Provider", + "type": "boolean" + }, + "encryptionAlgorithm": { + "description": "The encryption algorithm used to encrypt the SAML assertion", + "enum": [ + "AES128_CBC", + "AES256_CBC", + "AES256_CBC", + "AES256_GCM" + ], + "type": "string" + }, + "keyTransportAlgorithm": { + "description": "The key transport algorithm used to encrypt the SAML assertion", + "enum": [ + "RSA_OAEP", + "RSA_15" + ], + "type": "string" + }, + "x5c": { + "description": "A list that contains exactly one x509 encoded certificate which Okta uses to encrypt the SAML assertion with", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SamlAttributeStatement": { + "anyOf": [ + { + "$ref": "#/components/schemas/SamlAttributeStatementExpression" + }, + { + "$ref": "#/components/schemas/SamlAttributeStatementGroup" + } + ], + "discriminator": { + "mapping": { + "EXPRESSION": "#/components/schemas/SamlAttributeStatementExpression", + "GROUP": "#/components/schemas/SamlAttributeStatementGroup" + }, + "propertyName": "type" + }, + "properties": { + "type": { + "description": "The type of attribute statements object", + "enum": [ + "EXPRESSION", + "GROUP" + ], + "type": "string" + } + }, + "type": "object" + }, + "SamlAttributeStatementExpression": { + "description": "Generic `EXPRESSION` attribute statements", + "properties": { + "name": { + "description": "The name of the attribute in your app. The attribute name must be unique across all user and group attribute statements.", + "example": "attributeOne", + "type": "string" + }, + "namespace": { + "description": "The name format of the attribute. Supported values:", + "enum": [ + "urn:oasis:names:tc:SAML:2.0:attrname-format:basic", + "urn:oasis:names:tc:SAML:2.0:attrname-format:uri", + "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified" + ], + "example": "urn:oasis:names:tc:SAML:2.0:attrname-format:basic", + "type": "string", + "x-enumDescriptions": { + "urn:oasis:names:tc:SAML:2.0:attrname-format:basic": "Basic", + "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified": "Unspecified", + "urn:oasis:names:tc:SAML:2.0:attrname-format:uri": "URI reference" + } + }, + "type": { + "description": "The type of attribute statements object", + "example": "EXPRESSION", + "type": "string" + }, + "values": { + "description": "The attribute values (supports [Okta Expression Language](https://developer.okta.com/docs/reference/okta-expression-language/))", + "items": { + "example": "ValueOne", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SamlAttributeStatementGroup": { + "description": "`GROUP` attribute statements", + "properties": { + "filterType": { + "description": "The operation to filter groups based on `filterValue`", + "enum": [ + "STARTS_WITH", + "EQUALS", + "CONTAINS", + "REGEX" + ], + "type": "string" + }, + "filterValue": { + "description": "Filter the groups based on a specific value.", + "example": "Team", + "type": "string" + }, + "name": { + "description": "The name of the group attribute in your app. The attribute name must be unique across all user and group attribute statements.", + "type": "string" + }, + "namespace": { + "description": "The name format of the group attribute. Supported values:", + "enum": [ + "urn:oasis:names:tc:SAML:2.0:attrname-format:basic", + "urn:oasis:names:tc:SAML:2.0:attrname-format:uri", + "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified" + ], + "example": "urn:oasis:names:tc:SAML:2.0:attrname-format:basic", + "type": "string", + "x-enumDescriptions": { + "urn:oasis:names:tc:SAML:2.0:attrname-format:basic": "Basic", + "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified": "Unspecified", + "urn:oasis:names:tc:SAML:2.0:attrname-format:uri": "URI reference" + } + }, + "type": { + "description": "The type of attribute statements object", + "example": "GROUP", + "type": "string" + } + }, + "type": "object" + }, + "SamlCredentials": { + "description": "Federation Trust Credentials for verifying assertions from the IdP and signing requests to the IdP", + "properties": { + "signing": { + "$ref": "#/components/schemas/SamlSigningCredentials" + }, + "trust": { + "$ref": "#/components/schemas/SamlTrustCredentials" + } + }, + "type": "object" + }, + "SamlEndpointType": { + "default": "INSTANCE", + "description": "Determines whether to publish an instance-specific (trust) or organization (shared) ACS endpoint in the SAML metadata", + "enum": [ + "INSTANCE", + "ORG" + ], + "type": "string" + }, + "SamlEndpoints": { + "description": "SAML 2.0 HTTP binding settings for IdP and SP (Okta)", + "properties": { + "acs": { + "$ref": "#/components/schemas/SamlAcsEndpoint" + }, + "slo": { + "$ref": "#/components/schemas/SamlSloEndpoint" + }, + "sso": { + "$ref": "#/components/schemas/SamlSsoEndpoint" + } + }, + "type": "object" + }, + "SamlNameIdFormat": { + "default": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "description": "SAML 2.0 Name Identifier formats", + "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" + ], + "type": "string" + }, + "SamlRelayState": { + "description": "Relay state settings for IdP", + "properties": { + "format": { + "$ref": "#/components/schemas/SamlRelayStateFormat" + } + }, + "type": "object" + }, + "SamlRelayStateFormat": { + "description": "The format used to generate the `relayState` in the SAML request. The `FROM_URL` format is used if this value is null.", + "enum": [ + "FROM_URL", + "OPAQUE" + ], + "type": "string" + }, + "SamlRequestAlgorithm": { + "description": "Algorithm settings used to secure an `<AuthnRequest>` message", + "properties": { + "digest": { + "$ref": "#/components/schemas/SamlRequestDigestAlgorithm" + }, + "signature": { + "$ref": "#/components/schemas/SamlRequestSignatureAlgorithm" + } + }, + "type": "object" + }, + "SamlRequestDigestAlgorithm": { + "description": "XML Digest Algorithm setting for cryptographically hashing `<AuthnRequest>` messages sent to the IdP\n> **Note:** This property is ignored when you disable request signatures (`scope` set as `NONE`).", + "enum": [ + "SHA-1", + "SHA-256" + ], + "example": "SHA-256", + "type": "string", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "SamlRequestSignatureAlgorithm": { + "description": "XML digital Signature Algorithm settings for signing `<AuthnRequest>` messages sent to the IdP\n> **Note:** The `algorithm` property is ignored when you disable request signatures (`scope` set as `NONE`).", + "properties": { + "algorithm": { + "$ref": "#/components/schemas/SamlSigningAlgorithm" + }, + "scope": { + "$ref": "#/components/schemas/ProtocolAlgorithmRequestScope" + } + }, + "type": "object" + }, + "SamlResponseAlgorithm": { + "description": "Algorithm settings for verifying `<SAMLResponse>` messages and `<Assertion>` elements from the IdP", + "properties": { + "signature": { + "$ref": "#/components/schemas/SamlResponseSignatureAlgorithm" + } + }, + "type": "object" + }, + "SamlResponseSignatureAlgorithm": { + "description": "XML digital Signature Algorithm settings for verifying `<SAMLResponse>` messages and `<Assertion>` elements from the IdP", + "properties": { + "algorithm": { + "$ref": "#/components/schemas/SamlSigningAlgorithm" + }, + "scope": { + "$ref": "#/components/schemas/ProtocolAlgorithmResponseScope" + } + }, + "type": "object" + }, + "SamlSettings": { + "description": "Advanced settings for the SAML 2.0 protocol", + "properties": { + "honorPersistentNameId": { + "default": true, + "description": "Determines if the IdP should persist account linking when the incoming assertion NameID format is `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`", + "type": "boolean" + }, + "nameFormat": { + "$ref": "#/components/schemas/SamlNameIdFormat" + }, + "participateSlo": { + "description": "Set to `true` to have Okta send a logout request to the upstream IdP when a user signs out of Okta or a downstream app.", + "type": "boolean" + }, + "sendApplicationContext": { + "default": false, + "description": "Determines if the IdP should send the application context as `<OktaAppInstanceId>` and `<OktaAppName>` in the `<saml2p:Extensions>` element of the `<AuthnRequest>` message", + "type": "boolean" + } + }, + "type": "object" + }, + "SamlSigningAlgorithm": { + "enum": [ + "SHA-1", + "SHA-256" + ], + "example": "SHA-256", + "type": "string" + }, + "SamlSigningCredentials": { + "description": "Key used for signing requests to the IdP", + "properties": { + "kid": { + "$ref": "#/components/schemas/ProtocolCredentialsKeyId" + } + }, + "type": "object" + }, + "SamlSloEndpoint": { + "description": "IdP's `SingleLogoutService` endpoint where Okta sends a `<LogoutRequest>` message", + "properties": { + "binding": { + "$ref": "#/components/schemas/ProtocolEndpointBinding" + }, + "url": { + "description": "URL of the binding-specific IdP endpoint where Okta sends a `<LogoutRequest>`", + "example": "https://idp.example.com/saml2/slo", + "maxLength": 1014, + "type": "string" + } + }, + "type": "object" + }, + "SamlSpCertificate": { + "description": "The certificate that Okta uses to validate Single Logout (SLO) requests and responses", + "properties": { + "x5c": { + "description": "A list that contains exactly one x509 encoded certificate", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SamlSsoEndpoint": { + "description": "IdP's `SingleSignOnService` endpoint where Okta sends an `<AuthnRequest>` message", + "properties": { + "binding": { + "$ref": "#/components/schemas/ProtocolEndpointBinding" + }, + "destination": { + "description": "URI reference that indicates the address to which the `<AuthnRequest>` message is sent.\nThe `destination` property is required if request signatures are specified. See [SAML 2.0 Request Algorithm object](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=protocol/0/algorithms/request&t=request).", + "example": "https://idp.example.com/saml2/sso", + "maxLength": 512, + "type": "string" + }, + "url": { + "description": "URL of the binding-specific endpoint to send an `<AuthnRequest>` message to the IdP.\nThe value of `url` defaults to the same value as the `sso` endpoint if omitted during creation of a new IdP instance.\nThe `url` should be the same value as the `Location` attribute for a published binding in the IdP's SAML Metadata `IDPSSODescriptor`.", + "example": "https://idp.example.com/saml2/sso", + "maxLength": 1014, + "type": "string" + } + }, + "type": "object" + }, + "SamlTrustCredentials": { + "description": "Federation Trust Credentials for verifying assertions from the IdP", + "properties": { + "additionalKids": { + "description": "Additional IdP key credential reference to the Okta X.509 signature certificate", + "items": { + "$ref": "#/components/schemas/ProtocolCredentialsKeyId" + }, + "maxItems": 1, + "type": "array" + }, + "audience": { + "description": "URI that identifies the target Okta IdP instance (SP) for an `<Assertion>`", + "example": "https://www.okta.com/saml2/service-provider/spgv32vOnpdyeGSaiUpL", + "maxLength": 1024, + "type": "string" + }, + "issuer": { + "description": "URI that identifies the issuer (IdP) of a `<SAMLResponse>` message `<Assertion>` element", + "example": "urn:example:idp", + "maxLength": 1024, + "type": "string" + }, + "kid": { + "$ref": "#/components/schemas/ProtocolCredentialsKeyId" + } + }, + "type": "object" + }, + "ScheduledUserLifecycleAction": { + "properties": { + "status": { + "$ref": "#/components/schemas/PolicyUserStatus" + } + }, + "type": "object" + }, + "SchemeApplicationCredentials": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationCredentials" + }, + { + "properties": { + "password": { + "$ref": "#/components/schemas/PasswordCredential" + }, + "revealPassword": { + "description": "Allow users to securely see their password", + "type": "boolean" + }, + "scheme": { + "$ref": "#/components/schemas/ApplicationCredentialsScheme" + }, + "signing": { + "$ref": "#/components/schemas/ApplicationCredentialsSigning" + }, + "userName": { + "description": "Shared username for the app", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "Scim": { + "description": "SCIM configuration details", + "properties": { + "authMode": { + "description": "The authentication mode for requests to your SCIM server\n\n| authMode | Description |\n| -------- | ----------- |\n| `header` | Uses authorization header with a customer-provided token value in the following format: `Authorization: {API token}` |\n| `bearer` | Uses authorization header with a customer-provided bearer token in the following format: `Authorization: Bearer {API token}` |\n| {authModeId} | The ID of the auth mode object that contains OAuth 2.0 credentials. <br> **Note:** Use the `/integrations/api/v1/internal/authModes` endpoint to create the auth mode object. |", + "example": "header", + "type": "string" + }, + "baseUri": { + "description": "The base URL that Okta uses to send outbound calls to your SCIM server.\nOnly the HTTPS protocol is supported.\nYou can use the app-level variables defined in the `config` array for the base URL.\nFor example, if you have a `subdomain` variable defined in the `config` array and the URL to retrieve SCIM users for your integration is `https://${subdomain}.example.com/scim/v2/Users`,\nthen specify the following base URL: `'https://' + app.subdomain + '.example.com/scim/v2'`.", + "format": "uri", + "type": "string" + }, + "entitlementTypes": { + "$ref": "#/components/schemas/entitlementTypes" + }, + "scimServerConfig": { + "description": "SCIM server schema configuration", + "properties": { + "changePassword": { + "description": "Password change options", + "properties": { + "supported": { + "default": false, + "description": "Specifies if password change is supported", + "type": "boolean" + } + }, + "type": "object" + }, + "patch": { + "description": "PATCH operation options", + "properties": { + "supported": { + "default": false, + "description": "Specifies if the PATCH operation is supported", + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "setupInstructionsUri": { + "description": "The URL to your customer-facing instructions for configuring your SCIM integration. See [Customer configuration document guidelines](https://developer.okta.com/docs/guides/submit-app-prereq/main/#customer-configuration-document-guidelines).", + "format": "uri", + "type": "string" + } + }, + "required": [ + "baseUri", + "authMode", + "setupInstructionsUri", + "scimServerConfig" + ], + "type": "object" + }, + "Scope": { + "type": "string" + }, + "ScopeResourceHrefObject": { + "properties": { + "href": { + "description": "Link URI", + "example": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scpCmCCV1DpxVkCaye2X", + "type": "string" + }, + "title": { + "description": "Link name", + "example": "My phone", + "type": "string" + } + }, + "type": "object" + }, + "ScreenLockComplexity": { + "description": "Indicates whether a device has a screen lock set, and the type or complexity of the screen lock\n\n**Note:** This option requires a `screenLockType.include` value.\n", + "enum": [ + "HIGH", + "LOW", + "MEDIUM" + ], + "type": "string", + "x-enumDescriptions": { + "HIGH": "A complex 8-digit PIN, or 6-character alphabetic or alphanumeric screen lock is set", + "LOW": "A pattern or PIN is set", + "MEDIUM": "A complex PIN, or alphabetic or alphanumeric screen lock with at least 4 digits is set" + } + }, + "ScreenLockType": { + "enum": [ + "BIOMETRIC", + "NONE", + "PASSCODE" + ], + "type": "string" + }, + "SecurePasswordStoreApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/Application" + }, + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/SchemeApplicationCredentials" + }, + "name": { + "description": "`template_sps` is the key name for a SWA app instance that uses HTTP POST and doesn't require a browser plugin", + "enum": [ + "template_sps" + ], + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/SecurePasswordStoreApplicationSettings" + } + }, + "required": [ + "name", + "settings" + ], + "type": "object" + } + ], + "x-okta-defined-as": { + "name": "template_sps" + } + }, + "SecurePasswordStoreApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/SecurePasswordStoreApplicationSettingsApplication" + } + }, + "type": "object" + } + ] + }, + "SecurePasswordStoreApplicationSettingsApplication": { + "properties": { + "optionalField1": { + "description": "Name of the optional parameter in the sign-in form", + "type": "string" + }, + "optionalField1Value": { + "description": "Name of the optional value in the sign-in form", + "type": "string" + }, + "optionalField2": { + "description": "Name of the optional parameter in the sign-in form", + "type": "string" + }, + "optionalField2Value": { + "description": "Name of the optional value in the sign-in form", + "type": "string" + }, + "optionalField3": { + "description": "Name of the optional parameter in the sign-in form", + "type": "string" + }, + "optionalField3Value": { + "description": "Name of the optional value in the sign-in form", + "type": "string" + }, + "passwordField": { + "description": "CSS selector for the **Password** field in the sign-in form", + "type": "string" + }, + "url": { + "description": "The URL of the sign-in page for this app", + "type": "string" + }, + "usernameField": { + "description": "CSS selector for the **Username** field in the sign-in form", + "type": "string" + } + }, + "required": [ + "passwordField", + "url", + "usernameField" + ], + "type": "object" + }, + "SecurityEvent": { + "properties": { + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "subject": { + "$ref": "#/components/schemas/SecurityEventSubject" + } + }, + "required": [ + "event_timestamp", + "subject" + ], + "type": "object" + }, + "SecurityEventReason": { + "properties": { + "en": { + "description": "The event reason in English", + "example": "Event message example", + "type": "string" + } + }, + "required": [ + "en" + ], + "type": "object" + }, + "SecurityEventSubject": { + "description": "The event subjects", + "properties": { + "device": { + "description": "The device involved with the event", + "example": { + "format": "opaque", + "id": "device-identifier-001" + }, + "type": "object" + }, + "user": { + "description": "The user involved with the event", + "example": { + "email": "john@doe.net", + "format": "email" + }, + "type": "object" + } + }, + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "SecurityEventTokenError": { + "description": "Error object thrown when parsing the security event token", + "properties": { + "description": { + "description": "Describes the error\n> **Note:** SET claim fields with underscores (snake case) are presented in camelcase. For example, `previous_status` appears as `previousStatus`.\n", + "example": "Failed claim validation in security event token. 'events.mediationDeviceComplianceChangeEvent.previousStatus': The field cannot be left blank", + "type": "string" + }, + "err": { + "description": "A code that describes the category of the error", + "enum": [ + "authentication_failed", + "invalid_audience", + "invalid_issuer", + "invalid_key", + "invalid_request" + ], + "example": "invalid_request", + "type": "string" + } + }, + "title": "Security event token error", + "type": "object" + }, + "SecurityEventTokenJwtBody": { + "description": "JSON web token body payload for a security event token sent by the SSF transmitter. For examples and more information, see [SSF Transmitter SET payload structures](https://developer.okta.com/docs/reference/ssf-transmitter-sets).", + "properties": { + "aud": { + "description": "Audience", + "example": "https://receiverexample.com/", + "type": "string" + }, + "events": { + "$ref": "#/components/schemas/SecurityEventTokenJwtEvents" + }, + "iat": { + "description": "Token issue time (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "iss": { + "description": "Token issuer", + "example": "https://transmitter.okta.com", + "type": "string" + }, + "jti": { + "description": "Token ID", + "example": "set-24c63fb56f ... a9fa24", + "type": "string" + } + }, + "required": [ + "iss", + "aud", + "jti", + "iat", + "events" + ], + "title": "Security event token JWT body payload", + "type": "object", + "x-tags": [ + "SSFTransmitter" + ] + }, + "SecurityEventTokenJwtEvents": { + "description": "A non-empty set of events. Expected size is 1 for each SET", + "properties": { + "https://schemas.openid.net/secevent/caep/event-type/credential-change": { + "$ref": "#/components/schemas/CaepCredentialChangeEvent" + }, + "https://schemas.openid.net/secevent/caep/event-type/session-revoked": { + "$ref": "#/components/schemas/SsfTransmitterCaepSessionRevokedEvent" + } + }, + "type": "object" + }, + "SecurityEventTokenJwtHeader": { + "description": "JSON web token header for a security event token sent by the SSF transmitter", + "properties": { + "alg": { + "description": "Algorithm used to sign or encrypt the JWT", + "example": "RS256", + "type": "string" + }, + "kid": { + "description": "Key ID used to sign or encrypt the JWT", + "type": "string" + }, + "typ": { + "description": "The type of content being signed or encrypted", + "example": "secevent+jwt", + "type": "string" + } + }, + "required": [ + "kid", + "typ", + "alg" + ], + "title": "Security event token JWT header", + "type": "object", + "x-tags": [ + "SSFTransmitter" + ] + }, + "SecurityEventTokenRequestJwtBody": { + "description": "JSON web token body payload for a security event token", + "properties": { + "aud": { + "description": "Audience", + "example": "https://receiverexample.okta.com/", + "type": "string" + }, + "events": { + "$ref": "#/components/schemas/SecurityEventTokenRequestJwtEvents" + }, + "iat": { + "description": "Token issue time (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "iss": { + "description": "Token issuer", + "example": "https://transmitter.example.com", + "type": "string" + }, + "jti": { + "description": "Token ID", + "example": "24c63fb56f ... a9fa24", + "type": "string" + } + }, + "required": [ + "iss", + "aud", + "jti", + "iat", + "events" + ], + "title": "Security event token JWT body payload", + "type": "object", + "x-tags": [ + "SSFSecurityEventToken" + ] + }, + "SecurityEventTokenRequestJwtEvents": { + "description": "A non-empty collection of events", + "properties": { + "https://schemas.okta.com/secevent/okta/event-type/device-risk-change": { + "$ref": "#/components/schemas/OktaDeviceRiskChangeEvent" + }, + "https://schemas.okta.com/secevent/okta/event-type/ip-change": { + "$ref": "#/components/schemas/OktaIpChangeEvent" + }, + "https://schemas.okta.com/secevent/okta/event-type/user-risk-change": { + "$ref": "#/components/schemas/OktaUserRiskChangeEvent" + }, + "https://schemas.openid.net/secevent/caep/event-type/device-compliance-change": { + "$ref": "#/components/schemas/CaepDeviceComplianceChangeEvent" + }, + "https://schemas.openid.net/secevent/caep/event-type/session-revoked": { + "$ref": "#/components/schemas/CaepSessionRevokedEvent" + }, + "https://schemas.openid.net/secevent/risc/event-type/identifier-changed": { + "$ref": "#/components/schemas/RiscIdentifierChangedEvent" + } + }, + "type": "object" + }, + "SecurityEventTokenRequestJwtHeader": { + "description": "JSON web token header for a security event token", + "properties": { + "alg": { + "description": "Algorithm used to sign or encrypt the JWT", + "example": "RS256", + "type": "string" + }, + "kid": { + "description": "Key ID used to sign or encrypt the JWT", + "type": "string" + }, + "typ": { + "description": "The type of content being signed or encrypted", + "example": "secevent+jwt", + "type": "string" + } + }, + "required": [ + "kid", + "typ", + "alg" + ], + "title": "Security event token JWT header", + "type": "object", + "x-tags": [ + "SSFSecurityEventToken" + ] + }, + "SecurityEventsProviderRequest": { + "description": "The request schema for creating or updating a security events provider. The `settings` must match one of the schemas.", + "properties": { + "name": { + "description": "The name of the security events provider instance", + "example": "Target SSF Provider", + "maxLength": 100, + "type": "string" + }, + "settings": { + "description": "Information about the security events provider for signal ingestion", + "oneOf": [ + { + "$ref": "#/components/schemas/SecurityEventsProviderSettingsSSFCompliant" + }, + { + "$ref": "#/components/schemas/SecurityEventsProviderSettingsNonSSFCompliant" + } + ], + "type": "object" + }, + "type": { + "description": "The app type of the security events provider", + "example": "okta", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "name", + "settings", + "type" + ], + "title": "Security events provider request", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "SecurityEventsProviderResponse": { + "description": "The security events provider response", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + }, + "id": { + "description": "The unique identifier of this instance", + "example": "sse1qg25RpusjUP6m0g5", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the security events provider instance", + "example": "Target SSF Provider", + "maxLength": 100, + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/SecurityEventsProviderSettingsResponse", + "description": "Information about the security events provider for signal ingestion" + }, + "status": { + "description": "Indicates whether the security events provider is active or not", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The app type of the security events provider", + "example": "okta", + "maxLength": 255, + "type": "string" + } + }, + "title": "Security events provider response", + "type": "object" + }, + "SecurityEventsProviderSettingsNonSSFCompliant": { + "description": "Security events provider with issuer and JWKS settings for signal ingestion", + "properties": { + "issuer": { + "description": "Issuer URL", + "example": "example.okta.com", + "maxLength": 700, + "type": "string" + }, + "jwks_url": { + "description": "The public URL where the JWKS public key is uploaded", + "example": "https://example.okta.com/oauth2/v1/keys", + "format": "url", + "maxLength": 1000, + "type": "string" + } + }, + "required": [ + "jwks_url", + "issuer" + ], + "title": "Provider with issuer and JWKS settings", + "type": "object" + }, + "SecurityEventsProviderSettingsResponse": { + "description": "Security events provider settings", + "properties": { + "issuer": { + "description": "Issuer URL", + "example": "example.okta.com", + "maxLength": 700, + "type": "string" + }, + "jwks_url": { + "description": "The public URL where the JWKS public key is uploaded", + "example": "https://example.okta.com/oauth2/v1/keys", + "format": "url", + "maxLength": 1000, + "type": "string" + }, + "well_known_url": { + "description": "The well-known URL of the security events provider (the SSF transmitter)", + "example": "https://example.okta.com/.well-known/ssf-configuration", + "format": "url", + "maxLength": 1000, + "nullable": true, + "type": "string" + } + }, + "title": "Security events provider settings", + "type": "object" + }, + "SecurityEventsProviderSettingsSSFCompliant": { + "description": "Security events provider with well-known URL setting", + "properties": { + "well_known_url": { + "description": "The published well-known URL of the security events provider (the SSF transmitter)", + "example": "https://example.okta.com/.well-known/ssf-configuration", + "format": "url", + "maxLength": 1000, + "type": "string" + } + }, + "required": [ + "well_known_url" + ], + "title": "Provider with well-known URL setting", + "type": "object" + }, + "SeedEnum": { + "default": "RANDOM", + "description": "Determines whether the generated password is the user's Okta password or a randomly generated password", + "enum": [ + "OKTA", + "RANDOM" + ], + "example": "OKTA", + "type": "string" + }, + "SelfAssignedStatus": { + "description": "Okta Support access approval status for self-assigned cases", + "enum": [ + "APPROVED", + "NOT_REQUIRED", + "REQUESTED" + ], + "type": "string", + "x-enumDescriptions": { + "APPROVED": "Okta Support access is approved by the customer for the self-assigned case", + "NOT_REQUIRED": "Approval isn't required because the case wasn't self-created and self-assigned by an Okta Support user", + "REQUESTED": "Customer approval for self-assigned case requested" + } + }, + "SelfServicePasswordResetAction": { + "description": "Enables or disables users to reset their own password and defines the authenticators and constraints needed to complete the reset", + "properties": { + "access": { + "$ref": "#/components/schemas/PolicyAccess" + }, + "requirement": { + "$ref": "#/components/schemas/SsprRequirement" + }, + "settings": { + "$ref": "#/components/schemas/SsprSettings" + }, + "type": { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle> The type of rule action", + "enum": [ + "selfServicePasswordReset" + ], + "type": "string" + } + }, + "type": "object" + }, + "ServiceAccount": { + "discriminator": { + "mapping": { + "APP_ACCOUNT": "#/components/schemas/ServiceAccountDetailsAppAccount", + "OKTA_USER_ACCOUNT": "#/components/schemas/ServiceAccountDetailsOktaUserAccount" + }, + "propertyName": "accountType" + }, + "properties": { + "accountType": { + "$ref": "#/components/schemas/ServiceAccountType" + }, + "created": { + "description": "Timestamp when the service account was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the service account", + "example": "This is for accessing salesforce Prod-5", + "format": "regex", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "The UUID of the service account", + "example": "a747a818-a4c4-4446-8a87-704216495a08", + "format": "regex", + "pattern": "(?i)^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the service account was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The user-defined name for the service account", + "example": "AWS Prod-5 account", + "format": "regex", + "maxLength": 50, + "minLength": 1, + "pattern": "^[\\w\\-_. ]+$", + "type": "string" + }, + "ownerGroupIds": { + "description": "A list of IDs of the Okta groups that own the service account", + "example": [ + "00g57qp78yZT2XBA40g7" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ownerUserIds": { + "description": "A list of IDs of the Okta users that own the service account", + "example": [ + "00u11s48P9zGW8yqm0g5" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "status": { + "$ref": "#/components/schemas/ServiceAccountStatus" + }, + "statusDetail": { + "$ref": "#/components/schemas/ServiceAccountStatusDetail" + } + }, + "required": [ + "name", + "accountType" + ], + "type": "object" + }, + "ServiceAccountDetailsAppAccount": { + "allOf": [ + { + "$ref": "#/components/schemas/ServiceAccount" + }, + { + "properties": { + "details": { + "$ref": "#/components/schemas/ServiceAccountDetailsAppAccountSub" + } + }, + "required": [ + "details" + ], + "type": "object" + } + ], + "description": "Details for a SaaS app account, which will be managed as a service account" + }, + "ServiceAccountDetailsAppAccountSub": { + "description": "Details for a SaaS app account, which will be managed as a service account", + "properties": { + "appGlobalName": { + "description": "The name of the SaaS app in the Okta Integration Network catalog", + "example": "Salesforce", + "readOnly": true, + "type": "string" + }, + "appInstanceName": { + "description": "The instance name of the SaaS app", + "example": "Salesforce Prod", + "readOnly": true, + "type": "string" + }, + "credentials": { + "$ref": "#/components/schemas/AppServiceAccountCredentials" + }, + "oktaApplicationId": { + "description": "The Okta app instance ID of the SaaS app", + "example": "aln1aqcs055ZRoizW0g8", + "type": "string" + } + }, + "required": [ + "oktaApplicationId", + "credentials" + ], + "type": "object" + }, + "ServiceAccountDetailsOktaUserAccount": { + "allOf": [ + { + "$ref": "#/components/schemas/ServiceAccount" + }, + { + "properties": { + "details": { + "$ref": "#/components/schemas/ServiceAccountDetailsOktaUserAccountSub" + } + }, + "required": [ + "details" + ], + "type": "object" + } + ], + "description": "Details for managing an Okta user as a service account" + }, + "ServiceAccountDetailsOktaUserAccountSub": { + "description": "Details for managing an Okta user as a service account", + "properties": { + "credentials": { + "$ref": "#/components/schemas/OktaUserServiceAccountCredentials" + }, + "email": { + "description": "The email address for the Okta user", + "example": "foo@bar.com", + "readOnly": true, + "type": "string" + }, + "oktaUserId": { + "description": "The ID of the Okta user to manage as a service account", + "example": "00u11s48P9zGW8yqm0g5", + "maxLength": 20, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "oktaUserId" + ], + "type": "object" + }, + "ServiceAccountForUpdate": { + "properties": { + "description": { + "description": "The description of the service account", + "example": "This is for accessing AWS Prod-5", + "format": "regex", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The human-readable name for the service account", + "example": "AWS Prod-5 account", + "format": "regex", + "maxLength": 50, + "minLength": 1, + "pattern": "^[\\w\\-_. ]+$", + "type": "string" + }, + "ownerGroupIds": { + "description": "A list of IDs of the Okta groups who own the service account", + "example": [ + "00g57qp78yZT2XBA40g7" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ownerUserIds": { + "description": "A list of IDs of the Okta users who own the service account", + "example": [ + "00u11s48P9zGW8yqm0g5" + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ServiceAccountStatus": { + "description": "Describes the current status of a service account", + "enum": [ + "ALERT", + "ERROR", + "INFO", + "NO_ISSUES", + "UNSECURED" + ], + "example": "UNSECURED", + "readOnly": true, + "type": "string", + "x-enumDescriptions": { + "ALERT": "The account requires attention from an admin", + "ERROR": "An error is preventing Okta Privileged Access from using the account", + "INFO": "An action involving the account is in progress in Okta Privileged Access", + "NO_ISSUES": "The account is ready for use in Okta Privileged Access", + "UNSECURED": "The account needs to be assigned to a resource group and a project in Okta Privileged Access" + } + }, + "ServiceAccountStatusDetail": { + "description": "Describes the detailed status of a service account", + "enum": [ + "CREATION_FAILED", + "MISSING_PASSWORD", + "PENDING", + "ROTATED", + "ROTATING", + "ROTATION_FAILED", + "STAGED", + "UNMANAGED", + "VAULTED" + ], + "example": "STAGED", + "readOnly": true, + "type": "string", + "x-enumDescriptions": { + "CREATION_FAILED": "The account can't be created", + "MISSING_PASSWORD": "The account is assigned to a project in Okta Privileged Access. A password isn't assigned to the account.", + "PENDING": "The account is being created", + "ROTATED": "The account is assigned to a project in Okta Privileged Access. Password rotations are fulfilled by Okta Lifecycle Management.", + "ROTATING": "The account is assigned to a project in Okta Privileged Access. Credentials are currently being synced using Okta Lifecycle Management.", + "ROTATION_FAILED": "The account is assigned to a project in Okta Privileged Access. An error occurred while using Okta Lifecycle Management to rotate the password.", + "STAGED": "The account is in the Okta Privileged Access resource assignment area", + "UNMANAGED": "The account is assigned to a project in Okta Privileged Access. Initial password sync hasn't been attempted.", + "VAULTED": "The account is assigned to a project in Okta Privileged Access. A manually managed password is assigned to the account." + } + }, + "ServiceAccountType": { + "description": "The type of service account", + "enum": [ + "APP_ACCOUNT", + "OKTA_USER_ACCOUNT" + ], + "type": "string", + "x-enumDescriptions": { + "APP_ACCOUNT": "SaaS app account", + "OKTA_USER_ACCOUNT": "Okta user account" + } + }, + "Session": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "amr": { + "description": "Authentication method reference", + "items": { + "$ref": "#/components/schemas/SessionAuthenticationMethod" + }, + "readOnly": true, + "type": "array" + }, + "createdAt": { + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "expiresAt": { + "description": "A timestamp when the session expires", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "A unique key for the session", + "readOnly": true, + "type": "string" + }, + "idp": { + "$ref": "#/components/schemas/SessionIdentityProvider" + }, + "lastFactorVerification": { + "description": "A timestamp when the user last performed multifactor authentication", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastPasswordVerification": { + "description": "A timestamp when the user last performed the primary or step-up authentication with a password", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "login": { + "description": "A unique identifier for the user (username)", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/SessionStatus", + "description": "Current session status" + }, + "userId": { + "description": "A unique key for the user", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SessionAuthenticationMethod": { + "enum": [ + "fpt", + "geo", + "hwk", + "kba", + "mca", + "mfa", + "otp", + "pwd", + "sc", + "sms", + "swk", + "tel" + ], + "type": "string", + "x-enumDescriptions": { + "fpt": "Fingerprint biometric authentication. **Inline hook value:** `BIO_FINGERPRINT`. **Example:** Okta Verify with Touch ID", + "geo": "Use of geo-location information. **Inline hook value:** `GEOLOCATION`. **Example:** IP Trust and Network Zone policy conditions", + "hwk": "Proof-of-possession (PoP) of a hardware key. **Inline hook value:** `POP_HARDWARE_KEY` **Example:** Yubikey factor", + "kba": "Knowledge-based authentication. **Inline hook value:** `KNOWLEDGE_BASED_AUTHENTICATION`. **Example:** Security Question factor", + "mca": "Multiple-channel authentication. **Inline hook value:** `MULTIPLE_CHANNEL_AUTHENTICATION`. **Example:** Authentication requires communication over more than one channel, such as the Internet and a mobile network", + "mfa": "Multifactor authentication. **Inline hook value:** `MULTIFACTOR_AUTHENTICATION`. **Example:** This value is present whenever any MFA factor verification is performed.", + "opt": "One-time passcode. **Inline hook value:** `ONE_TIME_PASSWORD`. **Example:** Okta Verify, Google Authenticator", + "pwd": "Password authentication. **Inline hook value:** `PASSWORD` **Example:** Standard password-based sign-in flow", + "sc": "Smart card authentication. **Inline hook value:** `SMART_CARD. **Example:** User authenticated using a smart card, such as a Personal Identity Verification (PIV) card or Common Access Card (CAC)", + "sms": "SMS text message to the user at a registered number. **Inline hook value:** `SMS_MESSAGE`. **Example:** SMS factor", + "swk": "Proof-of-possession (PoP) of a software key. **Inline hook value:** `POP_SOFTWARE_KEY` **Example:** Okta Verify with Push", + "tel": "Telephone call to the user at a registered number. **Inline hook value:** `TELEPHONE_CALL`. **Example:** Phone call factor" + } + }, + "SessionIdentityProvider": { + "properties": { + "id": { + "description": "Identity Provider ID. If the `type` is `OKTA`, then the `id` is the org ID.", + "readOnly": true, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/SessionIdentityProviderType" + } + }, + "type": "object" + }, + "SessionIdentityProviderType": { + "enum": [ + "ACTIVE_DIRECTORY", + "FEDERATION", + "LDAP", + "OKTA", + "SOCIAL" + ], + "type": "string" + }, + "SessionStatus": { + "enum": [ + "ACTIVE", + "MFA_ENROLL", + "MFA_REQUIRED" + ], + "type": "string", + "x-enumDescriptions": { + "ACTIVE": "The session is established and fully validated.", + "MFA_ENROLL": "The session is established, but the user needs to enroll a second factor.", + "MFA_REQUIRED": "The session is established, but requires second factor verification." + } + }, + "SessionViolationDetectionPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/Policy" + }, + { + "properties": { + "conditions": { + "default": null, + "description": "Policy conditions aren't supported for this policy type", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "SessionViolationDetectionPolicyEvaluation": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Used to control evaluation of the session sign-on policies", + "properties": { + "enabled": { + "description": "When true, the sign-on policies of the session are evaluated", + "type": "boolean" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "SessionViolationDetectionPolicyRule": { + "allOf": [ + { + "$ref": "#/components/schemas/PolicyRule" + }, + { + "properties": { + "actions": { + "description": "The action to take when the rule conditions are satisfied", + "properties": { + "sessionViolationDetection": { + "description": "Used to define the actions taken as a result of evaluating session violation detection policy", + "properties": { + "policyEvaluation": { + "$ref": "#/components/schemas/SessionViolationDetectionPolicyEvaluation" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "conditions": { + "description": "Specifies policy evaluation conditions required to apply the rule. All policy conditions and conditions for at least one rule must be met to apply the settings specified in the policy and the associated rule.", + "properties": { + "network": { + "$ref": "#/components/schemas/PolicyNetworkCondition" + }, + "riskScore": { + "$ref": "#/components/schemas/SessionViolationDetectionRiskScoreCondition" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "SessionViolationDetectionRiskScoreCondition": { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Specifies the minimum risk score level required to trigger the rule", + "properties": { + "minRiskLevel": { + "description": "The minimum risk level to match.", + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ], + "type": "string" + } + }, + "required": [ + "minRiskLevel" + ], + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "ShowSignInWithOV": { + "description": "Controls whether to show the Sign in with Okta Verify button on the Sign-In Widget", + "enum": [ + "ALWAYS", + "NEVER" + ], + "type": "string" + }, + "SignInPage": { + "allOf": [ + { + "$ref": "#/components/schemas/CustomizablePage" + }, + { + "properties": { + "contentSecurityPolicySetting": { + "$ref": "#/components/schemas/ContentSecurityPolicySetting" + }, + "widgetCustomizations": { + "properties": { + "authenticatorPageCustomLinkLabel": { + "description": "The label for the authenticator page custom link", + "type": "string" + }, + "authenticatorPageCustomLinkUrl": { + "description": "The URL for the authenticator page custom link", + "type": "string" + }, + "classicFooterHelpTitle": { + "description": "The title of the footer link on the sign-in page. Only applicable for Classic Engine orgs.", + "type": "string" + }, + "classicRecoveryFlowEmailOrUsernameLabel": { + "description": "The label for the username field in the classic recovery flow", + "type": "string" + }, + "customLink1Label": { + "description": "The label for the first custom link", + "type": "string" + }, + "customLink1Url": { + "description": "The URL for the first custom link", + "type": "string" + }, + "customLink2Label": { + "description": "The label for the second custom link", + "type": "string" + }, + "customLink2Url": { + "description": "The URL for the second custom link", + "type": "string" + }, + "forgotPasswordLabel": { + "description": "The label for the forgot password page", + "type": "string" + }, + "forgotPasswordUrl": { + "description": "The forgot password URL", + "type": "string" + }, + "gracePeriodRequiredSoon": { + "$ref": "#/components/schemas/GracePeriodRequiredSoon" + }, + "helpLabel": { + "description": "The label for the help link", + "type": "string" + }, + "helpUrl": { + "description": "The help link URL", + "type": "string" + }, + "passwordInfoTip": { + "description": "The label for the password information tip", + "type": "string" + }, + "passwordLabel": { + "description": "The label for the password field", + "type": "string" + }, + "postAuthKeepMeSignedInPrompt": { + "$ref": "#/components/schemas/PostAuthKeepMeSignedInPrompt" + }, + "showPasswordVisibilityToggle": { + "description": "Allows users to see their passwords as they type", + "type": "boolean" + }, + "showUserIdentifier": { + "description": "Allows the user's identifier to appear on authentication and enrollment pages", + "type": "boolean" + }, + "signInLabel": { + "description": "The label for the sign in widget", + "type": "string" + }, + "unlockAccountLabel": { + "description": "The label for the unlock account link", + "type": "string" + }, + "unlockAccountUrl": { + "description": "The unlock account URL", + "type": "string" + }, + "usernameInfoTip": { + "description": "The label for the username information tip", + "type": "string" + }, + "usernameLabel": { + "description": "The label for the username field", + "type": "string" + }, + "widgetGeneration": { + "$ref": "#/components/schemas/WidgetGeneration" + } + }, + "type": "object" + }, + "widgetVersion": { + "$ref": "#/components/schemas/Version" + } + }, + "type": "object" + } + ] + }, + "SignInPageTouchPointVariant": { + "description": "Variant for the Okta sign-in page. You can publish a theme for sign-in page with different combinations of assets. Variants are preset combinations of those assets.\n> **Note:** For a non-`OKTA_DEFAULT` variant, `primaryColorHex` is used for button background color and `primaryColorContrastHex` is used to optimize the opacity for button text.\n", + "enum": [ + "BACKGROUND_IMAGE", + "BACKGROUND_SECONDARY_COLOR", + "OKTA_DEFAULT" + ], + "type": "string", + "x-enumDescriptions": { + "BACKGROUND_IMAGE": "Uses the logo, favicon, and background image from the theme", + "BACKGROUND_SECONDARY_COLOR": "Uses the logo and favicon from the theme. Uses `secondaryColorHex` as the background color for the Okta sign-in page.", + "OKTA_DEFAULT": "Uses the Okta logo and favicon with no background image. Uses the Okta colors on the Okta sign-in page." + } + }, + "SignOnInlineHook": { + "properties": { + "id": { + "readOnly": false, + "type": "string" + } + } + }, + "SigningAlgorithm": { + "enum": [ + "ES256", + "ES384", + "ES512", + "HS256", + "HS384", + "HS512", + "RS256", + "RS384", + "RS512" + ], + "type": "string" + }, + "SimulatePolicyBody": { + "description": "The request body required for a simulate policy operation", + "properties": { + "appInstance": { + "description": "The application instance ID for a simulate operation", + "type": "string" + }, + "policyContext": { + "$ref": "#/components/schemas/PolicyContext" + }, + "policyTypes": { + "description": "Supported policy types for a simulate operation. The default value, `null`, returns all types.", + "items": { + "$ref": "#/components/schemas/PolicyTypeSimulation" + }, + "type": "array" + } + }, + "required": [ + "appInstance" + ], + "type": "object" + }, + "SimulatePolicyEvaluations": { + "properties": { + "evaluated": { + "description": "A list of evaluated but not matched policies and rules", + "properties": { + "policies": { + "$ref": "#/components/schemas/SimulateResultPolicies" + } + }, + "type": "object" + }, + "policyType": { + "description": "The policy type of the simulate operation", + "items": { + "$ref": "#/components/schemas/PolicyTypeSimulation" + }, + "type": "array" + }, + "result": { + "$ref": "#/components/schemas/SimulatePolicyResult" + }, + "status": { + "$ref": "#/components/schemas/SimulateResultStatus" + }, + "undefined": { + "description": "A list of undefined but not matched policies and rules", + "properties": { + "policies": { + "$ref": "#/components/schemas/SimulateResultPolicies" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "SimulatePolicyResponse": { + "description": "The response body returned for a simulate policy operation. An array of `evaluations`.", + "items": { + "$ref": "#/components/schemas/SimulatePolicyEvaluations" + }, + "type": "array" + }, + "SimulatePolicyResult": { + "description": "The result of the policy evaluation", + "properties": { + "policies": { + "$ref": "#/components/schemas/SimulateResultPolicies" + } + }, + "type": "object" + }, + "SimulateResultConditions": { + "properties": { + "status": { + "$ref": "#/components/schemas/SimulateResultStatus" + }, + "type": { + "description": "The type of condition", + "type": "string" + } + }, + "type": "object" + }, + "SimulateResultPolicies": { + "items": { + "$ref": "#/components/schemas/SimulateResultPoliciesItems" + }, + "type": "array" + }, + "SimulateResultPoliciesItems": { + "properties": { + "conditions": { + "description": "List of all conditions involved for this policy evaluation", + "items": { + "$ref": "#/components/schemas/SimulateResultConditions" + }, + "type": "array" + }, + "id": { + "description": "ID of the specified policy type", + "type": "string" + }, + "name": { + "description": "Policy name", + "type": "string" + }, + "rules": { + "items": { + "$ref": "#/components/schemas/SimulateResultRules" + }, + "type": "array" + }, + "status": { + "$ref": "#/components/schemas/SimulateResultStatus" + } + }, + "type": "object" + }, + "SimulateResultRules": { + "properties": { + "conditions": { + "description": "List of all conditions involved for this rule evaluation", + "items": { + "$ref": "#/components/schemas/SimulateResultConditions" + }, + "type": "array" + }, + "id": { + "description": "The unique ID number of the policy rule", + "type": "string" + }, + "name": { + "description": "The name of the policy rule", + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/SimulateResultStatus" + } + }, + "type": "object" + }, + "SimulateResultStatus": { + "description": "The result of this entity evaluation", + "enum": [ + "MATCH", + "NOT_MATCH", + "UNDEFINED" + ], + "type": "string" + }, + "SingleLogout": { + "description": "Determines if the app supports Single Logout (SLO)", + "properties": { + "enabled": { + "description": "Whether the application supports SLO", + "type": "boolean" + }, + "issuer": { + "description": "The issuer of the Service Provider that generates the SLO request", + "type": "string" + }, + "logoutUrl": { + "description": "The location where the logout response is sent", + "type": "string" + } + }, + "type": "object" + }, + "SlackApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/OINApplication" + }, + { + "type": "object" + }, + { + "properties": { + "name": { + "enum": [ + "slack" + ], + "example": "slack", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/SlackApplicationSettings" + }, + "signOnMode": { + "enum": [ + "BROWSER_PLUGIN", + "SAML_2_0" + ], + "type": "string" + } + }, + "required": [ + "name", + "label", + "settings" + ] + } + ], + "description": "Schema for the Slack app (key name: `slack`)\n\nTo create a Slack app, use the [Create an Application](/openapi/okta-management/management/tags/application/other/createapplication) request with the following parameters in the request body.\n> **Note:** The Slack app only supports `BROWSER_PLUGIN` and `SAML_2_0` sign-on modes.\n", + "example": { + "label": "Sample Slack App", + "name": "slack", + "settings": { + "app": { + "domain": "my-company-domain" + } + }, + "signOnMode": "SAML_2_0" + }, + "title": "Slack", + "x-okta-defined-as": { + "name": "slack" + }, + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-tags": [ + "Application" + ] + }, + "SlackApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "type": "object" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/SlackApplicationSettingsApplication" + }, + "signOn": { + "$ref": "#/components/schemas/OINSaml20ApplicationSettingsSignOn" + } + }, + "required": [ + "app" + ] + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "SlackApplicationSettingsApplication": { + "description": "Slack app instance properties", + "properties": { + "domain": { + "description": "The Slack app domain name", + "type": "string" + }, + "userEmailValue": { + "description": "The `User.Email` attribute value", + "type": "string" + } + }, + "required": [ + "domain" + ], + "type": "object" + }, + "SloParticipate": { + "description": "Determines if the app participates in Single Logout (SLO)", + "properties": { + "bindingType": { + "description": "Request binding type", + "enum": [ + "POST", + "REDIRECT" + ], + "type": "string" + }, + "enabled": { + "description": "Indicates whether the app is allowed to participate in front-channel SLO", + "type": "boolean" + }, + "logoutRequestUrl": { + "description": "URL where Okta sends the logout request", + "type": "string" + }, + "sessionIndexRequired": { + "description": "Determines whether Okta sends the `SessionIndex` elements in the logout request", + "type": "boolean" + } + }, + "type": "object" + }, + "SmsTemplate": { + "properties": { + "created": { + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Human-readable name of the Template", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "template": { + "description": "Text of the Template, including any [macros](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Template/)", + "maxLength": 161, + "minLength": 1, + "type": "string" + }, + "translations": { + "$ref": "#/components/schemas/SmsTemplateTranslations" + }, + "type": { + "$ref": "#/components/schemas/SmsTemplateType" + } + }, + "type": "object" + }, + "SmsTemplateTranslations": { + "description": "- Template translations are optionally provided when you want to localize the SMS messages. Translations are provided as an object that contains `key:value` pairs: the language and the translated Template text. The key portion is a two-letter country code that conforms to [ISO 639-1](https://www.loc.gov/standards/iso639-2/php/code_list.php). The value is the translated SMS Template.\n- Just like with regular SMS Templates, the length of the SMS message can't exceed 160 characters.\n", + "type": "object", + "x-okta-extensible": true, + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "SmsTemplateType": { + "description": "Type of the Template", + "enum": [ + "SMS_VERIFY_CODE" + ], + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "SmtpAuthType": { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>The authentication type that's used by your SMTP server", + "enum": [ + "BASIC_SMTP_AUTH", + "OAUTH2_CLIENT_CREDENTIALS", + "OAUTH2_JWT_BEARER_GRANT" + ], + "type": "string", + "x-enumDescriptions": { + "BASIC_SMTP_AUTH": "Basic SMTP authentication uses a username and password to authenticate with your SMTP server", + "OAUTH2_CLIENT_CREDENTIALS": "OAuth 2.0 client credentials requires you to create an OAuth 2.0 app with your email provider to obtain a client ID and client secret", + "OAUTH2_JWT_BEARER_GRANT": "OAuth 2.0 JWT bearer token requires you to create an OAuth 2.0 app with your email provider and use a signed JWT to obtain an access token" + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "SocialAuthToken": { + "description": "The social authentication token object provides the tokens and associated metadata provided by social providers during social authentication.", + "properties": { + "expiresAt": { + "$ref": "#/components/schemas/ExpiresAt" + }, + "id": { + "description": "Unique identifier for the token", + "example": "NXp9GaX1eOA-XVF_H9fn2Q", + "readOnly": true, + "type": "string" + }, + "scopes": { + "description": "The scopes that the token is good for", + "example": [ + "openid", + "foo" + ], + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "token": { + "description": "The raw token", + "example": "JBTWGV22G4ZGKV3N", + "readOnly": true, + "type": "string" + }, + "tokenAuthScheme": { + "description": "The token authentication scheme as defined by the social provider", + "example": "Bearer", + "readOnly": true, + "type": "string" + }, + "tokenType": { + "description": "The type of token defined by the [OAuth Token Exchange Spec](https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-07#section-3)", + "example": "urn:ietf:params:oauth:token-type:access_token", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SourceLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "The associated schema" + } + ] + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "SplunkEdition": { + "description": "Edition of the Splunk Cloud instance", + "enum": [ + "aws", + "aws_govcloud", + "gcp" + ], + "example": "aws", + "type": "string" + }, + "SplunkHost": { + "description": "The domain name for your Splunk Cloud instance. Don't include `http` or `https` in the string. For example: `acme.splunkcloud.com`", + "example": "acme.splunkcloud.com", + "maxLength": 116, + "minLength": 17, + "type": "string" + }, + "SplunkToken": { + "description": "The HEC token for your Splunk Cloud HTTP Event Collector. The token value is set at object creation, but isn't returned.", + "example": "11111111-1111-2222-2222-222222222222", + "pattern": "(?i)^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", + "type": "string", + "writeOnly": true + }, + "SsfTransmitterCaepSessionRevokedEvent": { + "description": "The session of the subject was revoked", + "properties": { + "event_timestamp": { + "description": "The time of the event (UNIX timestamp)", + "example": 1702448550, + "format": "int64", + "type": "integer" + }, + "reason_admin": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized administrative message intended for logging and auditing", + "type": "object" + } + ] + }, + "reason_user": { + "allOf": [ + { + "$ref": "#/components/schemas/SecurityEventReason" + }, + { + "description": "A localized message intended for the end user", + "type": "object" + } + ] + }, + "subject": { + "$ref": "#/components/schemas/SsfTransmitterSecurityEventSubject" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "SsfTransmitterSecurityEventSubject": { + "description": "The event subject", + "properties": { + "format": { + "description": "The format of the subject", + "example": "iss_sub", + "type": "string" + }, + "iss": { + "description": "An identifier of the actor", + "example": "https://transmitter.okta.com", + "type": "string" + }, + "sub": { + "description": "An identifier for the subject that was acted on", + "example": "okta-user-id1", + "type": "string" + } + } + }, + "Sso": { + "description": "Supported SSO protocol configurations. You must configure at least one protocol: `oidc` or `saml`", + "properties": { + "oidc": { + "$ref": "#/components/schemas/Oidc" + }, + "saml": { + "$ref": "#/components/schemas/Saml" + } + }, + "type": "object" + }, + "SsoCapability": { + "description": "SSO capability configuration with embedded protocol details", + "properties": { + "capability": { + "description": "SSO capability identifier", + "enum": [ + "SSO" + ], + "type": "string" + }, + "supportedProtocols": { + "description": "List of supported SSO protocols", + "items": { + "enum": [ + "OIDC", + "SAML", + "GTR" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "capability", + "supportedProtocols" + ], + "type": "object" + }, + "SsprPrimaryRequirement": { + "description": "Defines the authenticators permitted for the initial authentication step of password recovery", + "properties": { + "methodConstraints": { + "description": "Constraints on the values specified in the `methods` array. Specifying a constraint limits methods to specific authenticator(s). Currently, Google OTP is the only accepted constraint.", + "items": { + "$ref": "#/components/schemas/AuthenticatorMethodConstraint" + }, + "type": "array", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "methods": { + "description": "Authenticator methods allowed for the initial authentication step of password recovery. Method `otp` requires a constraint limiting it to a Google authenticator.", + "items": { + "enum": [ + "push", + "sms", + "voice", + "email", + "otp" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SsprRequirement": { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle> Describes the initial and secondary authenticator requirements a user needs to reset their password", + "properties": { + "accessControl": { + "description": "Determines which authentication requirements a user needs to perform self-service operations. `AUTH_POLICY` defers conditions and authentication requirements to the [Okta account management policy](https://developer.okta.com/docs/guides/okta-account-management-policy/main/). `LEGACY` refers to the requirements described by this rule.", + "enum": [ + "AUTH_POLICY", + "LEGACY" + ], + "type": "string" + }, + "primary": { + "$ref": "#/components/schemas/SsprPrimaryRequirement" + }, + "stepUp": { + "$ref": "#/components/schemas/SsprStepUpRequirement" + } + }, + "type": "object" + }, + "SsprSettings": { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle></x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle> Describes other behavioral settings that apply to the self-service password reset (SSPR) process", + "properties": { + "allowRecoveryEmailWithoutEnrollment": { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle> Controls whether a user can receive a password recovery email at their profile email address even if they haven't enrolled email as an authenticator.\n\n* `true`: Email appears as a recovery option during password reset and account unlock for users without an enrolled email authenticator. The recovery OTP is sent to the email address on the user's profile.\n* `false` or `null`: Email recovery requires an enrolled email authenticator. This is the default behavior for Identity Engine orgs.\n\nFor orgs that have migrated from Classic Engine to Identity Engine, `allowRecoveryEmailWithoutEnrollment` is set to `true`. It's set to `true` by the migration action to preserve Classic Engine behavior where recovery emails are always sent to the profile email address regardless of the user's enrollment state.\n\n> **Note:** This property is only available if the Email auto-enrollment and recovery control [self-service EA](/openapi/okta-management/guides/release-lifecycle/#early-access-ea) feature is enabled.", + "nullable": true, + "type": "boolean" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "SsprStepUpRequirement": { + "description": "Defines the secondary authenticators needed for password reset if `required` is true. The following are three valid configurations:\n* `required`=false\n* `required`=true with no methods to use any SSO authenticator\n* `required`=true with `security_question` as the method", + "properties": { + "methods": { + "description": "Authenticator methods required for secondary authentication step of password recovery. Specify this value only when `required` is true and `security_question` is permitted for the secondary authentication.", + "items": { + "enum": [ + "security_question" + ], + "type": "string" + }, + "type": "array" + }, + "required": { + "type": "boolean" + } + }, + "type": "object" + }, + "StandardRole": { + "properties": { + "_embedded": { + "description": "Optional embedded resources for the role assignment", + "properties": { + "targets": { + "description": "Targets configured for the role assignment", + "properties": { + "catalog": { + "description": "App targets", + "properties": { + "apps": { + "items": { + "$ref": "#/components/schemas/CatalogApplication" + }, + "type": "array" + } + } + }, + "groups": { + "description": "Group targets", + "items": { + "$ref": "#/components/schemas/Group" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/LinksAssignee" + }, + "assignmentType": { + "$ref": "#/components/schemas/RoleAssignmentType" + }, + "created": { + "description": "Timestamp when the object was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Role assignment ID", + "readOnly": true, + "type": "string" + }, + "label": { + "description": "Label for the role assignment", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the object was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "Status of the role assignment" + } + ] + }, + "type": { + "$ref": "#/components/schemas/RoleType" + } + }, + "required": [ + "type" + ], + "title": "Standard role assignment", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "StandardRoleAssignmentSchema": { + "properties": { + "type": { + "description": "Specify a [standard admin role](/openapi/okta-management/guides/roles/#standard-roles), an [IAM-based standard role](/openapi/okta-management/guides/roles/#iam-based-standard-roles), or `CUSTOM` for a custom role type:", + "enum": [ + "ACCESS_CERTIFICATIONS_ADMIN", + "ACCESS_REQUESTS_ADMIN", + "API_ACCESS_MANAGEMENT_ADMIN", + "APP_ADMIN", + "GROUP_MEMBERSHIP_ADMIN", + "HELP_DESK_ADMIN", + "ORG_ADMIN", + "READ_ONLY_ADMIN", + "REPORT_ADMIN", + "SUPER_ADMIN", + "USER_ADMIN", + "WORKFLOWS_ADMIN" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "Standard role", + "type": "object" + }, + "StreamConfiguration": { + "properties": { + "aud": { + "description": "The audience used in the SET. This value is set as `aud` in the claim.\n\nA read-only parameter that is set by the transmitter. If this parameter is included in the request, the value must match the expected value from the transmitter.", + "example": "https://example.com", + "oneOf": [ + { + "example": "https://example.com", + "format": "uri", + "type": "string" + }, + { + "items": { + "example": "https://example.com", + "format": "uri", + "type": "string" + }, + "type": "array" + } + ] + }, + "delivery": { + "$ref": "#/components/schemas/StreamConfigurationDelivery" + }, + "events_delivered": { + "description": "The events (mapped by the array of event type URIs) that the transmitter actually delivers to the SSF stream.\n\nA read-only parameter that is set by the transmitter. If this parameter is included in the request, the value must match the expected value from the transmitter.", + "example": [ + "https://schemas.openid.net/secevent/caep/event-type/session-revoked", + "https://schemas.openid.net/secevent/caep/event-type/credential-change" + ], + "items": { + "format": "uri", + "type": "string" + }, + "type": "array" + }, + "events_requested": { + "description": "The events (mapped by the array of event type URIs) that the receiver wants to receive", + "example": [ + "https://schemas.openid.net/secevent/caep/event-type/session-revoked", + "https://schemas.openid.net/secevent/caep/event-type/credential-change" + ], + "items": { + "format": "uri", + "maxLength": 256, + "type": "string" + }, + "maxItems": 50, + "type": "array" + }, + "events_supported": { + "description": "An array of event type URIs that the transmitter supports.\n\nA read-only parameter that is set by the transmitter. If this parameter is included in the request, the value must match the expected value from the transmitter.", + "example": [ + "https://schemas.openid.net/secevent/caep/event-type/session-revoked", + "https://schemas.openid.net/secevent/caep/event-type/credential-change" + ], + "items": { + "format": "uri", + "type": "string" + }, + "type": "array" + }, + "format": { + "description": "The subject identifier format expected for any SET transmitted.", + "enum": [ + "iss_sub" + ], + "type": "string" + }, + "iss": { + "description": "The issuer used in security event tokens (SETs). This value is set as `iss` in the claim.\n\nA read-only parameter that is set by the transmitter. If this parameter is included in the request, the value must match the expected value from the transmitter.", + "example": "https://{yourOktaDomain}", + "type": "string" + }, + "min_verification_interval": { + "description": "The minimum amount of time, in seconds, between two verification requests.\n\nA read-only parameter that is set by the transmitter. If this parameter is included in the request, the value must match the expected value from the transmitter.", + "example": 60, + "nullable": true, + "type": "integer" + }, + "stream_id": { + "description": "The ID of the SSF stream configuration", + "example": "esc1k235GIIztAuGK0g5", + "type": "string" + } + }, + "required": [ + "events_requested", + "delivery" + ], + "title": "Stream configuration", + "type": "object" + }, + "StreamConfigurationCreateRequest": { + "properties": { + "delivery": { + "$ref": "#/components/schemas/StreamConfigurationDelivery" + }, + "events_requested": { + "description": "The events (mapped by the array of event type URIs) that the receiver wants to receive", + "example": [ + "https://schemas.openid.net/secevent/caep/event-type/session-revoked", + "https://schemas.openid.net/secevent/caep/event-type/credential-change" + ], + "items": { + "format": "uri", + "maxLength": 256, + "type": "string" + }, + "maxItems": 50, + "type": "array" + }, + "format": { + "description": "The subject identifier format expected for any SET transmitted.", + "enum": [ + "iss_sub" + ], + "type": "string" + } + }, + "required": [ + "events_requested", + "delivery" + ], + "title": "Stream configuration create request", + "type": "object" + }, + "StreamConfigurationDelivery": { + "description": "Contains information about the intended SET delivery method by the receiver", + "properties": { + "authorization_header": { + "description": "The HTTP authorization header that's included for each HTTP POST request", + "example": "{authorizationHeaderValue}", + "maxLength": 8192, + "nullable": true, + "type": "string" + }, + "endpoint_url": { + "description": "The target endpoint URL where the transmitter delivers the SET using HTTP POST requests", + "example": "https://example.com/", + "format": "uri", + "maxLength": 2048, + "type": "string" + }, + "method": { + "description": "The delivery method that the transmitter uses for delivering a SET", + "enum": [ + "https://schemas.openid.net/secevent/risc/delivery-method/push", + "urn:ietf:rfc:8935" + ], + "type": "string" + } + }, + "required": [ + "method", + "endpoint_url" + ], + "title": "Stream configuration delivery", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "StreamStatus": { + "description": "Status corresponding to the `stream_id` of the SSF stream", + "properties": { + "status": { + "description": "The status of the SSF stream configuration", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-enumDescriptions": { + "disabled": "The transmitter MUST NOT transmit events over the stream and doesn't hold any events for later transmission.", + "enabled": "The transmitter MUST transmit events over the stream according to the stream\u2019s configured delivery method." + } + }, + "stream_id": { + "description": "The ID of the SSF stream configuration. This corresponds to the value in the query parameter of the request.", + "example": "esc1k235GIIztAuGK0g5", + "type": "string" + } + }, + "title": "Stream status", + "type": "object" + }, + "StreamVerificationRequest": { + "properties": { + "state": { + "description": "An arbitrary string that Okta as a transmitter must echo back to the event receiver in the verification event's payload", + "example": "VGhpcyBpcyBhbiBleGFtcGxlIHN0YXRlIHZhbHVlLgo=", + "type": "string" + }, + "stream_id": { + "description": "The ID of the SSF stream configuration", + "example": "esc1k235GIIztAuGK0g5", + "type": "string" + } + }, + "required": [ + "stream_id" + ], + "title": "Stream verification request", + "type": "object" + }, + "SubjectType": { + "enum": [ + "pairwise", + "public" + ], + "type": "string" + }, + "SubmissionAction": { + "properties": { + "id": { + "description": "Action identifier", + "example": "okta:action1", + "type": "string" + }, + "provider": { + "$ref": "#/components/schemas/WorkflowActionProvider" + } + }, + "required": [ + "id", + "provider" + ], + "type": "object" + }, + "SubmissionActions": { + "properties": { + "actions": { + "items": { + "$ref": "#/components/schemas/SubmissionAction" + }, + "type": "array" + } + }, + "type": "object" + }, + "SubmissionCapabilities": { + "properties": { + "capabilities": { + "items": { + "$ref": "#/components/schemas/SubmissionCapability" + }, + "type": "array" + } + }, + "required": [ + "capabilities" + ], + "type": "object" + }, + "SubmissionCapability": { + "description": "Simple capability structure for capabilities endpoints (PUT/GET /capabilities)", + "properties": { + "capability": { + "$ref": "#/components/schemas/Capability" + }, + "supportedProtocols": { + "items": { + "$ref": "#/components/schemas/Protocol" + }, + "type": "array" + } + }, + "required": [ + "capability", + "supportedProtocols" + ], + "type": "object" + }, + "SubmissionCapabilityEnhanced": { + "description": "Enhanced capability structure with embedded protocol configurations for submission GET endpoint", + "discriminator": { + "mapping": { + "API_SERVICE": "#/components/schemas/ApiServiceCapability", + "ENTITLEMENTS": "#/components/schemas/EntitlementsCapability", + "IDV": "#/components/schemas/IdvCapability", + "PROVISIONING": "#/components/schemas/ProvisioningCapability", + "SSO": "#/components/schemas/SsoCapability", + "UNIVERSAL_LOGOUT": "#/components/schemas/UniversalLogoutCapability" + }, + "propertyName": "capability" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/SsoCapability" + }, + { + "$ref": "#/components/schemas/UniversalLogoutCapability" + }, + { + "$ref": "#/components/schemas/ProvisioningCapability" + }, + { + "$ref": "#/components/schemas/EntitlementsCapability" + }, + { + "$ref": "#/components/schemas/ApiServiceCapability" + }, + { + "$ref": "#/components/schemas/IdvCapability" + } + ] + }, + "SubmissionRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/SubmissionResponse" + } + ], + "required": [ + "name", + "description", + "logo" + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "SubmissionResponse": { + "properties": { + "appContactDetails": { + "description": "List of contact details for the app integration", + "items": { + "properties": { + "contact": { + "description": "The contact value (email, phone, or URL)", + "example": "support@example.com", + "type": "string" + }, + "contactType": { + "description": "Type of contact\n* `CUSTOMER_SUPPORT` - Public support contact details visible on your OIN catalog page for end users needing assistance with your integration.\n* `ESCALATION_SUPPORT` - Private support contact used by Okta to reach your organization during emergencies or escalations post-publication of the app (not shared with customers).\n", + "enum": [ + "CUSTOMER_SUPPORT", + "ESCALATION_SUPPORT" + ], + "example": "CUSTOMER_SUPPORT", + "type": "string" + }, + "contactValueType": { + "description": "Format of the contact value", + "enum": [ + "URL", + "EMAIL", + "PHONE" + ], + "example": "EMAIL", + "type": "string" + } + }, + "required": [ + "contactType", + "contactValueType", + "contact" + ], + "type": "object" + }, + "type": "array" + }, + "authSettings": { + "$ref": "#/components/schemas/AuthSettings" + }, + "capabilities": { + "description": "List of capabilities supported by this integration with embedded protocol configurations", + "items": { + "$ref": "#/components/schemas/SubmissionCapabilityEnhanced" + }, + "type": "array" + }, + "caseLastUpdated": { + "description": "The most recent date and time when a Salesforce case associated with the OIN integration was updated", + "example": "2024-01-15T10:30:45.000Z", + "readOnly": true, + "type": "string" + }, + "config": { + "description": "List of org-level variables for the customer per-tenant configuration. For example, a `subdomain` variable can be used in the ACS URL: `https://${org.subdomain}.example.com/saml/login`", + "items": { + "properties": { + "label": { + "description": "Display name of the variable in the Admin Console", + "example": "Subdomain", + "type": "string" + }, + "name": { + "description": "Name of the variable", + "example": "subdomain", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "defaultLogo": { + "default": false, + "description": "Indicates whether the app submission uses a default logo or a custom-uploaded logo:\n* If `true`: Uses the default Okta-provided placeholder logo.\n* If `false`: Uses a custom logo type other than the default logo.\n", + "type": "boolean" + }, + "description": { + "description": "A general description of your application and the benefits provided to your customers", + "example": "Your one source for in-season strawberry deals. Okta's Strawberry Central integration allow users to securely access those sweet deals.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "globalTokenRevocation": { + "$ref": "#/components/schemas/GlobalTokenRevocation" + }, + "id": { + "description": "OIN integration ID", + "example": "acme_submissionapp_1", + "readOnly": true, + "type": "string" + }, + "isNonFunctionalOnlySubmission": { + "default": false, + "description": "Indicates whether the OIN integration submission update is limited to non-functional metadata fields, such as the app description, logo, or contact details.\n* If `true`: The submission modifies only non-functional metadata and does not change the functional configuration.\n* If `false`: The submission includes functional changes (such as SSO, provisioning, or capability updates) or is not classified as non-functional.\n", + "readOnly": true, + "type": "boolean" + }, + "lastPublished": { + "description": "Timestamp when the OIN Integration was last published", + "example": "2023-08-24T14:15:22.000Z", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the OIN integration instance was last updated", + "example": "2023-08-24T14:15:22.000Z", + "readOnly": true, + "type": "string" + }, + "lastUpdatedBy": { + "description": "ID of the user who made the last update", + "example": "00ub0oNGTSWTBKOLGLNR", + "readOnly": true, + "type": "string" + }, + "logo": { + "description": "URL to an uploaded application logo. This logo appears next to your app integration name in the OIN catalog. You must first [Upload an OIN Integration logo](/openapi/okta-management/management/tag/YourOinIntegrations/#tag/YourOinIntegrations/operation/uploadSubmissionLogo) to obtain the logo URL before you can specify this value.", + "example": "https://acme.okta.com/bc/image/fileStoreRecord?id=fs03xxd3KmkDBwJU80g4", + "format": "uri", + "type": "string" + }, + "name": { + "description": "The app integration name. This is the main title used for your integration in the OIN catalog.", + "example": "Strawberry Central", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "oinFeatures": { + "description": "Type of feature supported by the OIN integration", + "example": "OIDC", + "readOnly": true, + "type": "string" + }, + "provisioning": { + "$ref": "#/components/schemas/ProvisioningDetails" + }, + "sso": { + "$ref": "#/components/schemas/Sso" + }, + "status": { + "description": "Status of the OIN integration submission", + "example": "New", + "readOnly": true, + "type": "string" + }, + "useCases": { + "description": "List of use cases that describe the integration's purpose in the OIN catalog. For example, use cases can indicate the type of functionality the integration provides, such as single sign-on, user provisioning, or lifecycle management.", + "example": [ + "SSO", + "Provisioning" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SubmissionResponseWithApiResponse": { + "allOf": [ + { + "$ref": "#/components/schemas/SubmissionResponse" + } + ], + "properties": { + "apiService": { + "$ref": "#/components/schemas/ApiService" + }, + "idv": { + "$ref": "#/components/schemas/Idv" + } + }, + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "Subscription": { + "properties": { + "_links": { + "description": "Discoverable resources related to the subscription", + "properties": { + "self": { + "$ref": "#/components/schemas/HrefObject" + } + }, + "readOnly": true, + "type": "object" + }, + "channels": { + "description": "An array of sources send notifications to users.\n> **Note**: Currently, Okta only allows `email` channels.", + "items": { + "type": "string" + }, + "type": "array" + }, + "notificationType": { + "$ref": "#/components/schemas/NotificationType" + }, + "status": { + "$ref": "#/components/schemas/SubscriptionStatus" + } + }, + "type": "object" + }, + "SubscriptionStatus": { + "description": "The status of the subscription", + "enum": [ + "subscribed", + "unsubscribed" + ], + "type": "string" + }, + "SupportedMethods": { + "description": "The supported methods of an authenticator", + "properties": { + "settings": { + "properties": { + "algorithms": { + "description": "The encryption algorithm for this authenticator method", + "items": { + "$ref": "#/components/schemas/AuthenticatorMethodAlgorithm" + }, + "type": "array" + }, + "keyProtection": { + "$ref": "#/components/schemas/PushMethodKeyProtection" + }, + "transactionTypes": { + "description": "The transaction type for this authenticator method", + "items": { + "$ref": "#/components/schemas/AuthenticatorMethodTransactionType" + }, + "type": "array" + } + }, + "type": "object" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LifecycleStatus" + }, + { + "description": "The status of the authenticator method" + } + ] + }, + "type": { + "description": "The type of authenticator method", + "enum": [ + "push" + ], + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "SwaApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/SwaApplicationSettingsApplication" + } + }, + "type": "object" + } + ] + }, + "SwaApplicationSettingsApplication": { + "properties": { + "buttonField": { + "description": "CSS selector for the **Sign-In** button in the sign-in form (for SWA apps with the `template_swa` app name definition)", + "type": "string" + }, + "buttonSelector": { + "description": "CSS selector for the **Sign-In** button in the sign-in form (for three-field SWA apps with the `template_swa3field` app name definition)", + "type": "string" + }, + "extraFieldSelector": { + "description": "Enter the CSS selector for the extra field (for three-field SWA apps with the `template_swa3field` app name definition).", + "type": "string" + }, + "extraFieldValue": { + "description": "Enter the value for the extra field in the form (for three-field SWA apps with the `template_swa3field` app name definition).", + "type": "string" + }, + "loginUrlRegex": { + "description": "A regular expression that further restricts targetURL to the specified regular expression", + "type": "string" + }, + "passwordField": { + "description": "CSS selector for the **Password** field in the sign-in form (for SWA apps with the `template_swa` app name definition)", + "type": "string" + }, + "passwordSelector": { + "description": "CSS selector for the **Password** field in the sign-in form (for three-field SWA apps with the `template_swa3field` app name definition)", + "type": "string" + }, + "targetURL": { + "description": "The URL of the sign-in page for this app (for three-field SWA apps with the `template_swa3field` app name definition)", + "type": "string" + }, + "url": { + "description": "The URL of the sign-in page for this app (for SWA apps with the `template_swa` app name definition)", + "type": "string" + }, + "userNameSelector": { + "description": "CSS selector for the **Username** field in the sign-in form (for three-field SWA apps with the `template_swa3field` app name definition)", + "type": "string" + }, + "usernameField": { + "description": "CSS selector for the **Username** field in the sign-in form (for SWA apps with the `template_swa` app name definition)", + "type": "string" + } + }, + "required": [ + "buttonField", + "passwordField", + "usernameField", + "url" + ], + "type": "object" + }, + "TacAuthenticatorEnrollment": { + "properties": { + "_links": { + "$ref": "#/components/schemas/AuthenticatorEnrollmentLinks" + }, + "created": { + "description": "Timestamp when the authenticator enrollment was created", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "A unique identifier of the authenticator enrollment", + "type": "string" + }, + "key": { + "description": "A human-readable string that identifies the authenticator", + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the authenticator enrollment was last updated", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The authenticator display name", + "type": "string" + }, + "nickname": { + "description": "A user-friendly name for the authenticator enrollment", + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/AuthenticatorProfileTacResponsePost" + }, + "status": { + "description": "Status of the enrollment", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/AuthenticatorType" + } + }, + "type": "object" + }, + "TelephonyRequest": { + "properties": { + "data": { + "$ref": "#/components/schemas/TelephonyRequestData" + }, + "eventType": { + "description": "The type of inline hook. The telephony inline hook type is `com.okta.telephony.provider`.", + "type": "string" + }, + "requestType": { + "description": "The type of inline hook request. For example, `com.okta.user.telephony.pre-enrollment`.", + "type": "string" + }, + "source": { + "description": "The ID and URL of the telephony inline hook", + "type": "string" + } + }, + "type": "object" + }, + "TelephonyRequestData": { + "properties": { + "context": { + "properties": { + "request": { + "$ref": "#/components/schemas/InlineHookRequestObject" + } + }, + "type": "object" + }, + "messageProfile": { + "description": "Message profile specifies information about the telephony (sms/voice) message to be sent to the Okta user", + "properties": { + "deliveryChannel": { + "description": "The channel for OTP delivery - SMS or voice", + "type": "string" + }, + "locale": { + "description": "The locale associated with the Okta user", + "type": "string" + }, + "msgTemplate": { + "description": "Default or Okta org configured sms or voice message template", + "type": "string" + }, + "otpCode": { + "description": "The OTP code requested by the Okta user", + "type": "string" + }, + "otpExpires": { + "description": "The time when OTP expires", + "type": "string" + }, + "phoneNumber": { + "description": "The Okta's user's phone number", + "type": "string" + } + }, + "type": "object" + }, + "userProfile": { + "description": "User profile specifies information about the Okta user", + "properties": { + "firstName": { + "description": "The user's first name", + "type": "string" + }, + "lastName": { + "description": "The user's last name", + "type": "string" + }, + "login": { + "description": "The user's Okta login", + "type": "string" + }, + "userId": { + "description": "The user's Okta user ID", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "TelephonyRequestExecute": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/TelephonyRequest" + } + ], + "description": "Telephony inline hook request body" + }, + "TelephonyResponse": { + "description": "Telephony inline hook response", + "properties": { + "commands": { + "description": "The `commands` object specifies whether Okta accepts the end user's sign-in credentials as valid or not. For the telephony inline hook, you typically only return one `commands` object with one array element in it.", + "items": { + "properties": { + "type": { + "description": "The location where you specify the command. For the telephony inline hook, there's only one command, `com.okta.telephony.action`.", + "type": "string" + }, + "value": { + "description": "The status of the telephony operation along with optional additional information about the provider, transaction ID and any other transaction metadata.", + "items": { + "properties": { + "provider": { + "description": "Telephony provider for sms/voice", + "type": "string" + }, + "status": { + "description": "Status of telephony callout", + "enum": [ + "SUCCESSFUL", + "PENDING", + "FAILED" + ], + "type": "string", + "x-enumDescriptions": { + "FAILED": "External web service was unable to deliver the OTP to the Requester.", + "PENDING": "External web service wasn't able to confirm delivery of the OTP to the Requester.", + "SUCCESSFUL": "External web service was able to deliver the OTP to the Requester." + } + }, + "transactionId": { + "description": "Transaction ID for sms/voice", + "type": "string" + }, + "transactionMetadata": { + "description": "Any relevant metadata for the telephony transaction", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "TempPassword": { + "properties": { + "tempPassword": { + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TenantSettings": { + "properties": { + "appInstanceProperties": { + "items": { + "$ref": "#/components/schemas/AppInstanceProperty" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestInfo": { + "description": "Integration Testing Information", + "properties": { + "apiServiceTestConfiguration": { + "description": "Details required to test the API service integration", + "properties": { + "scopeExplanation": { + "description": "Justification for each OAuth 2.0 scope\u2014specifically write scopes\u2014required for the API service integration to function. This information helps the operations team understand the integration and test it effectively.", + "maxLength": 5000, + "type": "string" + } + }, + "type": "object" + }, + "escalationSupportContact": { + "description": "An email for Okta to contact your company about your integration. This email isn't shared with customers.", + "example": "strawberry.support@example.com", + "maxLength": 255, + "type": "string" + }, + "oidcTestConfiguration": { + "description": "OIDC test details", + "properties": { + "idp": { + "description": "Read only.<br>Indicates if your integration supports IdP-initiated sign-in flows. If [`sso.oidc.initiateLoginUri`](/openapi/okta-management/management/tag/YourOinIntegrations/#tag/YourOinIntegrations/operation/createSubmission!path=sso/oidc/initiateLoginUri&t=request) is specified, this property is set to `true`. If [`sso.oidc.initiateLoginUri`](/openapi/okta-management/management/tag/YourOinIntegrations/#tag/YourOinIntegrations/operation/createSubmission!path=sso/oidc/initiateLoginUri&t=request) isn't set for the integration submission, this property is set to `false`", + "readOnly": true, + "type": "boolean" + }, + "jit": { + "description": "Indicates if your integration supports Just-In-Time (JIT) provisioning", + "type": "boolean" + }, + "sp": { + "description": "Read only.<br>Indicates if your integration supports SP-initiated sign-in flows and is always set to `true` for OIDC SSO", + "readOnly": true, + "type": "boolean" + }, + "spInitiateUrl": { + "description": "URL for SP-initiated sign-in flows (required if `sp = true`)", + "example": "https://test.example.com/strawberry/oidc/sp-init", + "format": "uri", + "maxLength": 512, + "type": "string" + } + }, + "required": [ + "spInitiateUrl" + ], + "type": "object" + }, + "samlTestConfiguration": { + "description": "SAML test details", + "properties": { + "idp": { + "description": "Indicates if your integration supports IdP-initiated sign-in", + "type": "boolean" + }, + "jit": { + "description": "Indicates if your integration supports Just-In-Time (JIT) provisioning", + "type": "boolean" + }, + "sp": { + "description": "Indicates if your integration supports SP-initiated sign-in", + "type": "boolean" + }, + "spInitiateDescription": { + "description": "Instructions on how to sign in to your app using the SP-initiated flow (required if `sp = true`)", + "example": "Go to the app URL from a browser and enter your username", + "maxLength": 2048, + "type": "string" + }, + "spInitiateUrl": { + "description": "URL for SP-initiated sign-in flows (required if `sp = true`)", + "example": "https://test.example.com/strawberry/saml/sp-init", + "format": "uri", + "maxLength": 512, + "type": "string" + } + }, + "required": [ + "spInitiateUrl" + ], + "type": "object" + }, + "scimTestConfiguration": { + "description": "SCIM test details", + "properties": { + "crudTestResults": { + "description": "The Runscope URL to your Okta SCIM CRUD test results. See [Test your Okta SCIM integration](https://developer.okta.com/docs/guides/scim-provisioning-integration-test/main/).", + "example": "https://www.runscope.com/radar/radfebnsefbd/msdfsvx2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-cdgj455hw45u", + "format": "uri", + "maxLength": 512, + "type": "string" + }, + "entitlementsTestResults": { + "description": "The Runscope URL to your entitlements test results", + "example": "https://www.runscope.com/radar/fgdffghfghfg/m01nopq2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-r434565g5451", + "format": "uri", + "maxLength": 512, + "type": "string" + }, + "specTestResults": { + "description": "The Runscope URL to your SCIM server specification test results. See [Test your SCIM API](https://developer.okta.com/docs/guides/build-provisioning-integration/test-scim-api/).", + "example": "https://www.runscope.com/radar/abcdefghijkl/m01nopq2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-3m4n5o678901", + "format": "uri", + "maxLength": 512, + "type": "string" + } + }, + "required": [ + "specTestResults", + "crudTestResults" + ], + "type": "object" + }, + "testAccount": { + "description": "An account on a test instance of your app with admin privileges. A test admin account is required by Okta for integration testing. During OIN QA testing, an Okta analyst uses this admin account to configure your app for the various test case flows.", + "properties": { + "instructions": { + "description": "Additional instructions to test the app integration, including instructions for obtaining test accounts", + "example": "Go to your app URL from a browser and enter your credentials", + "maxLength": 2048, + "type": "string" + }, + "password": { + "description": "The password for your app admin account", + "example": "sUperP@ssw0rd", + "maxLength": 255, + "type": "string" + }, + "url": { + "description": "The sign-in URL to a test instance of your app", + "example": "https://example.com/strawberry/login", + "format": "uri", + "maxLength": 512, + "type": "string" + }, + "username": { + "description": "The username for your app admin account", + "example": "test@example.com", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "url", + "username", + "password" + ], + "type": "object" + } + }, + "type": "object" + }, + "ThemeResponse": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "backgroundImage": { + "readOnly": true, + "type": "string" + }, + "emailTemplateTouchPointVariant": { + "$ref": "#/components/schemas/EmailTemplateTouchPointVariant" + }, + "endUserDashboardTouchPointVariant": { + "$ref": "#/components/schemas/EndUserDashboardTouchPointVariant" + }, + "errorPageTouchPointVariant": { + "$ref": "#/components/schemas/ErrorPageTouchPointVariant" + }, + "favicon": { + "readOnly": true, + "type": "string" + }, + "id": { + "readOnly": true, + "type": "string" + }, + "loadingPageTouchPointVariant": { + "$ref": "#/components/schemas/LoadingPageTouchPointVariant" + }, + "logo": { + "readOnly": true, + "type": "string" + }, + "primaryColorContrastHex": { + "description": "Primary color contrast hex code", + "type": "string" + }, + "primaryColorHex": { + "description": "Primary color hex code", + "type": "string" + }, + "secondaryColorContrastHex": { + "description": "Secondary color contrast hex code", + "type": "string" + }, + "secondaryColorHex": { + "description": "Secondary color hex code", + "type": "string" + }, + "signInPageTouchPointVariant": { + "$ref": "#/components/schemas/SignInPageTouchPointVariant" + } + }, + "type": "object" + }, + "ThirdPartyAdminSetting": { + "description": "The third-party admin setting", + "properties": { + "thirdPartyAdmin": { + "description": "Indicates if the third-party admin functionality is enabled", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "ThreatInsightConfiguration": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "action": { + "description": "Specifies how Okta responds to authentication requests from suspicious IP addresses", + "enum": [ + "none", + "audit", + "block" + ], + "example": "none", + "type": "string", + "x-enumDescriptions": { + "audit": "Indicates that Okta logs suspicious requests to the System Log", + "block": "Indicates that Okta logs suspicious requests to the System Log and blocks the requests", + "none": "Indicates that ThreatInsight is disabled" + } + }, + "created": { + "description": "Timestamp when the ThreatInsight Configuration object was created", + "example": "2020-08-05T22:18:30.629Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "excludeZones": { + "description": "Accepts a list of [Network Zone](/openapi/okta-management/management/networkzone/) IDs.\nIPs in the excluded network zones aren't logged or blocked.\nThis ensures that traffic from known, trusted IPs isn't accidentally logged or blocked.", + "example": [], + "items": { + "type": "string" + }, + "type": "array" + }, + "lastUpdated": { + "description": "Timestamp when the ThreatInsight Configuration object was last updated", + "example": "2020-09-08T20:53:20.882Z", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "action" + ], + "type": "object" + }, + "TimeDuration": { + "description": "A time duration specified as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "pattern": "^P(?:$)(\\d+Y)?(\\d+M)?(\\d+W)?(\\d+D)?(T(?:\\d)(\\d+H)?(\\d+M)?(\\d+S)?)?$", + "type": "string" + }, + "TokenAuthorizationServerPolicyRuleAction": { + "properties": { + "accessTokenLifetimeMinutes": { + "description": "Lifetime of the access token in minutes. The minimum is five minutes. The maximum is one day.", + "type": "integer" + }, + "inlineHook": { + "$ref": "#/components/schemas/TokenAuthorizationServerPolicyRuleActionInlineHook" + }, + "refreshTokenLifetimeMinutes": { + "description": "Lifetime of the refresh token is the minimum access token lifetime.", + "type": "integer" + }, + "refreshTokenWindowMinutes": { + "description": "Timeframe when the refresh token is valid. The minimum is 10 minutes. The maximum is five years (2,628,000 minutes).", + "type": "integer" + } + }, + "type": "object" + }, + "TokenAuthorizationServerPolicyRuleActionInlineHook": { + "properties": { + "id": { + "readOnly": false, + "type": "string" + } + }, + "type": "object" + }, + "TokenDeliveryMode": { + "enum": [ + "poll" + ], + "type": "string" + }, + "TokenHookResponse": { + "description": "For the token inline hook, the `commands` and `error` objects that you can return in the JSON payload of your response are defined in the following sections.\n> **Note:** The size of your response payload must be less than 256 KB.", + "properties": { + "commands": { + "description": "You can use the `commands` object to provide commands to Okta. It's where you can tell Okta to add more claims to the token.\nThe `commands` object is an array, allowing you to send multiple commands. In each array element, there needs to be a `type` property and `value` property. The `type` property is where you specify which of the supported commands you want to execute, and `value` is where you supply an operand for that command.\nIn the case of the token hook type, the `value` property is itself a nested object in which you specify a particular operation, a path to act on, and a value.", + "items": { + "properties": { + "type": { + "description": "One of the supported commands:\n `com.okta.identity.patch`: Modify an ID token\n `com.okta.access.patch`: Modify an access token\n> **Note:** The `commands` array should only contain commands that can be applied to the requested tokens. For example, if only an ID token is requested, the `commands` array shouldn't contain commands of the type `com.okta.access.patch`.", + "type": "string" + }, + "value": { + "description": "The `value` object is where you specify the operation to perform. It's an array, which allows you to request more than one operation.", + "items": { + "properties": { + "op": { + "description": "The name of one of the supported ops: `add`: Add a claim. `replace`: Modify an existing claim and update the token lifetime. `remove`: Remove an existing claim.\n#### `op: add` notes\n\n<details>\n<summary>Add a claim</summary>\n\n Add a claim\n\n **Existing JSON**\n\n ```\n {\n \"employeeId\": \"00u12345678\"\n }\n ```\n\n **Operation**\n\n ```\n {\n \"commands\": [\n {\n \"type\": \"com.okta.assertion.patch\",\n \"value\": [\n {\n \"op\": \"add\",\n \"path\": \"/claims/extPatientId\",\n \"value\": \"1234\"\n }\n ]\n },\n {\n \"type\": \"com.okta.assertion.patch\",\n \"value\": [\n {\n \"op\": \"add\",\n \"path\": \"/claims/external_guid\",\n \"value\": \"F0384685-F87D-474B-848D-2058AC5655A7\"\n }\n ]\n }\n ]\n }\n ```\n\n **Updated JSON**\n\n ```\n {\n \"employeeId\": \"00u12345678\",\n \"extPatientId\": 1234,\n \"external_guid\": \"F0384685-F87D-474B-848D-2058AC5655A7\"\n }\n ```\n\n > **Note:** If you use the `add` operation and include an existing claim in your response with a different value, that value is replaced. Use the `replace` operation instead. If you attempt to remove a system-specific claim or use an invalid operation, the entire PATCH fails and errors are logged in the token hooks events. See `op: replace` notes.\n</details>\n\n<details>\n<summary>Add new members to existing JSON objects</summary>\n\n If you have a JSON object in a claim called `employee_profile`, and you want to add the `department_id` member to the claim, the existing JSON is updated by specifying the claim in the path, followed by the name of the object member.\n\n **Existing JSON**\n\n ```\n {\n \"employee_profile\": {\n \"employee_id\": \"1234\",\n \"name\": \"Anna\"\n }\n }\n ```\n\n **Operation**\n\n ```\n {\n \"commands\": [\n {\n \"type\": \"com.okta.identity.patch\",\n \"value\": [\n {\n \"op\": \"add\",\n \"path\": \"/claims/employee_profile/department_id\",\n \"value\": \"4947\"\n }\n ]\n }\n ]\n }\n ```\n\n **Updated JSON**\n\n ```\n {\n \"employee_profile\": {\n \"employee_id\": \"1234\",\n \"name\": \"Anna\",\n \"department_id\": \"4947\"\n }\n }\n ```\n\n > **Note:** If you attempt to add a member within a JSON object that doesn't exist or using an invalid operation, the entire PATCH fails and errors are logged in the token hooks events.\n</details>\n\n<details>\n<summary>Add new elements to existing arrays</summary>\n\n Append an element to an array by specifying the name of the array, followed by the index where you want to insert the element in the path. Alternatively, you can specify the array name followed by a hyphen (-) in the path to append an element at the end of the array. For example, you have an array that contains the user's preferred airports, and you want to add a new airport to the array. The existing target JSON object is updated by specifying the claim in the path, followed by the index of where to insert the claim.\n\n **Existing JSON**\n\n ```\n {\n \"preferred_airports\":[\n \"sjc\",\n \"sfo\",\n \"oak\"\n ]\n }\n ```\n\n **Operation**\n\n ```\n {\n \"commands\": [\n {\n \"type\": \"com.okta.identity.patch\",\n \"value\": [\n {\n \"op\": \"add\",\n \"path\": \"/claims/preferred_airports/3\",\n \"value\": \"lax\"\n }\n ]\n }\n ]\n }\n ```\n\n **Updated JSON**\n\n ```\n {\n \"preferred_airports\":[\n \"sjc\",\n \"sfo\",\n \"oak\",\n \"lax\"\n ]\n }\n ```\n\n > **Note:** If you attempt to add an element within an array that doesn't exist or specify an invalid index, the entire PATCH fails and errors are logged in the token hooks events.\n</details>\n\n#### `op: replace` notes\n\n<details>\n<summary>Modify an existing claim</summary>\n\n You can modify (`replace`) existing custom claims or OIDC standard profile claims, such as `birthdate` and `locale`. You can't, however, modify any system-specific claims, such as `iss` or `ver`. Also, you can't modify a claim that isn't currently part of the token in the request payload. Attempting to modify a system-specific claim or using an invalid operation results in the entire PATCH failing and errors logged in the token hooks events.\n\n See [Access Tokens Scopes and Claims](/openapi/okta-oauth/guides/overview/#access-token-scopes-and-claims) for the list of access token-reserved claims that you can't modify.\n\n > **Note:** Although the `aud` and `sub` claims are listed as reserved claims, you can modify those claims in access tokens. You can't modify these claims in ID tokens.\n\n See [ID Token Claims](/openapi/okta-oauth/guides/overview/#id-token-claims) for a list of ID token-reserved claims that you can't modify.\n\n **Existing target JSON object**\n\n ```\n {\n \"employeeId\": \"00u12345678\",\n \"extPatientId\": 1234,\n \"external_guid\": \"F0384685-F87D-474B-848D-2058AC5655A7\"\n }\n ```\n\n **Operation**\n\n ```\n {\n \"commands\": [\n {\n \"type\": \"com.okta.identity.patch\",\n \"value\": [\n {\n \"op\": \"replace\",\n \"path\": \"/claims/extPatientId\",\n \"value\": \"12345\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/claims/external_guid\",\n \"value\": \"D1495796-G98E-585C-959E-1269CD6766B8\"\n }\n ]\n }\n ]\n }\n ```\n\n **Updated JSON***\n\n ```\n {\n \"employeeId\": \"00u12345678\",\n \"extPatientId\": 12345,\n \"external_guid\": \"D1495796-G98E-585C-959E-1269CD6766B8\"\n }\n ```\n\n</details>\n\n<details>\n<summary>Modify members within existing JSON objects and arrays</summary>\n\n Use the `replace` operation to modify members within JSON objects and elements within arrays. For example, you have a JSON object in a claim called `employee_profile`, and you want to update the email address of the employee. The existing target JSON object is updated by specifying the claim in the path, followed by the name of the object member that you want to modify.\n\n **Existing target JSON object**\n\n ```\n {\n \"employee_profile\": {\n \"employee_id\":\"1234\",\n \"name\":\"Anna\",\n \"email\":\"anna.v@company.com\"\n }\n }\n ```\n\n **Operation**\n\n ```\n {\n \"commands\": [\n {\n \"type\": \"com.okta.identity.patch\",\n \"value\": [\n {\n \"op\": \"replace\",\n \"path\": \"/claims/employee_profile/email\",\n \"value\": \"anna@company.com\"\n }\n ]\n }\n ]\n }\n ```\n\n **Updated JSON**\n\n ```\n {\n \"employee_profile\": {\n \"employee_id\":\"1234\",\n \"name\":\"Anna\",\n \"email\":\"anna@company.com\"\n }\n }\n ```\n\n > **Note:** If you attempt to modify a member within a JSON object that doesn't exist or use an invalid operation, the entire PATCH fails and errors are logged in the token hooks events.\n\n Similarly, you can replace elements in an array by specifying the array name and the valid index of the element that you want to replace in the path.\n</details>\n\n<details>\n<summary>Modify token lifetimes</summary>\n You can modify how long the access and ID tokens are valid by specifying the `lifetime` in seconds. The `lifetime` value must be a minimum of five minutes (300 seconds) and a maximum of 24 hours (86,400 seconds).\n\n **Operation**\n\n ```\n {\n \"commands\": [\n {\n \"type\": \"com.okta.identity.patch\",\n \"value\": [\n {\n \"op\": \"replace\",\n \"path\": \"/token/lifetime/expiration\",\n \"value\": 36000\n }\n ]\n },\n {\n \"type\": \"com.okta.access.patch\",\n \"value\": [\n {\n \"op\": \"replace\",\n \"path\": \"/token/lifetime/expiration\",\n \"value\": 36000\n }\n ]\n }\n ]\n }\n ```\n\n</details>\n\n#### `op: remove` notes\n\n<details>\n<summary>Remove a claim</summary>\n\n You can remove existing custom claims or OIDC standard profile claims, such as `birthdate` or `locale`. You can't, however, remove any system-specific claims, such as `iss` or `ver`. You also can't remove a claim that isn't currently part of the token in the request payload. If you attempt to remove a system-specific claim or use an invalid operation, the entire PATCH fails and errors are logged in the token hooks events.\n\n See [Access Tokens Scopes and Claims](/openapi/okta-oauth/guides/overview/#access-token-scopes-and-claims) for the list of access token-reserved claims that you can't modify.\n\n See [ID Token Claims](/openapi/okta-oauth/guides/overview/#id-token-claims) for a list of ID token-reserved claims that you can't modify.\n\n **Operation**\n\n ```\n {\n \"commands\": [\n {\n \"type\": \"com.okta.identity.patch\",\n \"value\": [\n {\n \"op\": \"remove\",\n \"path\": \"/claims/birthdate\",\n \"value\": null\n }\n ]\n },\n {\n \"type\": \"com.okta.access.patch\",\n \"value\": [\n {\n \"op\": \"remove\",\n \"path\": \"/claims/external_guid\"\n }\n ]\n }\n ]\n }\n ```\n\n > **Note:** The `value` property for the `remove` operation isn't required. If you provide it in the response, it should be set to `null`. Providing any other value fails the entire PATCH response.\n\n</details>\n\n<details>\n<summary>Remove members from existing arrays</summary>\n\n Use the `remove` operation to remove members from existing arrays. For example, you have an array that contains the user's preferred airports, and you want to remove an airport from the array. The existing target JSON object is updated by specifying the array name followed by the index of the element that you want to remove. You don't need to specify a value for the remove operation, but you can specify `null` as the value if you want.\n\n **Existing target JSON object**\n\n ```\n {\n \"preferred_airports\": [\n \"sjc\",\n \"lax\",\n \"sfo\",\n \"oak\"\n ]\n }\n ```\n\n **Operation**\n\n ```\n {\n \"commands\": [\n {\n \"type\": \"com.okta.identity.patch\",\n \"value\": [\n {\n \"op\": \"remove\",\n \"path\": \"/claims/preferred_airports/1\"\n }\n ]\n }\n ]\n }\n ```\n\n **Updated JSON**\n\n ```\n {\n \"preferred_airports\": [\n \"sjc\",\n \"sfo\",\n \"oak\"\n ]\n }\n ```\n\n</details>\n\n<details>\n<summary>Remove members from existing JSON objects</summary>\n\n Use the `remove` operation to remove members from existing JSON objects. Do this by specifying the JSON object in the path, followed by the claim member that you would like to remove. For example, you have an `employee_profile` claim, and you want to remove `email` from it.\n\n**Existing target JSON object**\n\n```\n{\n \"employee_profile\": {\n \"employee_id\":\"1234\",\n \"name\":\"Anna\",\n \"email\":\"anna.v@company.com\"\n }\n}\n```\n\n**Operation**\n\n```\n{\n \"commands\": [\n {\n \"type\": \"com.okta.identity.patch\",\n \"value\": [\n {\n \"op\": \"remove\",\n \"path\": \"/claims/employee_profile/email\"\n }\n ]\n }\n ]\n}\n```\n\n**Updated JSON**\n```\n{\n \"employee_profile\": {\n \"employee_id\":\"1234\",\n \"name\":\"Anna\",\n }\n}\n```\n\n</details>", + "type": "string" + }, + "path": { + "description": "Location within the token to apply the operation, specified as a slash-delimited path. When you add, replace, or remove a claim, this path always begins with `/claims/` and is followed by the name of the new claim that you're adding. When you replace a token lifetime, the path should always be `/token/lifetime/expiration`.", + "type": "string" + }, + "value": { + "description": "Value to set the claim to.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "object" + } + ] + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "error": { + "description": "When an error object is returned, it causes Okta to return an OAuth 2.0 error to the requester of the token. In the error response, the value of `error` is `server_error`, and the value of `error_description` is the string that you supplied in the `errorSummary` property of the `error` object that you returned.", + "properties": { + "errorSummary": { + "description": "Human-readable summary of the error. If the error object doesn't include the `errorSummary` property defined, the following common default message is returned to the end user: `The callback service returned an error`.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "TokenPayLoad": { + "properties": { + "data": { + "properties": { + "access": { + "allOf": [ + { + "description": "Provides information on the properties of the access token that Okta has generated, including the existing claims that it contains" + }, + { + "$ref": "#/components/schemas/BaseToken" + }, + { + "properties": { + "scopes": { + "description": "The scopes contained in the token. For descriptions of the scopes that you can include, see the Okta [OpenID Connect and OAuth 2.0 API reference](/openapi/okta-oauth/guides/overview/#scopes).", + "type": "object" + } + }, + "type": "object" + } + ] + }, + "context": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseContext" + }, + { + "properties": { + "policy": { + "description": "The authorization server policy used to mint the token", + "properties": { + "id": { + "description": "The unique identifier for the policy", + "example": "00p4ktaq2ryOYtsHC0g7", + "type": "string" + }, + "rule": { + "description": "The authorization server policy rule used to mint the token", + "properties": { + "id": { + "description": "The unique identifier for the policy rule", + "example": "0pr4ktb7elD3ZvrMy0g7", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "protocol": { + "description": "Details of the authentication protocol", + "properties": { + "OriginalGrant": { + "description": "Information about the original token request used to get the refresh token being used, when in a refresh token request", + "properties": { + "authorization": { + "$ref": "#/components/schemas/TokenProtocolRequest" + }, + "refresh_token": { + "$ref": "#/components/schemas/RefreshToken" + } + }, + "type": "object" + }, + "client": { + "description": "The client making the token request", + "properties": { + "id": { + "description": "The unique identifier of the client", + "type": "string" + }, + "name": { + "description": "The name of the client", + "type": "string" + }, + "type": { + "description": "The type of client", + "example": "PUBLIC", + "type": "string" + } + }, + "type": "object" + }, + "issuer": { + "description": "The authorization server's issuer identifier", + "properties": { + "uri": { + "description": "The authorization server's issuer identifier", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "request": { + "$ref": "#/components/schemas/TokenProtocolRequest" + }, + "type": { + "description": "The type of authentication protocol used", + "example": "OAUTH2.0", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "identity": { + "allOf": [ + { + "description": "Provides information on the properties of the ID token that Okta has generated, including the existing claims that it contains" + }, + { + "$ref": "#/components/schemas/BaseToken" + } + ] + }, + "refresh_token": { + "$ref": "#/components/schemas/RefreshToken" + } + }, + "type": "object" + }, + "eventType": { + "description": "The type of inline hook. The token inline hook type is `com.okta.oauth2.tokens.transform`.", + "type": "string" + }, + "source": { + "description": "The URL of the token inline hook", + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "TokenProtocolRequest": { + "description": "Details of the token request", + "properties": { + "client_id": { + "description": "The ID of the client associated with the token", + "type": "string" + }, + "grant_type": { + "$ref": "#/components/schemas/GrantType" + }, + "redirect_uri": { + "description": "Specifies the callback location where the authorization was sent", + "format": "uri", + "type": "string" + }, + "response_mode": { + "description": "The authorization response mode", + "enum": [ + "form_post", + "fragment", + "okta_post_message", + "query" + ], + "type": "string" + }, + "response_type": { + "description": "The authorization response type", + "enum": [ + "code", + "id_token", + "token", + "none" + ], + "type": "string" + }, + "scope": { + "description": "The scopes requested", + "type": "string" + }, + "state": { + "type": "string" + } + }, + "type": "object" + }, + "TokenRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/TokenPayLoad" + } + ], + "description": "Token inline hook request" + }, + "TokenResourcesHrefObject": { + "properties": { + "href": { + "description": "Link URI", + "example": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7/clients/0oabskvc6442nkvQO0h7/tokens", + "type": "string" + } + }, + "type": "object" + }, + "TokenResponse": { + "properties": { + "access_token": { + "description": "An access token.", + "type": "string" + }, + "device_secret": { + "description": "An opaque device secret. This is returned if the `device_sso` scope is granted.", + "type": "string" + }, + "expires_in": { + "description": "The expiration time of the access token in seconds.", + "type": "integer" + }, + "id_token": { + "description": "An ID token. This is returned if the `openid` scope is granted.", + "type": "string" + }, + "issued_token_type": { + "$ref": "#/components/schemas/TokenType" + }, + "refresh_token": { + "description": "An opaque refresh token. This is returned if the `offline_access` scope is granted.", + "type": "string" + }, + "scope": { + "description": "The scopes contained in the access token.", + "type": "string" + }, + "token_type": { + "$ref": "#/components/schemas/TokenResponseTokenType" + } + }, + "type": "object" + }, + "TokenResponseTokenType": { + "description": "The token type in a `/token` response. The value is generally `Bearer` except for a few instances of token exchange.", + "enum": [ + "Bearer", + "N_A" + ], + "type": "string" + }, + "TokenType": { + "description": "The type of token for token exchange. `urn:okta:params:oauth:token-type:interclient_token` is EA.", + "enum": [ + "urn:ietf:params:oauth:token-type:access_token", + "urn:ietf:params:oauth:token-type:id_token", + "urn:ietf:params:oauth:token-type:jwt", + "urn:ietf:params:oauth:token-type:refresh_token", + "urn:ietf:params:oauth:token-type:saml1", + "urn:ietf:params:oauth:token-type:saml2", + "urn:okta:oauth:token-type:web_sso_token", + "urn:okta:params:oauth:token-type:interclient_token", + "urn:x-oath:params:oauth:token-type:device-secret" + ], + "type": "string" + }, + "TrendMicroApexOneServiceApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/OINApplication" + }, + { + "type": "object" + }, + { + "properties": { + "name": { + "enum": [ + "trendmicroapexoneservice" + ], + "example": "trendmicroapexoneservice", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/TrendMicroApexOneServiceApplicationSettings" + }, + "signOnMode": { + "enum": [ + "SAML_2_0" + ], + "type": "string" + } + }, + "required": [ + "name", + "label", + "settings" + ] + } + ], + "description": "Schema for Trend Micro Apex One as a Service app (key name: `trendmicroapexoneservice`)\n\nTo create a Trend Micro Apex One as a Service app, use the [Create an Application](/openapi/okta-management/management/tags/application/other/createapplication) request with the following parameters in the request body.\n> **Note:** The Trend Micro Apex One as a Service app only supports `SAML_2_0` sign-on mode.\n", + "example": { + "label": "Sample Trend Micro Apex One as a Service App", + "name": "trendmicroapexoneservice", + "settings": { + "app": { + "baseURL": "https://acme.trendmicro.com" + } + }, + "signOnMode": "SAML_2_0" + }, + "title": "Trend Micro Apex One Service", + "x-okta-defined-as": { + "name": "trendmicroapexoneservice" + }, + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-tags": [ + "Application" + ] + }, + "TrendMicroApexOneServiceApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "type": "object" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/TrendMicroApexOneServiceApplicationSettingsApplication" + }, + "signOn": { + "$ref": "#/components/schemas/OINSaml20ApplicationSettingsSignOn" + } + }, + "required": [ + "app" + ] + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "TrendMicroApexOneServiceApplicationSettingsApplication": { + "description": "Trend Micro Apex One as a Service app instance properties", + "properties": { + "baseURL": { + "description": "Base Trend Micro Apex One Service URL", + "type": "string" + } + }, + "required": [ + "baseURL" + ], + "type": "object" + }, + "TrustedOrigin": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelfAndLifecycle" + }, + "created": { + "description": "Timestamp when the trusted origin was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "The ID of the user who created the trusted origin", + "type": "string" + }, + "id": { + "description": "Unique identifier for the trusted origin", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the trusted origin was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastUpdatedBy": { + "description": "The ID of the user who last updated the trusted origin", + "type": "string" + }, + "name": { + "$ref": "#/components/schemas/TrustedOriginName" + }, + "origin": { + "$ref": "#/components/schemas/TrustedOriginOrigin" + }, + "scopes": { + "$ref": "#/components/schemas/TrustedOriginScopes" + }, + "status": { + "$ref": "#/components/schemas/LifecycleStatus" + } + }, + "type": "object" + }, + "TrustedOriginName": { + "description": "Unique name for the trusted origin", + "maximum": 255, + "type": "string" + }, + "TrustedOriginOrigin": { + "description": "Unique origin URL for the trusted origin. The supported schemes for this attribute are HTTP, HTTPS, FTP, Ionic 2, and Capacitor.", + "maximum": 255, + "type": "string" + }, + "TrustedOriginScope": { + "properties": { + "allowedOktaApps": { + "description": "The allowed Okta apps for the trusted origin scope", + "items": { + "$ref": "#/components/schemas/IframeEmbedScopeAllowedApps" + }, + "type": "array" + }, + "type": { + "$ref": "#/components/schemas/TrustedOriginScopeType" + } + }, + "type": "object" + }, + "TrustedOriginScopeType": { + "description": "The scope type. Supported values: When you use `IFRAME_EMBED` as the scope type, leave the `allowedOktaApps` property empty to allow iFrame embedding of only Okta sign-in pages. Include `OKTA_ENDUSER` as a value for the `allowedOktaApps` property to allow iFrame embedding of both Okta sign-in pages and the Okta End-User Dashboard.\n", + "enum": [ + "CORS", + "IFRAME_EMBED", + "REDIRECT" + ], + "type": "string" + }, + "TrustedOriginScopes": { + "description": "Array of scope types that this trusted origin is used for", + "items": { + "$ref": "#/components/schemas/TrustedOriginScope" + }, + "maximum": 3, + "type": "array" + }, + "TrustedOriginWrite": { + "properties": { + "name": { + "$ref": "#/components/schemas/TrustedOriginName" + }, + "origin": { + "$ref": "#/components/schemas/TrustedOriginOrigin" + }, + "scopes": { + "$ref": "#/components/schemas/TrustedOriginScopes" + } + }, + "type": "object" + }, + "UIElement": { + "description": "Specifies the configuration of an input field on an enrollment form", + "properties": { + "label": { + "description": "Label name for the UI element", + "type": "string" + }, + "options": { + "description": "UI Schema element options object", + "properties": { + "format": { + "description": "Specifies how the input appears", + "enum": [ + "text", + "radio", + "select", + "checkbox", + "radio_yes_no", + "radio_true_false" + ], + "type": "string", + "x-enumDescriptions": { + "checkbox": "Displays input as a checkbox. This option is only available for Boolean data types.", + "radio": "Radio button options. This option is only available for `string` data types with an `enum` or `one of` constraint.", + "radio_true_false": "Displays input as two radio buttons, one with the option `true` and the other `false`. This option is only available for Boolean data types.", + "radio_yes_no": "Displays input as two radio buttons, one with the option `yes` and the other `no`. This option is only available for Boolean data types.", + "select": "Displays input as a dropdown list. This option is only available for the `country-code` data type or a string data type with an enum or one of constraint.", + "text": "The default format for the majority of property types" + } + } + }, + "type": "object" + }, + "scope": { + "description": "Specifies the property bound to the input field. It must follow the format `#/properties/PROPERTY_NAME` where `PROPERTY_NAME` is a variable name for an attribute in `profile editor`.", + "type": "string" + }, + "type": { + "description": "Specifies the relationship between this input element and `scope`. The `Control` value specifies that this input controls the value represented by `scope`.", + "type": "string" + } + }, + "type": "object" + }, + "UISchemaObject": { + "description": "Properties of the UI schema", + "properties": { + "buttonLabel": { + "default": "Submit", + "description": "Specifies the button label for the `Submit` button at the bottom of the enrollment form", + "type": "string" + }, + "elements": { + "items": { + "$ref": "#/components/schemas/UIElement" + }, + "type": "array" + }, + "label": { + "default": "Sign in", + "description": "Specifies the label at the top of the enrollment form under the logo", + "type": "string" + }, + "type": { + "description": "Specifies the type of layout", + "type": "string" + } + }, + "type": "object" + }, + "UISchemasResponseObject": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "created": { + "description": "Timestamp when the UI Schema was created (ISO 86001)", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the UI Schema", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the UI Schema was last modified (ISO 86001)", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "uiSchema": { + "$ref": "#/components/schemas/UISchemaObject" + } + }, + "required": [ + "id", + "uiSchema", + "created", + "lastUpdated", + "_links" + ], + "type": "object" + }, + "UnconfirmedUserResponseSchema": { + "properties": { + "users": { + "items": { + "properties": { + "credentials": { + "$ref": "#/components/schemas/AppUserCredentials" + }, + "externalId": { + "description": "The ID of the user in the target app that's linked to the Okta application user object.\nThis value is the native app-specific identifier or primary key for the user in the target app.\n\nThe `externalId` is set during import when the user is confirmed (reconciled) or during provisioning when the user is created in the target app.\nThis value isn't populated for SSO app assignments (for example, SAML or SWA) because it isn't synchronized with a target app.", + "example": "70c14cc17d3745e8a9f98d599a68329c", + "readOnly": true, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/AppUserProfile" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "users" + ], + "type": "object" + }, + "UniversalLogoutCapability": { + "description": "Universal Logout capability configuration with embedded protocol details.\n\n**Protocol validation rule:**\n- The `actions` parameter is required when `supportedProtocols` is set to `ACTIONS`.\n", + "properties": { + "actions": { + "description": "Configuration for the Actions protocol. This parameter is required when `supportedProtocols` is set to `ACTIONS`.", + "items": { + "$ref": "#/components/schemas/SubmissionAction" + }, + "type": "array" + }, + "capability": { + "description": "Universal Logout capability identifier", + "enum": [ + "UNIVERSAL_LOGOUT" + ], + "type": "string" + }, + "supportedProtocols": { + "description": "List of supported logout protocols", + "items": { + "enum": [ + "GTR", + "ACTIONS" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "capability", + "supportedProtocols" + ], + "type": "object" + }, + "UpdateDomain": { + "properties": { + "brandId": { + "description": "The `id` of the brand used to replace the existing brand.", + "example": "bndul904tTZ6kWVhP0g3", + "type": "string" + } + }, + "required": [ + "brandId" + ], + "type": "object" + }, + "UpdateEmailDomain": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseEmailDomain" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UpdateGroupPushMappingRequest": { + "properties": { + "status": { + "$ref": "#/components/schemas/GroupPushMappingStatusUpsert", + "description": "The status of the group push mapping.\n\nIf changing the group push mapping status to `ACTIVE`, Okta performs an initial push to the target group, and then begins pushing membership changes. \n\nIf changing the group push mapping status to `INACTIVE`, Okta stops pushing membership changes to the target group.", + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" + }, + "UpdateIamRoleRequest": { + "properties": { + "description": { + "description": "Description of the role", + "type": "string" + }, + "label": { + "description": "Unique label for the role", + "type": "string" + } + }, + "required": [ + "label", + "description" + ], + "type": "object" + }, + "UpdateRealmAssignmentRequest": { + "properties": { + "actions": { + "$ref": "#/components/schemas/Actions" + }, + "conditions": { + "$ref": "#/components/schemas/Conditions" + }, + "name": { + "type": "string" + }, + "priority": { + "description": "The priority of the realm assignment. The lower the number, the higher the priority. This helps resolve conflicts between realm assignments.\n> **Note:** When you create realm assignments in bulk, realm assignment priorities must be unique.", + "type": "integer" + } + }, + "type": "object" + }, + "UpdateRealmRequest": { + "properties": { + "profile": { + "$ref": "#/components/schemas/RealmProfile" + } + }, + "type": "object" + }, + "UpdateThemeRequest": { + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "emailTemplateTouchPointVariant": { + "$ref": "#/components/schemas/EmailTemplateTouchPointVariant" + }, + "endUserDashboardTouchPointVariant": { + "$ref": "#/components/schemas/EndUserDashboardTouchPointVariant" + }, + "errorPageTouchPointVariant": { + "$ref": "#/components/schemas/ErrorPageTouchPointVariant" + }, + "loadingPageTouchPointVariant": { + "$ref": "#/components/schemas/LoadingPageTouchPointVariant" + }, + "primaryColorContrastHex": { + "default": null, + "description": "Primary color contrast hex code", + "type": "string" + }, + "primaryColorHex": { + "default": null, + "description": "Primary color hex code", + "type": "string" + }, + "secondaryColorContrastHex": { + "default": null, + "description": "Secondary color contrast hex code", + "type": "string" + }, + "secondaryColorHex": { + "default": null, + "description": "Secondary color hex code", + "type": "string" + }, + "signInPageTouchPointVariant": { + "$ref": "#/components/schemas/SignInPageTouchPointVariant" + } + }, + "required": [ + "primaryColorHex", + "secondaryColorHex", + "signInPageTouchPointVariant", + "endUserDashboardTouchPointVariant", + "errorPageTouchPointVariant", + "emailTemplateTouchPointVariant" + ], + "type": "object" + }, + "UpdateUISchema": { + "description": "The updated request body properties", + "properties": { + "uiSchema": { + "$ref": "#/components/schemas/UISchemaObject" + } + }, + "type": "object" + }, + "UpdateUserRequest": { + "properties": { + "credentials": { + "$ref": "#/components/schemas/UserCredentials" + }, + "profile": { + "$ref": "#/components/schemas/UserProfile" + }, + "realmId": { + "description": "The ID of the realm in which the user is residing. See [Realms](/openapi/okta-management/management/tags/realm).", + "example": "guo1bfiNtSnZYILxO0g4", + "type": "string" + }, + "type": { + "description": "The ID of the user type. Add this value if you want to create a user with a non-default [User Type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/).\nThe user type determines which [schema](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/) applies to that user. After a user has been created, the user can\nonly be assigned a different user type by an admin through a full replacement (`PUT`) operation.", + "properties": { + "id": { + "description": "The ID of the user type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "User": { + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "Embedded resources related to the user using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "readOnly": true, + "type": "object" + }, + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "activate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to activate the user" + }, + "changePassword": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to change the user's password" + }, + "changeRecoveryQuestion": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to change the user's recovery question" + }, + "deactivate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to deactivate a user" + }, + "expirePassword": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to expire the user's password" + }, + "forgotPassword": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to initiate a forgot password operation" + }, + "reactivate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to reactivate the user" + }, + "resetFactors": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to reset the user's factors" + }, + "resetPassword": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to reset the user's password" + }, + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to the user's profile schema" + }, + "self": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to the individual user" + }, + "suspend": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to suspend the user" + }, + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to the user type" + }, + "unlock": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to unlock the locked-out user" + }, + "unsuspend": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + } + ], + "description": "URL to unsuspend the user" + } + }, + "type": "object" + }, + { + "readOnly": true + } + ], + "description": "Specifies link relations (see [Web Linking](https://datatracker.ietf.org/doc/html/rfc8288) available for the current status of a user.\nThe links object is used for dynamic discovery of related resources, lifecycle operations, and credential operations. The links object is read-only.\n\nFor an individual user result, the links object contains a full set of link relations available for that user as determined by your policies.\nFor a collection of users, the links object contains only the `self` link. Operations that return a collection of users include [List all users](https://developer.okta.com/docs/api/openapi/okta-management/management/user/listusers) and [List all group member users](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/listGroupUsers)." + }, + "activated": { + "description": "The timestamp when the user status transitioned to `ACTIVE`", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "created": { + "description": "The timestamp when the user was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "credentials": { + "$ref": "#/components/schemas/UserCredentials" + }, + "id": { + "description": "The unique key for the user", + "readOnly": true, + "type": "string" + }, + "lastLogin": { + "description": "The timestamp of the last login", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "The timestamp when the user was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "passwordChanged": { + "description": "The timestamp when the user's password was last updated", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/UserProfile" + }, + "realmId": { + "description": "The ID of the realm in which the user is residing. See [Realms](/openapi/okta-management/management/tags/realm).", + "example": "guo1bfiNtSnZYILxO0g4", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/UserStatus" + }, + "statusChanged": { + "description": "The timestamp when the status of the user last changed", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "transitioningToStatus": { + "description": "The target status of an in-progress asynchronous status transition. This property is only returned if the user's state is transitioning.", + "enum": [ + "ACTIVE", + "DEPROVISIONED", + "PROVISIONED" + ], + "nullable": true, + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The user type that determines the schema for the user's profile. The `type` property is a map that identifies the [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/#tag/UserType).\n\nCurrently it contains a single element, `id`. It can be specified when creating a new user, and can be updated by an admin on a full replace of an existing user (but not a partial update).", + "properties": { + "id": { + "description": "The ID of the user type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserActivationToken": { + "properties": { + "activationToken": { + "description": "Token received as part of an activation user request. If a password was set before the user was activated, then user must sign in with their password or the `activationToken` and not the activation link. More information about using the `activationToken`\nto login can be found in the [Authentication API](https://developer.okta.com/docs/reference/api/authn/#primary-authentication-with-activation-token).", + "example": "XE6wE17zmphl3KqAPFxO", + "readOnly": true, + "type": "string" + }, + "activationUrl": { + "description": "If `sendEmail` is `false`, returns an activation link for the user to set up their account. You can use the activation token to create a custom activation link.\n\n> **Note:** The `activationUrl` varies depending on if you are on a Classic or Identity Engine org.\n> - For Identity Engine orgs, the activation link is in this format: `https://{yourOktaDomain}/tokens/{activationToken}/verify`\n> - For Classic orgs, the activation link is in this format: `https://{yourOktaDomain}/welcome/{activationToken}`", + "example": "https://{yourOktaDomain}/tokens/XE6wE17zmphl3KqAPFxO/verify", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UserBlock": { + "description": "Describes how the account is blocked from access. If `appliesTo` is `ANY_DEVICES`, then the account is blocked for all devices. If `appliesTo` is `UNKNOWN_DEVICES`, then the account is only blocked for unknown devices.", + "properties": { + "appliesTo": { + "description": "The devices that the block applies to", + "enum": [ + "ANY_DEVICES", + "UNKNOWN_DEVICES" + ], + "readOnly": true, + "type": "string", + "x-enumDescriptions": { + "ANY_DEVICES": "The account is blocked for all devices", + "UNKNOWN_DEVICES": "The account is only blocked for unknown devices" + } + }, + "type": { + "description": "Type of access block", + "enum": [ + "DEVICE_BASED" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UserClassification": { + "properties": { + "lastUpdated": { + "description": "The timestamp when the user classification was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ClassificationType" + } + }, + "type": "object" + }, + "UserCondition": { + "description": "Specifies a set of users to be included or excluded", + "properties": { + "exclude": { + "description": "Users to be excluded", + "items": { + "type": "string" + }, + "type": "array" + }, + "include": { + "description": "Users to be included", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "UserCredentials": { + "description": "Specifies primary authentication and recovery credentials for a user. Credential types and requirements vary depending on the provider and security policy of the org.", + "properties": { + "password": { + "$ref": "#/components/schemas/PasswordCredential" + }, + "provider": { + "$ref": "#/components/schemas/AuthenticationProvider" + }, + "recovery_question": { + "$ref": "#/components/schemas/RecoveryQuestionCredential" + } + }, + "type": "object" + }, + "UserCredentialsWritable": { + "description": "Specifies primary authentication and recovery credentials for a user. Credential types and requirements vary depending on the provider and security policy of the org.", + "properties": { + "password": { + "$ref": "#/components/schemas/PasswordCredential" + }, + "provider": { + "$ref": "#/components/schemas/AuthenticationProviderWritable" + }, + "recovery_question": { + "$ref": "#/components/schemas/RecoveryQuestionCredential" + } + }, + "type": "object" + }, + "UserDevice": { + "properties": { + "created": { + "description": "Timestamp when the device was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "device": { + "$ref": "#/components/schemas/Device", + "type": "object" + }, + "deviceUserId": { + "description": "Unique key for the user device link", + "type": "string" + } + }, + "type": "object" + }, + "UserFactor": { + "discriminator": { + "mapping": { + "call": "#/components/schemas/UserFactorCall", + "email": "#/components/schemas/UserFactorEmail", + "push": "#/components/schemas/UserFactorPush", + "question": "#/components/schemas/UserFactorSecurityQuestion", + "sms": "#/components/schemas/UserFactorSMS", + "token": "#/components/schemas/UserFactorToken", + "token:hardware": "#/components/schemas/UserFactorTokenHardware", + "token:hotp": "#/components/schemas/UserFactorTokenHOTP", + "token:software:totp": "#/components/schemas/UserFactorTokenSoftwareTOTP", + "u2f": "#/components/schemas/UserFactorU2F", + "web": "#/components/schemas/UserFactorWeb", + "webauthn": "#/components/schemas/UserFactorWebAuthn" + }, + "propertyName": "factorType" + }, + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/UserFactorLinks" + }, + "created": { + "description": "Timestamp when the factor was enrolled", + "example": "2022-08-25T00:31:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "factorType": { + "$ref": "#/components/schemas/UserFactorType" + }, + "id": { + "description": "ID of the factor", + "example": "caf8m6jbcvUH8mAep1d7", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the factor was last updated", + "example": "2022-08-25T00:31:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "profile": { + "description": "Specific attributes related to the factor", + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "provider": { + "description": "Provider for the factor. Each provider can support a subset of factor types.", + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/UserFactorStatus" + }, + "vendorName": { + "description": "Name of the factor vendor. This is usually the same as the provider except for On-Prem MFA, which depends on admin settings.", + "example": "OKTA", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserFactorActivatePush": { + "description": "Activation requests have a short lifetime and expire if the activation isn't completed before the indicated timestamp. If the activation expires, use the returned `activate` link to restart the process.", + "properties": { + "expiresAt": { + "description": "Timestamp when the factor verification attempt expires", + "example": "2022-08-25T00:31:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "factorResult": { + "$ref": "#/components/schemas/UserFactorActivatePushResult", + "readOnly": true + } + }, + "type": "object" + }, + "UserFactorActivatePushResult": { + "description": "Result of a factor activation", + "enum": [ + "CANCELLED", + "ERROR", + "TIMEOUT", + "WAITING" + ], + "type": "string" + }, + "UserFactorActivateRequest": { + "oneOf": [ + { + "description": "Attempts to activate a `call` factor with the specified passcode", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "call" + }, + { + "description": "Attempts to activate an `email` factor with the specified passcode", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "email" + }, + { + "description": "Sends an asynchronous push notification to the device for approval by the user. You must poll the transaction to determine the state of the verification. See [Retrieve a factor transaction status](./#tag/UserFactor/operation/getFactorTransactionStatus).\n\nActivations have a short lifetime of several minutes and return a `TIMEOUT` if not completed before the timestamp specified in the `expiresAt` param. Use the published activate link to restart the activation process if the activation expires.", + "nullable": true, + "properties": { + "useNumberMatchingChallenge": { + "$ref": "#/components/schemas/useNumberMatchingChallenge" + } + }, + "title": "push", + "type": "object" + }, + { + "description": "Attempts to activate an `sms` factor with the specified passcode", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "sms" + }, + { + "description": "Attempts to activate a `token:software:totp` factor with the specified passcode", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "token:software:totp" + }, + { + "description": "Activates a `u2f` factor with the specified client and registration information from the U2F token", + "properties": { + "clientData": { + "description": "Base64-encoded client data from the U2F token", + "example": "eyJ0eXAiOiJuYXZpZ2F0b3IuaWQuZmluaXNoRW5yb2xsbWVudCIsImNoYWxsZW5nZSI6IlhxR0h0RTBoUkxuVEoxYUF5U1oyIiwib3JpZ2luIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6MzAwMCIsImNpZF9wdWJrZXkiOiJ1bnVzZWQifQ", + "type": "string" + }, + "registrationData": { + "description": "Base64-encoded registration data from the U2F token", + "example": "BQTEMUyOM8h1TiZG4DL-RdMr-tYgTYSf62Y52AmwEFTiSYWIRVO5L-MwWdRJOthmV3J3JrqpmGfmFb820-awx1YIQFlTvkMhxItHlpkzahEqicpw7SIH9yMfTn2kaDcC6JaLKPfV5ds0vzuxF1JJj3gCM01bRC-HWI4nCVgc-zaaoRgwggEcMIHDoAMCAQICCwD52fCSMoNczORdMAoGCCqGSM49BAMCMBUxEzARBgNVBAMTClUyRiBJc3N1ZXIwGhcLMDAwMTAxMDAwMFoXCzAwMDEwMTAwMDBaMBUxEzARBgNVBAMTClUyRiBEZXZpY2UwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAAQFKJupuUgPQcRHUphaW5JPfLvkkwlEwlHKk_ntSp7MS4aTHJyGnpziqncrjiTC_oUVtb-wN-y_t_IMIjueGkhxMAoGCCqGSM49BAMCA0gAMEUCIQDBo6aOLxanIUYnBX9iu3KMngPnobpi0EZSTkVtLC8_cwIgC1945RGqGBKfbyNtkhMifZK05n7fU-gW37Bdnci5D94wRQIhAJv3VvclbRkHAQhaUR8rr8qFTg9iF-GtHoXU95vWaQdyAiAbEr-440U4dQAZF-Sj8G2fxgh5DkgkkWpyUHZhz7N9ew", + "type": "string" + } + }, + "title": "u2f" + }, + { + "description": "Activates a `webauthn` factor with the specified attestation and registration information from the Passkey (FIDO2 WebAuthn) authenticator", + "properties": { + "attestation": { + "description": "Base64-encoded attestation from the Passkey (FIDO2 WebAuthn) authenticator", + "example": "o2NmbXRmcGFja2VkZ2F0dFN0bXSiY2FsZyZjc2lnWEgwRgIhAMvf2+dzXlHZN1um38Y8aFzrKvX0k5dt/hnDu9lahbR4AiEAuwtMg3IoaElWMp00QrP/+3Po/6LwXfmYQVfsnsQ+da1oYXV0aERhdGFYxkgb9OHGifjS2dG03qLRqvXrDIRyfGAuc+GzF1z20/eVRV2wvl6tzgACNbzGCmSLCyXx8FUDAEIBvWNHOcE3QDUkDP/HB1kRbrIOoZ1dR874ZaGbMuvaSVHVWN2kfNiO4D+HlAzUEFaqlNi5FPqKw+mF8f0XwdpEBlClAQIDJiABIVgg0a6oo3W0JdYPu6+eBrbr0WyB3uJLI3ODVgDfQnpgafgiWCB4fFo/5iiVrFhB8pNH2tbBtKewyAHuDkRolcCnVaCcmQ==", + "type": "string" + }, + "clientData": { + "description": "Base64-encoded client data from the Passkey (FIDO2 WebAuthn) authenticator", + "example": "eyJjaGFsbGVuZ2UiOiJVSk5wYW9sVWt0dF9vcEZPNXJMYyIsIm9yaWdpbiI6Imh0dHBzOi8vcmFpbi5va3RhMS5jb20iLCJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIn0", + "type": "string" + } + }, + "title": "webauthn" + } + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserFactorActivateResponse": { + "discriminator": { + "mapping": { + "call": "#/components/schemas/UserFactorCall", + "email": "#/components/schemas/UserFactorEmail", + "push": "#/components/schemas/UserFactorPush", + "sms": "#/components/schemas/UserFactorSMS", + "token:software:totp": "#/components/schemas/UserFactorTokenSoftwareTOTP", + "u2f": "#/components/schemas/UserFactorU2F", + "webauthn": "#/components/schemas/UserFactorWebAuthn" + }, + "propertyName": "factorType" + }, + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "$ref": "#/components/schemas/LinksUserFactors" + }, + { + "$ref": "#/components/schemas/LinksVerify" + } + ] + }, + "factorType": { + "description": "Type of the factor", + "enum": [ + "call", + "email", + "sms", + "push", + "token:software:totp", + "u2f", + "webauthn" + ], + "type": "string" + } + }, + "type": "object" + }, + "UserFactorCall": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorType": { + "example": "call" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorCallProfile" + }, + "provider": { + "enum": [ + "OKTA" + ] + } + }, + "type": "object" + } + ], + "title": "call" + }, + "UserFactorCallProfile": { + "properties": { + "phoneExtension": { + "description": "Extension of the associated `phoneNumber`", + "example": 1234, + "maxLength": 15, + "nullable": true, + "type": "string" + }, + "phoneNumber": { + "description": "Phone number of the factor. Format phone numbers to use the [E.164 standard](https://www.itu.int/rec/T-REC-E.164/).", + "example": "+15554151337", + "maxLength": 15, + "pattern": "^\\+[1-9]\\d{1,14}$", + "type": "string" + } + }, + "type": "object" + }, + "UserFactorEmail": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorType": { + "example": "email" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorEmailProfile" + }, + "provider": { + "enum": [ + "OKTA" + ] + } + }, + "type": "object" + } + ], + "title": "email" + }, + "UserFactorEmailProfile": { + "properties": { + "email": { + "description": "Email address of the user. This must be either the primary or secondary email address associated with the Okta user account.", + "example": "z.cool@example.com", + "maxLength": 100, + "type": "string" + } + }, + "type": "object" + }, + "UserFactorLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksActivate" + }, + { + "$ref": "#/components/schemas/LinksCancel" + }, + { + "$ref": "#/components/schemas/LinksDeactivate" + }, + { + "$ref": "#/components/schemas/LinksEnroll" + }, + { + "$ref": "#/components/schemas/LinksFactor" + }, + { + "$ref": "#/components/schemas/LinksPoll" + }, + { + "$ref": "#/components/schemas/LinksQrcode" + }, + { + "$ref": "#/components/schemas/LinksQuestions" + }, + { + "$ref": "#/components/schemas/LinksResend" + }, + { + "$ref": "#/components/schemas/LinksSend" + }, + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "$ref": "#/components/schemas/LinksUserFactors" + }, + { + "$ref": "#/components/schemas/LinksVerify" + } + ], + "readOnly": true + }, + "UserFactorPassCode": { + "description": "OTP for the current time window", + "example": 1234567890, + "type": "string" + }, + "UserFactorProvider": { + "enum": [ + "CUSTOM", + "DUO", + "FIDO", + "GOOGLE", + "OKTA", + "RSA", + "SYMANTEC", + "YUBICO" + ], + "type": "string" + }, + "UserFactorPush": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "profile": { + "$ref": "#/components/schemas/UserFactorPushProfile" + }, + "provider": { + "enum": [ + "OKTA" + ] + } + }, + "type": "object" + } + ], + "title": "push" + }, + "UserFactorPushProfile": { + "properties": { + "credentialId": { + "description": "ID for the factor credential", + "example": "dade.murphy@example.com", + "type": "string" + }, + "deviceToken": { + "description": "Token used to identify the device", + "example": "fwf7ku6bsiSCieh6y1d7", + "type": "string" + }, + "deviceType": { + "description": "Type of device", + "example": "SmartPhone_IPhone", + "type": "string" + }, + "name": { + "description": "Name of the device", + "example": "My Phone", + "type": "string" + }, + "platform": { + "description": "OS version of the associated device", + "example": "IOS", + "type": "string" + }, + "version": { + "description": "Installed version of Okta Verify", + "example": "9.0", + "type": "string" + } + }, + "type": "object" + }, + "UserFactorPushTransaction": { + "discriminator": { + "mapping": { + "REJECTED": "#/components/schemas/UserFactorPushTransactionRejected", + "SUCCESS": "#/components/schemas/UserFactorPushTransaction", + "TIMEOUT": "#/components/schemas/UserFactorPushTransactionTimeout", + "WAITING": "#/components/schemas/UserFactorPushTransactionWaitingNoNMC", + "WAITING (with number matching challenge)": "#/components/schemas/UserFactorPushTransactionWaitingNMC" + }, + "propertyName": "factorResult" + }, + "properties": { + "factorResult": { + "description": "Result of the verification transaction", + "enum": [ + "WAITING (with number matching challenge)", + "WAITING", + "SUCCESS", + "REJECTED", + "TIMEOUT" + ], + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserFactorPushTransactionRejected": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactorPushTransaction" + }, + { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksVerify" + }, + { + "properties": { + "factor": { + "$ref": "#/components/schemas/UserFactor" + } + }, + "type": "object" + } + ] + }, + "profile": { + "properties": { + "credentialId": { + "description": "ID for the factor credential", + "example": "dade.murphy@example.com", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "UserFactorPushTransactionSuccess": { + "$ref": "#/components/schemas/UserFactorPushTransaction" + }, + "UserFactorPushTransactionTimeout": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactorPushTransaction" + }, + { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksVerify" + }, + { + "properties": { + "factor": { + "$ref": "#/components/schemas/UserFactor" + } + }, + "type": "object" + } + ] + }, + "profile": { + "properties": { + "credentialId": { + "description": "ID for the factor credential", + "example": "dade.murphy@example.com", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "UserFactorPushTransactionWaitingNMC": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactorPushTransaction" + }, + { + "properties": { + "_embedded": { + "$ref": "#/components/schemas/NumberFactorChallengeEmbeddedLinks" + }, + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksPoll" + }, + { + "$ref": "#/components/schemas/LinksCancel" + } + ] + }, + "profile": { + "properties": { + "credentialId": { + "description": "ID for the factor credential", + "example": "dade.murphy@example.com", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "UserFactorPushTransactionWaitingNoNMC": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactorPushTransaction" + }, + { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksPoll" + }, + { + "$ref": "#/components/schemas/LinksCancel" + } + ] + }, + "profile": { + "properties": { + "credentialId": { + "description": "ID for the factor credential", + "example": "dade.murphy@example.com", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "UserFactorResultType": { + "description": "Result of a factor verification attempt", + "enum": [ + "CANCELLED", + "CHALLENGE", + "ERROR", + "FAILED", + "PASSCODE_REPLAYED", + "REJECTED", + "SUCCESS", + "TIMEOUT", + "TIME_WINDOW_EXCEEDED", + "WAITING" + ], + "readOnly": true, + "type": "string" + }, + "UserFactorSMS": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorType": { + "example": "sms" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorSMSProfile" + }, + "provider": { + "enum": [ + "OKTA" + ] + } + }, + "type": "object" + } + ], + "title": "sms" + }, + "UserFactorSMSProfile": { + "properties": { + "phoneNumber": { + "description": "Phone number of the factor. You should format phone numbers to use the [E.164 standard](https://www.itu.int/rec/T-REC-E.164/).", + "example": "+15554151337", + "maxLength": 15, + "pattern": "^\\+[1-9]\\d{1,14}$", + "type": "string" + } + }, + "type": "object" + }, + "UserFactorSecurityQuestion": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorType": { + "example": "question" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorSecurityQuestionProfile" + }, + "provider": { + "enum": [ + "OKTA" + ] + } + }, + "type": "object" + } + ], + "title": "question" + }, + "UserFactorSecurityQuestionProfile": { + "properties": { + "answer": { + "description": "Answer to the question", + "minLength": 4, + "type": "string", + "writeOnly": true + }, + "question": { + "description": "Unique key for the question", + "enum": [ + "disliked_food", + "name_of_first_plush_toy", + "first_award", + "favorite_security_question", + "favorite_toy", + "first_computer_game", + "favorite_movie_quote", + "first_sports_team_mascot", + "first_music_purchase", + "favorite_art_piece", + "grandmother_favorite_desert", + "first_thing_cooked", + "childhood_dream_job", + "first_kiss_location", + "place_where_significant_other_was_met", + "favorite_vacation_location", + "new_years_two_thousand", + "favorite_speaker_actor", + "favorite_book_movie_character", + "favorite_sports_player" + ], + "example": "disliked_food", + "type": "string" + }, + "questionText": { + "description": "Human-readable text that's displayed to the user", + "example": "What is the food you least liked as a child?", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UserFactorSignatureData": { + "description": "Base64-encoded signature data from the Passkey authenticator", + "type": "string" + }, + "UserFactorStatus": { + "description": "Status of the factor", + "enum": [ + "ACTIVE", + "DISABLED", + "ENROLLED", + "EXPIRED", + "INACTIVE", + "NOT_SETUP", + "PENDING_ACTIVATION" + ], + "example": "ACTIVE", + "readOnly": true, + "type": "string" + }, + "UserFactorSupported": { + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "Embedded resources related to the factor", + "readOnly": true, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/UserFactorLinks" + }, + "enrollment": { + "description": "Indicates if the factor is required for the specified user", + "enum": [ + "OPTIONAL", + "REQUIRED" + ], + "example": "OPTIONAL", + "type": "string" + }, + "factorType": { + "$ref": "#/components/schemas/UserFactorType" + }, + "provider": { + "$ref": "#/components/schemas/UserFactorProvider" + }, + "status": { + "$ref": "#/components/schemas/UserFactorStatus" + }, + "vendorName": { + "description": "Name of the factor vendor. This is usually the same as the provider except for On-Prem MFA, which depends on admin settings.", + "example": "OKTA", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserFactorToken": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorType": { + "example": "token" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorTokenProfile" + }, + "provider": { + "enum": [ + "RSA", + "SYMANTEC" + ] + }, + "verify": { + "oneOf": [ + { + "$ref": "#/components/schemas/UserFactorTokenVerifyRSA" + }, + { + "$ref": "#/components/schemas/UserFactorTokenVerifySymantec" + } + ] + } + }, + "type": "object" + } + ], + "title": "token", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserFactorTokenFactorVerificationObject": { + "properties": { + "nextPassCode": { + "description": "OTP for the next time window", + "example": 678195, + "type": "string" + }, + "passCode": { + "description": "OTP for the current time window", + "example": 875498, + "type": "string" + } + }, + "type": "object" + }, + "UserFactorTokenHOTP": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorProfileId": { + "description": "ID of an existing Custom TOTP factor profile. To create this, see [Custom TOTP factor](https://help.okta.com/okta_help.htm?id=ext-mfa-totp).", + "type": "string" + }, + "factorType": { + "example": "token:hotp" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorTokenHOTPProfile" + }, + "provider": { + "enum": [ + "CUSTOM" + ] + } + }, + "type": "object" + } + ], + "title": "token:hotp" + }, + "UserFactorTokenHOTPProfile": { + "properties": { + "sharedSecret": { + "description": "Unique secret key used to generate the OTP", + "example": "484f97be3213b117e3a20438e291540a", + "type": "string" + } + }, + "type": "object" + }, + "UserFactorTokenHardware": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorType": { + "example": "token:hardware" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorTokenProfile" + }, + "provider": { + "enum": [ + "YUBICO" + ] + }, + "verify": { + "properties": { + "passCode": { + "description": "OTP for the current time window", + "example": "cccccceukngdfgkukfctkcvfidnetljjiknckkcjulji", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "title": "token:hardware" + }, + "UserFactorTokenProfile": { + "properties": { + "credentialId": { + "description": "ID for the factor credential", + "example": "dade.murphy@example.com", + "type": "string" + } + }, + "type": "object" + }, + "UserFactorTokenSoftwareTOTP": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorType": { + "example": "token:software:totp" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorTokenProfile" + }, + "provider": { + "enum": [ + "OKTA", + "GOOGLE" + ] + } + }, + "type": "object" + } + ], + "title": "token:software:totp" + }, + "UserFactorTokenVerifyRSA": { + "properties": { + "passCode": { + "description": "OTP for the current time window", + "example": 5275875498, + "type": "string" + } + }, + "title": "RSA SecurID", + "type": "object" + }, + "UserFactorTokenVerifySymantec": { + "properties": { + "nextPassCode": { + "description": "OTP for the next time window", + "example": 3956685498, + "type": "integer" + }, + "passCode": { + "description": "OTP for the current time window", + "example": 5275875498, + "type": "string" + } + }, + "title": "Symantec VIP", + "type": "object" + }, + "UserFactorType": { + "description": "Type of factor", + "enum": [ + "call", + "email", + "push", + "question", + "signed_nonce", + "sms", + "token", + "token:hardware", + "token:hotp", + "token:software:totp", + "u2f", + "web", + "webauthn" + ], + "type": "string" + }, + "UserFactorU2F": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorType": { + "example": "u2f" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorU2FProfile" + }, + "provider": { + "enum": [ + "FIDO" + ] + } + }, + "type": "object" + } + ], + "title": "u2f" + }, + "UserFactorU2FProfile": { + "properties": { + "credentialId": { + "description": "ID for the factor credential", + "example": "dade.murphy@example.com", + "type": "string" + } + }, + "type": "object" + }, + "UserFactorVerifyRequest": { + "oneOf": [ + { + "description": "Verifies an OTP sent by a `call` factor challenge. If you omit `passCode` in the request, a new OTP is sent to the phone.", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "call" + }, + { + "description": "Verifies an OTP sent by an `sms` factor challenge. If you omit `passCode` in the request, a new OTP is sent to the phone.", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "sms" + }, + { + "description": "Sends an asynchronous push notification to the device for approval by the user. A successful request returns an HTTP 201 response, unlike other factors. You must poll the transaction to determine the state of the verification. See [Retrieve a factor transaction status](./#tag/UserFactor/operation/getFactorTransactionStatus).", + "nullable": true, + "properties": { + "useNumberMatchingChallenge": { + "$ref": "#/components/schemas/useNumberMatchingChallenge" + } + }, + "title": "push", + "type": "object" + }, + { + "description": "Verifies an OTP sent by an `email` factor challenge. If you omit `passCode` in the request, a new OTP is sent to the phone.", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "email" + }, + { + "description": "Verifies an answer to a `question` factor", + "properties": { + "answer": { + "description": "Answer to the question", + "minLength": 4, + "type": "string", + "writeOnly": true + } + }, + "title": "question" + }, + { + "description": "Verifies an OTP for a `token:software:totp` factor", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "token:software:totp" + }, + { + "description": "Verifies an OTP for a `token:hotp` factor", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "token:hotp" + }, + { + "description": "Verifies an OTP for a `token:hardware` factor", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "token:hardware" + }, + { + "description": "Verifies an OTP for a `token` factor", + "properties": { + "passCode": { + "$ref": "#/components/schemas/UserFactorPassCode" + } + }, + "title": "token" + }, + { + "description": "Verifies a `u2f` factor challenge by posting a signed assertion using the challenge `nonce`", + "properties": { + "clientData": { + "description": "Base64-encoded client data from the U2F token", + "example": "eyJ0eXAiOiJuYXZpZ2F0b3IuaWQuZmluaXNoRW5yb2xsbWVudCIsImNoYWxsZW5nZSI6IlhxR0h0RTBoUkxuVEoxYUF5U1oyIiwib3JpZ2luIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6MzAwMCIsImNpZF9wdWJrZXkiOiJ1bnVzZWQifQ", + "type": "string" + }, + "signatureData": { + "description": "Base64-encoded signature data from the U2F token" + } + }, + "title": "u2f" + }, + { + "description": "Verifies a `webauthn` factor challenge by posting a signed assertion using the challenge `nonce`", + "properties": { + "authenticatorData": { + "description": "Base64-encoded authenticator data from the Passkey (FIDO2 WebAuthn) authenticator", + "type": "string" + }, + "clientData": { + "description": "Base64-encoded client data from the Passkey (FIDO2 WebAuthn) authenticator", + "example": "eyJjaGFsbGVuZ2UiOiJVSk5wYW9sVWt0dF9vcEZPNXJMYyIsIm9yaWdpbiI6Imh0dHBzOi8vcmFpbi5va3RhMS5jb20iLCJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIn0", + "type": "string" + }, + "signatureData": { + "description": "Base64-encoded signature data from the Passkey (FIDO2 WebAuthn) authenticator", + "type": "string" + } + }, + "title": "webauthn" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserFactorVerifyResponse": { + "properties": { + "_embedded": { + "allOf": [ + { + "additionalProperties": { + "nullable": true, + "readOnly": true, + "type": "object" + } + } + ] + }, + "_links": { + "$ref": "#/components/schemas/UserFactorLinks" + }, + "expiresAt": { + "description": "Timestamp when the verification expires", + "example": "2022-08-25T00:31:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "factorMessage": { + "description": "Optional display message for factor verification", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "factorResult": { + "$ref": "#/components/schemas/UserFactorVerifyResult", + "readOnly": true + }, + "profile": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "readOnly": true, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserFactorVerifyResponseWaiting": { + "properties": { + "_embedded": { + "allOf": [ + { + "$ref": "#/components/schemas/NumberFactorChallengeEmbeddedLinks" + }, + { + "additionalProperties": { + "nullable": true, + "readOnly": true, + "type": "object" + } + } + ] + }, + "_links": { + "$ref": "#/components/schemas/UserFactorLinks" + }, + "expiresAt": { + "description": "Timestamp when the verification expires", + "example": "2022-08-25T00:31:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "factorMessage": { + "description": "Optional display message for factor verification", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "factorResult": { + "$ref": "#/components/schemas/UserFactorVerifyResultWaiting", + "readOnly": true + }, + "profile": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "readOnly": true, + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserFactorVerifyResult": { + "description": "Result of a factor verification", + "enum": [ + "CHALLENGE", + "ERROR", + "EXPIRED", + "FAILED", + "PASSCODE_REPLAYED", + "REJECTED", + "SUCCESS", + "TIMEOUT", + "TIME_WINDOW_EXCEEDED" + ], + "type": "string", + "x-enumDescriptions": { + "CANCELED": "User cancelled the verification", + "CHALLENGE": "Okta issued a verification challenge", + "ERROR": "Verification encountered an unexpected server error", + "EXPIRED": "User didn't complete the verification within the allowed time window", + "FAILED": "Verification failed", + "PASSCODE_REPLAYED": "User previously verified the factor within the same time window. Another verification is required during another time window.", + "REJECTED": "User rejected the verification", + "SUCCESS": "User completed the verification", + "TIMEOUT": "Okta didn't complete the verification within the allowed time window", + "TIME_WINDOW_EXCEEDED": "User completed the verification outside of the allowed time window. Another verification is required." + } + }, + "UserFactorVerifyResultWaiting": { + "description": "Result of a factor verification", + "enum": [ + "WAITING" + ], + "type": "string", + "x-enumDescriptions": { + "WAITING": "Verification is in progress" + } + }, + "UserFactorWeb": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorType": { + "example": "web" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorWebProfile" + }, + "provider": { + "enum": [ + "DUO" + ] + } + }, + "type": "object" + } + ], + "title": "web" + }, + "UserFactorWebAuthn": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFactor" + }, + { + "properties": { + "factorType": { + "example": "webauthn" + }, + "profile": { + "$ref": "#/components/schemas/UserFactorWebAuthnProfile" + }, + "provider": { + "enum": [ + "FIDO" + ] + } + }, + "type": "object" + } + ], + "title": "webauthn" + }, + "UserFactorWebAuthnProfile": { + "properties": { + "authenticatorName": { + "description": "Human-readable name of the authenticator\n\n> **Note:** This name is set from the AAGUID metadata during enrollment. It can't be changed in the Admin Console or by using any Okta APIs.", + "example": "MacBook Touch ID", + "type": "string" + }, + "credentialId": { + "description": "ID for the factor credential", + "example": "AHoOEhwvYiMv6SSwLp7KYRNttXtg_kYgQoQiEIWPFH_T3Ztp5Vj3bQ5H0LypIFR8ka8kfiCJ3I5qVpxrsd6JTMWKcE3xNh_U2QVF0Kwlan8Fiw", + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "UserFactorWebProfile": { + "properties": { + "credentialId": { + "description": "ID for the factor credential", + "example": "dade.murphy@example.com", + "type": "string" + } + }, + "type": "object" + }, + "UserFactorYubikeyOtpToken": { + "properties": { + "_embedded": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "type": "object" + }, + "_links": { + "$ref": "#/components/schemas/UserFactorLinks" + }, + "created": { + "description": "Timestamp when the token was created", + "example": "2022-08-25T00:31:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "ID of the token", + "example": "ykkwcx13nrDq8g4oy0g3", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the token was last updated", + "example": "2022-08-25T00:31:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastVerified": { + "description": "Timestamp when the token was last verified", + "example": "2022-08-25T00:31:00.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "profile": { + "additionalProperties": { + "properties": {}, + "type": "object" + }, + "description": "Specified profile information for token", + "type": "object" + }, + "status": { + "description": "Token status", + "enum": [ + "BLOCKED", + "UNASSIGNED", + "ACTIVE", + "REVOKED", + "DELETED", + "INACTIVE" + ], + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserGetSingleton": { + "allOf": [ + { + "$ref": "#/components/schemas/User" + }, + { + "properties": { + "_embedded": { + "description": "The embedded resources related to the object if the `expand` query parameter is specified", + "properties": { + "blocks": { + "description": "A list of access block details for the user account", + "items": { + "$ref": "#/components/schemas/UserBlock" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "UserIdentifierConditionEvaluatorPattern": { + "description": "Specifies the details of the patterns to match against", + "properties": { + "matchType": { + "$ref": "#/components/schemas/UserIdentifierMatchType" + }, + "value": { + "description": "The regular expression or simple match string", + "type": "string" + } + }, + "type": "object" + }, + "UserIdentifierMatchType": { + "description": "The type of pattern. For regex, use `EXPRESSION`.", + "enum": [ + "CONTAINS", + "EQUALS", + "EXPRESSION", + "STARTS_WITH", + "SUFFIX" + ], + "type": "string" + }, + "UserIdentifierPolicyRuleCondition": { + "description": "Specifies a user identifier condition to match on", + "properties": { + "attribute": { + "description": "The name of the profile attribute to match against. Only used when type is `ATTRIBUTE`.", + "type": "string" + }, + "patterns": { + "items": { + "$ref": "#/components/schemas/UserIdentifierConditionEvaluatorPattern" + }, + "type": "array" + }, + "type": { + "$ref": "#/components/schemas/UserIdentifierType" + } + }, + "type": "object" + }, + "UserIdentifierType": { + "description": "What to match against, either user ID or an attribute in the user's Okta profile.", + "enum": [ + "ATTRIBUTE", + "IDENTIFIER" + ], + "type": "string" + }, + "UserIdentityProviderLinkRequest": { + "properties": { + "externalId": { + "description": "Unique IdP-specific identifier for a user", + "example": "121749775026145", + "type": "string" + } + }, + "type": "object" + }, + "UserImportRequest": { + "properties": { + "data": { + "$ref": "#/components/schemas/UserImportRequestData" + }, + "eventType": { + "description": "The type of inline hook. The user import inline hook type is `com.okta.import.transform`.", + "type": "string" + }, + "source": { + "description": "The ID of the user import inline hook", + "type": "string" + } + }, + "type": "object" + }, + "UserImportRequestData": { + "properties": { + "action": { + "description": "The object that specifies the default action Okta is set to take", + "properties": { + "result": { + "description": "The current default action that results when Okta imports a user. The two possible values are `CREATE_USER` and `LINK_USER`. You \ncan change the action that is taken by means of the commands object you return.", + "enum": [ + "CREATE_USER", + "LINK_USER" + ], + "type": "string", + "x-enumDescriptions": { + "CREATE_USER": "A new Okta user profile is created for the user", + "LINK_USER": "The user is treated as a match for the existing Okta user identified by the value of `data.user.id`" + } + } + }, + "type": "object" + }, + "appUser": { + "description": "The app user profile being imported", + "properties": { + "profile": { + "additionalProperties": { + "type": "string" + }, + "description": "Provides the name-value pairs of the attributes contained in the app user profile of the user who is being imported. You can change \nthe values of attributes in the user's app profile by means of the `commands` object you return. If you change attributes in the app \nprofile, they then flow through to the Okta user profile, based on matching and mapping rules.", + "type": "object" + } + }, + "type": "object" + }, + "context": { + "properties": { + "application": { + "description": "Details of the app from which the user is being imported", + "properties": { + "id": { + "description": "The app ID", + "type": "string" + }, + "label": { + "description": "The user-defined display name for the app", + "type": "string" + }, + "name": { + "description": "The app name", + "type": "string" + }, + "status": { + "description": "The status of the app", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + } + }, + "type": "object" + }, + "conflicts": { + "description": "An array of user profile attributes that are in conflict", + "items": { + "additionalProperties": true, + "type": "string" + }, + "type": "array" + }, + "job": { + "description": "The details of the running import job", + "properties": { + "id": { + "description": "The ID number of the import job", + "type": "string" + }, + "type": { + "description": "The type of import job", + "type": "string" + } + }, + "type": "object" + }, + "matches": { + "description": "The list of Okta users currently matched to the app user based on import matching. There can be more than one match.", + "items": { + "additionalProperties": true, + "type": "string" + }, + "type": "array" + }, + "policy": { + "description": "The list of any policies that apply to the import matching", + "items": { + "additionalProperties": true, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "user": { + "description": "Provides information on the Okta user profile currently set to be used for the user who is being imported, based on the matching \nrules and attribute mappings that were applied.", + "properties": { + "profile": { + "additionalProperties": { + "type": "string" + }, + "description": "The `data.user.profile` contains the name-value pairs of the attributes in the user profile. If the user has been matched to an existing\nOkta user, a `data.user.id` object is included, containing the unique identifier of the Okta user profile.\n\nYou can change the values of the attributes by means of the `commands` object you return.", + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "UserImportRequestExecute": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/UserImportRequest" + } + ], + "description": "User import inline hook request" + }, + "UserImportResponse": { + "properties": { + "commands": { + "description": "The `commands` object is where you can provide commands to Okta. It is an array that allows you to send multiple commands.\nEach array element needs to consist of a type-value pair.", + "items": { + "properties": { + "type": { + "description": "The command types supported for the import inline hook.\nWhen using the `com.okta.action.update` command to specify that the user should be treated as a match, you need to also provide a `com.okta.user.update` command that sets the ID of the Okta user.", + "enum": [ + "com.okta.appUser.profile.update", + "com.okta.user.profile.update", + "com.okta.action.update", + "com.okta.user.update" + ], + "type": "string", + "x-enumDescriptions": { + "com.okta.action.update": "Specify whether to create a new Okta user for the user being imported or treat them as a match of an existing Okta user", + "com.okta.appUser.profile.update": "Change values of attributes in the user's app user profile", + "com.okta.user.profile.update": "Change values of attributes in the user's Okta user profile", + "com.okta.user.update": "Specify the existing Okta user that the imported user should be treated as a match of." + } + }, + "value": { + "additionalProperties": { + "type": "string" + }, + "description": "The `value` object is the parameter to pass to the command. In the case of the `com.okta.appUser.profile.update` and `com.okta.user.profile.update` commands, \nthe parameter should be a list of one or more profile attributes and the values you wish to set them to. In the case of the `com.okta.action.update` command,\nthe parameter should be a `result` property set to either `CREATE_USER` or `LINK_USER`.", + "type": "object" + } + }, + "type": "object" + }, + "type": "array" + }, + "error": { + "description": "An object to return an error. Returning an error causes Okta to record a failure event in the Okta System Log. \nThe string supplied in the `errorSummary` property is recorded in the System Log event.\n\n>**Note:** If a response to an import inline hook request is not received from your external service within three seconds, a timeout occurs. In this scenario, the Okta import process continues and the user is created.", + "properties": { + "errorSummary": { + "description": "A human-readable summary of the error", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "UserLifecycleAttributePolicyRuleCondition": { + "properties": { + "attributeName": { + "type": "string" + }, + "matchingValue": { + "type": "string" + } + }, + "type": "object" + }, + "UserLockoutSettings": { + "properties": { + "preventBruteForceLockoutFromUnknownDevices": { + "default": false, + "description": "Prevents brute-force lockout from unknown devices for the password authenticator.", + "type": "boolean" + } + }, + "type": "object" + }, + "UserNextLogin": { + "enum": [ + "changePassword" + ], + "type": "string" + }, + "UserPolicyRuleCondition": { + "description": "Specifies a set of Users to be included or excluded", + "properties": { + "exclude": { + "description": "Users to be excluded", + "items": { + "type": "string" + }, + "type": "array" + }, + "inactivity": { + "$ref": "#/components/schemas/InactivityPolicyRuleCondition" + }, + "include": { + "description": "Users to be included", + "items": { + "type": "string" + }, + "type": "array" + }, + "lifecycleExpiration": { + "$ref": "#/components/schemas/LifecycleExpirationPolicyRuleCondition" + }, + "passwordExpiration": { + "$ref": "#/components/schemas/PasswordExpirationPolicyRuleCondition" + }, + "userLifecycleAttribute": { + "$ref": "#/components/schemas/UserLifecycleAttributePolicyRuleCondition" + } + }, + "type": "object" + }, + "UserProfile": { + "additionalProperties": true, + "description": "Specifies the default and custom profile properties for a user.\n\nThe default user profile is based on the [System for Cross-domain Identity Management: Core Schema](https://datatracker.ietf.org/doc/html/rfc7643).\n\nThe only permitted customizations of the default profile are to update permissions, change whether the `firstName` and `lastName` properties are nullable, and specify a [pattern](https://developer.okta.com/docs/reference/api/schemas/#login-pattern-validation) for `login`. You can use the Profile Editor in the Admin Console or the [Schemas API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UISchema/#tag/UISchema) to make schema modifications.\n\nYou can extend user profiles with custom properties. You must first add the custom property to the user profile schema before you reference it.\nYou can use the Profile Editor in the Admin Console or the [Schemas API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UISchema/#tag/UISchema) to manage schema extensions.\n\nCustom attributes can contain HTML tags. It's the client's responsibility to escape or encode this data before displaying it. Use [best-practices](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html) to prevent cross-site scripting.", + "properties": { + "city": { + "description": "The city or locality of the user's address (`locality`)", + "maxLength": 128, + "nullable": true, + "type": "string" + }, + "costCenter": { + "description": "Name of the cost center assigned to a user", + "nullable": true, + "type": "string" + }, + "countryCode": { + "description": "The country name component of the user's address (`country`). For validation, see [ISO 3166-1 alpha 2 \"short\" code format](https://datatracker.ietf.org/doc/html/draft-ietf-scim-core-schema-22#ref-ISO3166).", + "maxLength": 2, + "nullable": true, + "type": "string" + }, + "department": { + "description": "Name of the user's department", + "type": "string" + }, + "displayName": { + "description": "Name of the user suitable for display to end users", + "nullable": true, + "type": "string" + }, + "division": { + "description": "Name of the user's division", + "nullable": true, + "type": "string" + }, + "email": { + "description": "The primary email address of the user. For validation, see [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3).", + "format": "email", + "maxLength": 100, + "minLength": 5, + "type": "string" + }, + "employeeNumber": { + "description": "The organization or company assigned unique identifier for the user", + "type": "string" + }, + "firstName": { + "description": "Given name of the user (`givenName`)", + "maxLength": 50, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "honorificPrefix": { + "description": "Honorific prefix(es) of the user, or title in most Western languages", + "nullable": true, + "type": "string" + }, + "honorificSuffix": { + "description": "Honorific suffix(es) of the user", + "nullable": true, + "type": "string" + }, + "lastName": { + "description": "The family name of the user (`familyName`)", + "maxLength": 50, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "locale": { + "description": "The user's default location for purposes of localizing items such as currency, date time format, numerical representations, and so on.\nA locale value is a concatenation of the ISO 639-1 two-letter language code, an underscore, and the ISO 3166-1 two-letter country code. For example, en_US specifies the language English and country US. This value is `en_US` by default.", + "type": "string" + }, + "login": { + "description": "The unique identifier for the user (`username`). For validation, see [Login pattern validation](https://developer.okta.com/docs/reference/api/schemas/#login-pattern-validation).\n\nEvery user within your Okta org must have a unique identifier for a login. This constraint applies to all users you import from other systems or applications such as Active Directory. Your organization is the top-level namespace to mix and match logins from all your connected applications or directories. Careful consideration of naming conventions for your login identifier will make it easier to onboard new applications in the future.\n\nLogins are not considered unique if they differ only in case and/or diacritical marks. If one of your users has a login of `Isaac.Brock@example.com`, there cannot be another user whose login is `isaac.brock@example.com`, nor `is\u00e1\u00e0c.br\u00f6ck@example.com`.\n\nOkta has a default ambiguous name resolution policy for usernames that include @-signs. By default, usernames must be formatted as email addresses and thus always include @-signs. You can remove that restriction using either the Admin Console or the [Schemas API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/). Users can sign in with their non-qualified short name (for example: `isaac.brock` with username `isaac.brock@example.com`) as long as the short name is still unique within the org.", + "maxLength": 100, + "minLength": 5, + "type": "string" + }, + "manager": { + "description": "The `displayName` of the user's manager", + "nullable": true, + "type": "string" + }, + "managerId": { + "description": "The `id` of the user's manager", + "nullable": true, + "type": "string" + }, + "middleName": { + "description": "The middle name of the user", + "nullable": true, + "type": "string" + }, + "mobilePhone": { + "description": "The mobile phone number of the user", + "maxLength": 100, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "nickName": { + "description": "The casual way to address the user in real life", + "nullable": true, + "type": "string" + }, + "organization": { + "description": "Name of the the user's organization", + "nullable": true, + "type": "string" + }, + "postalAddress": { + "description": "Mailing address component of the user's address", + "maxLength": 4096, + "nullable": true, + "type": "string" + }, + "preferredLanguage": { + "description": "The user's preferred written or spoken language. For validation, see [RFC 7231 Section 5.3.5](https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.5).", + "nullable": true, + "type": "string" + }, + "primaryPhone": { + "description": "The primary phone number of the user such as a home number", + "maxLength": 100, + "minLength": 0, + "nullable": true, + "type": "string" + }, + "profileUrl": { + "description": "The URL of the user's online profile. For example, a web page. See [URL](https://datatracker.ietf.org/doc/html/rfc1808).", + "nullable": true, + "type": "string" + }, + "secondEmail": { + "description": "The secondary email address of the user typically used for account recovery. For validation, see [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3).", + "format": "email", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "state": { + "description": "The state or region component of the user's address (`region`)", + "maxLength": 128, + "nullable": true, + "type": "string" + }, + "streetAddress": { + "description": "The full street address component of the user's address", + "maxLength": 1024, + "nullable": true, + "type": "string" + }, + "timezone": { + "description": "The user's time zone", + "nullable": true, + "type": "string" + }, + "title": { + "description": "The user's title, such as Vice President", + "nullable": true, + "type": "string" + }, + "userType": { + "description": "The property used to describe the organization-to-user relationship, such as employee or contractor\n\n> **Note:** The `userType` property is a standard string attribute and should be treated as a descriptive label rather than a functional setting. Unlike a user's assigned user [`type`](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#tag/User/operation/createUser!path=type&t=request), this property is purely informational and doesn't influence the behavior of the Okta platform.", + "nullable": true, + "type": "string" + }, + "zipCode": { + "description": "The ZIP code or postal code component of the user's address (`postalCode`)", + "maxLength": 50, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "UserProvisioningApplicationFeature": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationFeature" + }, + { + "type": "object" + }, + { + "properties": { + "capabilities": { + "$ref": "#/components/schemas/CapabilitiesObject" + } + } + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserRequestSchema": { + "properties": { + "externalId": { + "description": "The external ID of the user in the identity source", + "maxLength": 512, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/IdentitySourceUserProfileForUpsertRequired" + } + }, + "type": "object" + }, + "UserResourceHrefObject": { + "properties": { + "href": { + "description": "Link URI", + "example": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7", + "type": "string" + }, + "title": { + "description": "Link name", + "example": "SAML Jackson", + "type": "string" + } + }, + "type": "object" + }, + "UserResponseSchema": { + "properties": { + "created": { + "description": "The timestamp when the user was created in the identity source", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "externalId": { + "description": "The external ID of the user in the identity source", + "maxLength": 255, + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the user in the identity source", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "The timestamp when the user was last updated in the identity source", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "profile": { + "$ref": "#/components/schemas/IdentitySourceUserProfileForUpsert" + } + }, + "type": "object" + }, + "UserRiskGetResponse": { + "discriminator": { + "mapping": { + "HIGH": "#/components/schemas/UserRiskLevelExists", + "LOW": "#/components/schemas/UserRiskLevelExists", + "MEDIUM": "#/components/schemas/UserRiskLevelExists", + "NONE": "#/components/schemas/UserRiskLevelNone" + }, + "propertyName": "riskLevel" + }, + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "$ref": "#/components/schemas/LinksUserRef" + } + ] + }, + "riskLevel": { + "$ref": "#/components/schemas/UserRiskLevelAll" + } + }, + "type": "object" + }, + "UserRiskLevelAll": { + "description": "The risk level associated with the user", + "enum": [ + "HIGH", + "LOW", + "MEDIUM", + "NONE" + ], + "type": "string" + }, + "UserRiskLevelExists": { + "allOf": [ + { + "$ref": "#/components/schemas/UserRiskGetResponse" + }, + { + "properties": { + "reason": { + "$ref": "#/components/schemas/UserRiskReason" + } + }, + "type": "object" + } + ] + }, + "UserRiskLevelNone": { + "allOf": [ + { + "$ref": "#/components/schemas/UserRiskGetResponse" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserRiskLevelPut": { + "description": "The risk level associated with the user", + "enum": [ + "HIGH", + "LOW", + "MEDIUM" + ], + "type": "string" + }, + "UserRiskPutResponse": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "$ref": "#/components/schemas/LinksUserRef" + } + ] + }, + "reason": { + "$ref": "#/components/schemas/UserRiskReason" + }, + "riskLevel": { + "$ref": "#/components/schemas/UserRiskLevelPut" + } + }, + "type": "object" + }, + "UserRiskReason": { + "description": "The reason for the user's current risk level. Defaults to `override.by.admin` when set by an admin without a custom reason.", + "example": "override.by.admin", + "type": "string" + }, + "UserRiskRequest": { + "properties": { + "riskLevel": { + "description": "The risk level associated with the user", + "enum": [ + "HIGH", + "MEDIUM", + "LOW" + ], + "type": "string" + }, + "riskReason": { + "description": "The reason for the risk change. If not provided, the reason defaults to `override.by.admin`. Only alphanumeric characters, spaces, hyphens, commas, and periods are allowed.", + "maxLength": 500, + "pattern": "^[a-zA-Z0-9\\s\\-,.]*$", + "type": "string" + } + }, + "required": [ + "riskLevel" + ], + "type": "object" + }, + "UserSchema": { + "properties": { + "$schema": { + "description": "JSON schema version identifier", + "readOnly": true, + "type": "string" + }, + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "created": { + "description": "Timestamp when the schema was created", + "readOnly": true, + "type": "string" + }, + "definitions": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaDefinitions" + } + ], + "description": "User profile subschemas\n\nThe profile object for a user is defined by a composite schema of base and custom properties using a JSON path to reference subschemas. The `#base` properties are defined and versioned by Okta, while `#custom` properties are extensible. Custom property names for the profile object must be unique and can't conflict with a property name defined in the `#base` subschema." + }, + "id": { + "description": "URI of user schema", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp when the schema was last updated", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the schema", + "readOnly": true, + "type": "string" + }, + "properties": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaProperties" + } + ], + "description": "User Object Properties" + }, + "title": { + "description": "User-defined display name for the schema", + "type": "string" + }, + "type": { + "description": "Type of [root schema](https://tools.ietf.org/html/draft-zyp-json-schema-04#section-3.4)", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserSchemaAttribute": { + "properties": { + "default": { + "description": "If specified, assigns the value as the default value for the custom attribute. This is a nullable property. If you don't specify a value for this custom attribute during user creation or update, the `default` is used instead of setting the value to `null` or empty.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "boolean" + }, + { + "type": "integer" + }, + { + "type": "array" + }, + { + "type": "object" + }, + { + "type": "number" + } + ] + }, + "description": { + "description": "Description of the property", + "type": "string" + }, + "enum": { + "description": "Enumerated value of the property.\n\nThe value of the property is limited to one of the values specified in the enum definition. The list of values for the enum must consist of unique elements.", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, + "nullable": true, + "type": "array" + }, + "externalName": { + "description": "Name of the property as it exists in an external application\n\n**NOTE**: When you add a custom property, only Identity Provider app user schemas require `externalName` to be\nincluded in the request body. If an existing custom Identity Provider app user schema property has an empty\n`externalName`, requests aren't allowed to update other properties until the `externalName` is defined.", + "type": "string" + }, + "externalNamespace": { + "description": "Namespace from the external application", + "type": "string" + }, + "format": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttributeFormat" + } + ], + "description": "Identifies the type of data represented by the string" + }, + "master": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttributeMaster" + } + ], + "description": "Identifies where the property is mastered" + }, + "maxLength": { + "description": "Maximum character length of a string property", + "nullable": true, + "type": "integer" + }, + "minLength": { + "description": "Minimum character length of a string property", + "nullable": true, + "type": "integer" + }, + "mutability": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttributeMutabilityString" + } + ], + "description": "Defines the mutability of the property" + }, + "oneOf": { + "description": "Non-empty array of valid JSON schemas.\n\nThe `oneOf` key is only supported in conjunction with `enum` and provides a mechanism to return a display name for the `enum` value.<br>\nEach schema has the following format:\n\n```\n{\n \"const\": \"enumValue\",\n \"title\": \"display name\"\n}\n```\n\nWhen `enum` is used in conjunction with `oneOf`, you must keep the set of enumerated values and their order.<br>\nFor example:\n\n```\n\"enum\": [\"S\",\"M\",\"L\",\"XL\"],\n\"oneOf\": [\n {\"const\": \"S\", \"title\": \"Small\"},\n {\"const\": \"M\", \"title\": \"Medium\"},\n {\"const\": \"L\", \"title\": \"Large\"},\n {\"const\": \"XL\", \"title\": \"Extra Large\"}\n ]\n```", + "items": { + "$ref": "#/components/schemas/UserSchemaAttributeEnum" + }, + "nullable": true, + "type": "array" + }, + "pattern": { + "description": "For `string` property types, specifies the regular expression used to validate the property", + "type": "string" + }, + "permissions": { + "description": "Access control permissions for the property", + "items": { + "$ref": "#/components/schemas/UserSchemaAttributePermission" + }, + "nullable": true, + "type": "array" + }, + "required": { + "description": "Determines whether the property is required", + "nullable": true, + "type": "boolean" + }, + "scope": { + "$ref": "#/components/schemas/UserSchemaAttributeScope" + }, + "title": { + "description": "User-defined display name for the property", + "minLength": 1, + "type": "string" + }, + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttributeType" + } + ], + "description": "Type of property" + }, + "unique": { + "description": "Determines whether property values must be unique", + "nullable": true, + "type": "boolean" + } + }, + "type": "object", + "x-okta-allow-null-property-value-for-updates": true, + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserSchemaAttributeEnum": { + "properties": { + "const": { + "description": "The enumerated value", + "type": "string" + }, + "title": { + "description": "The display label for the enumerated value", + "type": "string" + } + }, + "type": "object" + }, + "UserSchemaAttributeFormat": { + "enum": [ + "country-code", + "date-time", + "email", + "encrypted", + "hashed", + "language-code", + "locale", + "ref-id", + "timezone", + "uri" + ], + "type": "string" + }, + "UserSchemaAttributeItems": { + "properties": { + "enum": { + "items": { + "type": "string" + }, + "type": "array" + }, + "oneOf": { + "items": { + "$ref": "#/components/schemas/UserSchemaAttributeEnum" + }, + "type": "array" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "UserSchemaAttributeMaster": { + "nullable": true, + "properties": { + "priority": { + "items": { + "$ref": "#/components/schemas/UserSchemaAttributeMasterPriority" + }, + "type": "array" + }, + "type": { + "$ref": "#/components/schemas/UserSchemaAttributeMasterType" + } + }, + "type": "object" + }, + "UserSchemaAttributeMasterPriority": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "UserSchemaAttributeMasterType": { + "enum": [ + "OKTA", + "OVERRIDE", + "PROFILE_MASTER" + ], + "type": "string" + }, + "UserSchemaAttributeMutabilityString": { + "enum": [ + "IMMUTABLE", + "READ_ONLY", + "READ_WRITE", + "WRITE_ONLY" + ], + "type": "string" + }, + "UserSchemaAttributePermission": { + "properties": { + "action": { + "description": "Determines whether the principal can view or modify the property", + "type": "string" + }, + "principal": { + "description": "Security principal", + "type": "string" + } + }, + "type": "object" + }, + "UserSchemaAttributeScope": { + "enum": [ + "NONE", + "SELF" + ], + "type": "string" + }, + "UserSchemaAttributeType": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "string" + ], + "type": "string" + }, + "UserSchemaBase": { + "description": "All Okta-defined profile properties are defined in a profile subschema with the resolution scope `#base`. You can't modify these properties, except to update permissions, to change the nullability of `firstName` and `lastName`, or to specify a pattern for `login`. They can't be removed.\n\nThe base user profile is based on the [System for Cross-domain Identity Management: Core Schema](https://tools.ietf.org/html/draft-ietf-scim-core-schema-22#section-4.1.1) and has the standard properties detailed below.", + "properties": { + "id": { + "description": "The subschema name", + "readOnly": true, + "type": "string" + }, + "properties": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaBaseProperties" + } + ], + "description": "The `#base` object properties" + }, + "required": { + "description": "A collection indicating required property names", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "type": { + "description": "The object type", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserSchemaBaseProperties": { + "properties": { + "city": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "City or locality component of the user's address (`locality`)" + }, + "costCenter": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Name of a cost center assigned to the user" + }, + "countryCode": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Country name component of the user's address (`country`.) This property uses [ISO 3166-1 alpha 2 \"short\" code format](https://tools.ietf.org/html/draft-ietf-scim-core-schema-22#ref-ISO3166)." + }, + "department": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Name of the user's department" + }, + "displayName": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Name of the user, suitable for display to end users" + }, + "division": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Name of the user's division" + }, + "email": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Primary email address of the user. This property is formatted according to [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3)." + }, + "employeeNumber": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Organization or company assigned unique identifier for the user" + }, + "firstName": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Given name of the user (`givenName`)" + }, + "honorificPrefix": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Honorific prefix(es) of the user or title in most Western languages" + }, + "honorificSuffix": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Honorific suffix(es) of the user" + }, + "lastName": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Family name of the user (`familyName`)" + }, + "locale": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "User's default location for purposes of localizing items such as currency, date time format, numerical representations, and so on.\n\nA locale value is a concatenation of the ISO 639-1 two-letter language code, an underscore, and the ISO 3166-1 two-letter country code. For example: `en_US` specifies the language English and country US. This value is `en_US` by default." + }, + "login": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Unique identifier for the user (`userName`)\n\nThe login property is validated according to its pattern attribute, which is a string. By default, the attribute is null. When the attribute is null, the username is required to be formatted as an email address as defined by [RFC 6531 Section 3.3](http://tools.ietf.org/html/rfc6531#section-3.3). The pattern can be set through the API to one of the following forms. (The Admin Console provides access to the same forms.)\n * A login pattern of `\".+\"` indicates that there is no restriction on usernames. Any non-empty, unique value is permitted, and the minimum length of five isn't enforced. In this case, usernames don't need to include the `@` character. If a name does include `@`, the portion ahead of the `@` can be used for logging in, provided it identifies a unique user within the org.\n * A login pattern of the form `\"[...]+\"` indicates that usernames must only contain characters from the set given between the brackets. The enclosing brackets and final `+` are required for this form. Character ranges can be indicated using hyphens. To include the hyphen itself in the allowed set, the hyphen must appear first. Any characters in the set except the hyphen, a-z, A-Z, and 0-9 must be preceded by a backslash (`\\`). For example, `\"[a-z13579\\.]+\"` would restrict usernames to lowercase letters, odd digits, and periods, while `\"[-a-zA-Z0-9]+\"` would allow basic alphanumeric characters and hyphens." + }, + "manager": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "The `displayName` of the user's manager" + }, + "managerId": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "The `id` of the user's manager" + }, + "middleName": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Middle name(s) of the user" + }, + "mobilePhone": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Mobile phone number of the user" + }, + "nickName": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Casual way to address the user in real life" + }, + "organization": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Name of the user's organization" + }, + "postalAddress": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Mailing address component of the user's address" + }, + "preferredLanguage": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "User's preferred written or spoken languages. This property is formatted according to [RFC 7231 Section 5.3.5](https://tools.ietf.org/html/rfc7231#section-5.3.5)." + }, + "primaryPhone": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Primary phone number of the user, such as home number" + }, + "profileUrl": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "URL of the user's online profile (for example, a web page.) This property is formatted according to the [Relative Uniform Resource Locators specification](https://tools.ietf.org/html/draft-ietf-scim-core-schema-22#ref-ISO3166)." + }, + "secondEmail": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Secondary email address of the user typically used for account recovery. This property is formatted according to [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3)." + }, + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "State or region component of the user's address (`region`)" + }, + "streetAddress": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Full street address component of the user's address" + }, + "timezone": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "User's time zone. This property is formatted according to the [IANA Time Zone database format](https://tools.ietf.org/html/rfc6557)." + }, + "title": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "User's title, such as \"Vice President\"" + }, + "userType": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "Used to describe the organization to the user relationship such as \"Employee\" or \"Contractor\".\n\n**Note:** The `userType` field is an arbitrary string value and isn't related to the newer [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature." + }, + "zipCode": { + "allOf": [ + { + "$ref": "#/components/schemas/UserSchemaAttribute" + } + ], + "description": "ZIP code or postal code component of the user's address (`postalCode`)" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserSchemaDefinitions": { + "properties": { + "base": { + "$ref": "#/components/schemas/UserSchemaBase" + }, + "custom": { + "$ref": "#/components/schemas/UserSchemaPublic" + } + }, + "type": "object" + }, + "UserSchemaProperties": { + "properties": { + "profile": { + "$ref": "#/components/schemas/UserSchemaPropertiesProfile" + } + }, + "type": "object" + }, + "UserSchemaPropertiesProfile": { + "properties": { + "allOf": { + "items": { + "$ref": "#/components/schemas/UserSchemaPropertiesProfileItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "UserSchemaPropertiesProfileItem": { + "properties": { + "$ref": { + "type": "string" + } + }, + "type": "object" + }, + "UserSchemaPublic": { + "description": "All custom profile properties are defined in a profile subschema with the resolution scope `#custom`.\n\n> **Notes:** \n> * When you refer to custom profile attributes that differ only by case, name collisions occur. This includes naming custom profile attributes the same as base profile attributes, for example, `firstName` and `FirstName`.\n> * Certain attributes are reserved and can't be used for custom user profiles. See [Review reserved attributes](https://help.okta.com/okta_help.htm?type=oie&id=reserved-attributes).", + "properties": { + "id": { + "description": "The subschema name", + "readOnly": true, + "type": "string" + }, + "properties": { + "additionalProperties": { + "$ref": "#/components/schemas/UserSchemaAttribute" + }, + "description": "The `#custom` object properties", + "type": "object" + }, + "required": { + "description": "A collection indicating required property names", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "type": { + "description": "The object type", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UserStatus": { + "description": "The current status of the user.\n\nThe status of a user changes in response to explicit events, such as admin-driven lifecycle changes, user login, or self-service password recovery. Okta doesn't asynchronously sweep through users and update their password expiry state, for example. Instead, Okta evaluates password policy at login time, notices the password has expired, and moves the user to the expired state. When running reports, remember that the data is valid as of the last login or lifecycle event for that user.\n\n> **Note:** The `ACTIVATING` status is a transitional status that occurs when a user is being activated but hasn't completed the activation process. This status isn't directly settable through the API, nor should you use it for any of your user management workflows.", + "enum": [ + "ACTIVE", + "DEPROVISIONED", + "LOCKED_OUT", + "PASSWORD_EXPIRED", + "PROVISIONED", + "RECOVERY", + "STAGED", + "SUSPENDED" + ], + "readOnly": true, + "type": "string" + }, + "UserStatusPolicyRuleCondition": { + "properties": { + "value": { + "$ref": "#/components/schemas/PolicyUserStatus" + } + }, + "type": "object" + }, + "UserType": { + "properties": { + "_links": { + "$ref": "#/components/schemas/UserTypeLinks" + }, + "created": { + "description": "A timestamp from when the user type was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "The user ID of the account that created the user type", + "readOnly": true, + "type": "string" + }, + "default": { + "description": "A boolean value to indicate if this is the default user type", + "readOnly": true, + "type": "boolean" + }, + "description": { + "description": "The human-readable description of the user type", + "type": "string" + }, + "displayName": { + "description": "The human-readable name of the user type", + "type": "string" + }, + "id": { + "description": "The unique key for the user type", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "A timestamp from when the user type was most recently updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastUpdatedBy": { + "description": "The user ID of the most recent account to edit the user type", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the user type. The name must start with A-Z or a-z and contain only A-Z, a-z, 0-9, or underscore (_) characters. This value becomes read-only after creation and can't be updated.", + "type": "string" + } + }, + "required": [ + "name", + "displayName" + ], + "type": "object" + }, + "UserTypeCondition": { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle> Specifies which user types to include and/or exclude", + "properties": { + "exclude": { + "description": "The user types to exclude", + "items": { + "type": "string" + }, + "type": "array" + }, + "include": { + "description": "The user types to include", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude", + "include" + ] + }, + "UserTypeLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "The associated schema" + } + ] + } + }, + "type": "object" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UserTypePostRequest": { + "properties": { + "description": { + "description": "The updated human-readable description of the user type", + "type": "string" + }, + "displayName": { + "description": "The updated human-readable display name for the user type", + "type": "string" + } + }, + "type": "object" + }, + "UserTypePutRequest": { + "properties": { + "description": { + "description": "The human-readable description of the user type", + "type": "string" + }, + "displayName": { + "description": "The human-readable name of the user type", + "type": "string" + }, + "name": { + "description": "The name of the existing type", + "type": "string" + } + }, + "required": [ + "name", + "displayName", + "description" + ], + "type": "object" + }, + "UserVerificationEnum": { + "description": "User verification settings. Possible values `DISCOURAGED` (the authenticator isn't asked to perform user verification, but may do so at its discretion), `PREFERRED` (the client uses an authenticator capable of user verification if possible), or `REQUIRED` (the client uses only an authenticator capable of user verification)", + "enum": [ + "DISCOURAGED", + "PREFERRED", + "REQUIRED" + ], + "type": "string" + }, + "UserVerificationEnumEnrollment": { + "description": "User verification settings for enrollment.\n\nThis setting controls the user verification requirement during the enrollment of a new credential. It determines whether the authenticator requires verification when a user is registering their device or credential.", + "enum": [ + "DISCOURAGED", + "PREFERRED", + "REQUIRED" + ], + "type": "string", + "x-enumDescriptions": { + "DISCOURAGED": "The authenticator isn't asked to perform user verification, but may do so at its discretion.", + "PREFERRED": "The client uses an authenticator capable of user verification if possible.", + "REQUIRED": "The client uses only an authenticator capable of user verification." + } + }, + "UserVerificationEnumForVerify": { + "description": "User verification settings for verification. This setting controls the user verification requirement during authentication (verification). It determines whether the authenticator requires user verification when a user signs in with an already-registered credential.\n\nFor verification, the value defaults to `PREFERRED`, unless the enrollment setting is `REQUIRED`. If the enrollment setting is `REQUIRED` for the authenticator, then the verification setting is also implicitly `REQUIRED`.", + "enum": [ + "DISCOURAGED", + "PREFERRED", + "REQUIRED" + ], + "type": "string", + "x-enumDescriptions": { + "DISCOURAGED": "The authenticator isn't asked to perform user verification, but may do so at its discretion.", + "PREFERRED": "The client uses an authenticator capable of user verification if possible.", + "REQUIRED": "The client uses only an authenticator capable of user verification." + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "UsersLink": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the [Application Users](/openapi/okta-management/management/applicationusers#tag/ApplicationUsers/operation/listApplicationUsers) resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "UsersUpdateRequestSchema": { + "properties": { + "profile": { + "$ref": "#/components/schemas/IdentitySourceUserProfileForUpsertRequired" + } + }, + "type": "object" + }, + "ValidationDetail": { + "description": "Validation detail", + "properties": { + "id": { + "description": "Action identifier", + "example": "okta:action1", + "type": "string" + }, + "provider": { + "$ref": "#/components/schemas/WorkflowsValidationDetailProvider" + } + }, + "required": [ + "id", + "provider" + ], + "type": "object" + }, + "ValidationDetailProvider": { + "description": "Action provider validation details", + "discriminator": { + "mapping": { + "WORKFLOWS": "#/components/schemas/WorkflowsValidationDetailProvider" + }, + "propertyName": "type" + }, + "properties": { + "externalId": { + "description": "The unique identifier of the action flow in the provider system", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ActionProviderPayloadType" + } + }, + "required": [ + "type", + "externalId" + ], + "type": "object" + }, + "VerificationMethod": { + "description": "The method used to verify a user", + "discriminator": { + "mapping": { + "ASSURANCE": "#/components/schemas/AssuranceMethod", + "AUTH_METHOD_CHAIN": "#/components/schemas/AuthenticationMethodChainMethod", + "ID_PROOFING": "#/components/schemas/IdProofingMethod" + }, + "propertyName": "type" + }, + "properties": { + "type": { + "$ref": "#/components/schemas/PolicyRuleVerificationMethodType" + } + }, + "type": "object" + }, + "Version": { + "description": "The version specified as a [Semantic Version](https://semver.org/). This value can be a wildcard (`*`), a major version range (for example, `^2`), a major-only version (for example, `7`), or a specific `Major.Minor` version (for example, `5.15`).", + "pattern": "^(?:\\*|\\^?\\d+(?:\\.\\d+){0,2})$", + "type": "string" + }, + "WebAuthnAttachmentEnum": { + "description": "Method attachment", + "enum": [ + "ANY", + "BUILT_IN", + "ROAMING" + ], + "type": "string" + }, + "WebAuthnCredRequest": { + "description": "Credential request object for the initialized credential, along with the enrollment and key identifiers to associate with the credential", + "properties": { + "authenticatorEnrollmentId": { + "description": "ID for a WebAuthn preregistration factor in Okta", + "type": "string" + }, + "credRequestJwe": { + "description": "Encrypted JWE of credential request for the fulfillment provider", + "type": "string" + }, + "keyId": { + "description": "ID for the Okta response key-pair used to encrypt and decrypt credential requests and responses", + "type": "string" + } + }, + "type": "object" + }, + "WebAuthnCredResponse": { + "description": "Credential response object for enrolled credential details, along with enrollment and key identifiers to associate the credential", + "properties": { + "authenticatorEnrollmentId": { + "description": "ID for a WebAuthn preregistration factor in Okta", + "type": "string" + }, + "credResponseJwe": { + "description": "Encrypted JSON Web Encryption (JWE) of the credential response from the fulfillment provider", + "type": "string" + } + }, + "type": "object" + }, + "WebAuthnPreregistrationFactor": { + "description": "User factor variant used for WebAuthn preregistration factors", + "properties": { + "_links": { + "$ref": "#/components/schemas/LinksSelf" + }, + "created": { + "description": "Timestamp indicating when the factor was enrolled", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "factorType": { + "$ref": "#/components/schemas/UserFactorType" + }, + "id": { + "description": "ID of the factor", + "readOnly": true, + "type": "string" + }, + "lastUpdated": { + "description": "Timestamp indicating when the factor was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "profile": { + "description": "Specific attributes related to the factor", + "type": "object" + }, + "provider": { + "$ref": "#/components/schemas/UserFactorProvider" + }, + "status": { + "$ref": "#/components/schemas/UserFactorStatus" + }, + "vendorName": { + "description": "Name of the factor vendor. This is usually the same as the provider.", + "example": "OKTA", + "readOnly": true, + "type": "string" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "WebAuthnRpId": { + "description": "The [RP ID](https://www.w3.org/TR/webauthn/#relying-party-identifier) object for WebAuthn configuration\n\n> **Note:** Changing the RP ID `domain` invalidates all existing passkeys for all users. You must notify your users that they need to re-enroll their passkeys if you replace an existing RP ID.", + "properties": { + "domain": { + "$ref": "#/components/schemas/WebAuthnRpIdDomain" + }, + "enabled": { + "default": false, + "description": "Indicates whether the RP ID is active and is used for WebAuthn operations. It can only be set to `true` once the `validationStatus` of the `domain` object is `VERIFIED`. `enabled` can only be `true` for this same `domain`. Its value must be `false` to be able to configure the `domain`.", + "type": "boolean" + } + }, + "type": "object", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "WebAuthnRpIdDomain": { + "description": "The RP domain object for the WebAuthn configuration", + "properties": { + "dnsRecord": { + "allOf": [ + { + "readOnly": true + }, + { + "$ref": "#/components/schemas/DNSRecordAuthenticators" + } + ] + }, + "name": { + "description": "The [RP ID](https://www.w3.org/TR/webauthn/#relying-party-identifier) domain value to be used for all WebAuthn operations.\n\nIf it isn't specified, the `domain` object isn't included in the request, and the domain value defaults to the domain of the current page (the domain of your org or a custom domain, for example).\n\n> **Note:** If you don't use a custom RP ID (the default behavior), the domain value defaults to the end user's current page. The domain value defaults to the full domain name of the page that the end user is on when they're attempting the WebAuthn credential operation (enrollment or verification).", + "example": "mycustomdomain.com", + "type": "string" + }, + "validationStatus": { + "description": "Indicates the validation status of the domain", + "enum": [ + "NOT_STARTED", + "IN_PROGRESS", + "VERIFIED", + "ERROR" + ], + "readOnly": true, + "type": "string", + "x-enumDescriptions": { + "ERROR": "There was an error during the verification process. This isn't a terminal state and can be resolved by correcting the DNS record and retrying the verification.", + "IN_PROGRESS": "The verification process is ongoing. This is a transient state that occurs only when the domain name is actively being checked by the server.", + "NOT_STARTED": "The domain hasn't been verified yet. When configuring a registrable domain name of an existing brand custom domain, the `validationStatus` is initially returned as `NOT_STARTED`. This indicates that verification is required.", + "VERIFIED": "The domain has been successfully verified. When configuring the domain name to the default Okta org domain or the fully qualified domain name of an existing custom brand domain, the `validationStatus` is immediately returned as `VERIFIED`. No additional verification is required." + } + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "WebAuthnSettingAllowSyncablePasskeys": { + "default": true, + "description": "Indicates whether syncable passkeys are allowed. When enabled, users can register passkeys that are synchronized across their devices by using platform-specific mechanisms (such as iCloud Keychain for Apple devices or Google Password Manager for Android devices).", + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "WebAuthnSettingCertBasedAttestationValidation": { + "default": false, + "description": "Indicates whether certificate-based attestation validation is enabled. When enabled, the authenticator's attestation certificate is validated against known root certificates (custom AAGUIDs with associated certificates or the [FIDO Metadata Service](https://fidoalliance.org/metadata/)) to ensure its validity.", + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "WebAuthnSettingEnableAutofillUI": { + "default": false, + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle></x-lifecycle-container>Enables the passkeys autofill UI to display available WebAuthn discoverable credentials (\"resident key\") from the Sign-In Widget username field", + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "WebAuthnSettingFipsCompliant": { + "default": false, + "description": "Indicates whether the authenticator is required to be [Federal Information Processing Standards (FIPS)](https://csrc.nist.gov/glossary/term/federal_information_processing_standard) compliant", + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "WebAuthnSettingHardwareProtected": { + "default": false, + "description": "Indicates whether the authenticator is required to store the private key on a hardware component", + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "WebAuthnSettingResidentKeyRequirement": { + "default": "REQUIRED", + "description": "Resident key requirement setting. Okta recommends using only `REQUIRED` or `DISCOURAGED` to make the requirement preference explicit. Using `PREFERRED` can sometimes lead to unpredictable behavior depending on the client platform and authenticator capabilities.", + "enum": [ + "DISCOURAGED", + "PREFERRED", + "REQUIRED" + ], + "type": "string", + "x-enumDescriptions": { + "DISCOURAGED": "The authenticator is requested to create a server-side credential, but may create a client-side discoverable credential at its discretion.", + "PREFERRED": "The authenticator is requested to create a client-side discoverable credential, but may create a server-side non-discoverable credential at its discretion.", + "REQUIRED": "The authenticator is required to create a client-side discoverable credential, and the operation fails if the authenticator is unable to do so." + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "WebAuthnSettingShowSignInWithAPasskeyButton": { + "default": false, + "description": "Indicates if the **Sign in with a Passkey** button on the Sign-In Widget is shown.", + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "WellKnownAppAuthenticatorConfiguration": { + "properties": { + "appAuthenticatorEnrollEndpoint": { + "description": "The authenticator enrollment endpoint", + "type": "string" + }, + "authenticatorId": { + "description": "The unique identifier of the app authenticator", + "type": "string" + }, + "createdDate": { + "description": "Timestamp when the authenticator was created", + "format": "date-time", + "type": "string" + }, + "key": { + "$ref": "#/components/schemas/AuthenticatorKeyEnum" + }, + "lastUpdated": { + "description": "Timestamp when the authenticator was last modified", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The authenticator display name", + "type": "string" + }, + "orgId": { + "description": "The `id` of the Okta Org", + "type": "string" + }, + "settings": { + "properties": { + "userVerification": { + "$ref": "#/components/schemas/CustomAppUserVerificationEnum" + } + }, + "type": "object" + }, + "supportedMethods": { + "items": { + "$ref": "#/components/schemas/SupportedMethods" + }, + "type": "array" + }, + "type": { + "description": "The type of authenticator", + "enum": [ + "app" + ], + "type": "string" + } + }, + "type": "object" + }, + "WellKnownOrgMetadata": { + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for this object using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "properties": { + "alternate": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the custom domain org URL" + } + ] + }, + "organization": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the org URL" + } + ] + } + }, + "readOnly": true, + "type": "object" + }, + "id": { + "description": "Org unique identifier", + "type": "string" + }, + "pipeline": { + "$ref": "#/components/schemas/PipelineType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "WellKnownSSFMetadata": { + "description": "Metadata about Okta as a transmitter and relevant information for configuration.", + "properties": { + "authorization_schemes": { + "description": "An array of JSON objects that specify the authorization scheme properties supported by the transmitter", + "items": { + "$ref": "#/components/schemas/WellKnownSSFMetadataSpecUrn" + }, + "type": "array" + }, + "configuration_endpoint": { + "description": "The URL of the SSF stream configuration endpoint", + "example": "https://{yourOktaDomain}/api/v1/ssf/stream", + "format": "uri", + "type": "string" + }, + "default_subjects": { + "description": "A string that indicates the default behavior of newly created streams", + "enum": [ + "ALL", + "NONE" + ], + "type": "string", + "x-enumDescriptions": { + "ALL": "Indicates that any subjects that are appropriate for the stream are added to the stream by default.", + "NONE": "Indicates that no subjects are added by default" + } + }, + "delivery_methods_supported": { + "description": "An array of supported SET delivery methods", + "example": [ + "https://schemas.openid.net/secevent/risc/delivery-method/push", + "urn:ietf:rfc:8935" + ], + "items": { + "format": "uri", + "type": "string" + }, + "type": "array" + }, + "issuer": { + "description": "The issuer used in security event tokens. This value is set as `iss` in the claim.", + "example": "https://{yourOktaDomain}", + "type": "string" + }, + "jwks_uri": { + "description": "The URL of the JSON Web Key Set (JWKS) that contains the signing keys for validating the signatures of security event tokens (SETs)", + "example": "https://{yourOktaDomain}/oauth2/v1/keys", + "format": "uri", + "type": "string" + }, + "spec_version": { + "description": "The version identifying the implementer's draft or final specification implemented by the transmitter", + "example": "1_0-ID3", + "type": "string" + }, + "verification_endpoint": { + "description": "The URL of the SSF stream verification endpoint", + "example": "https://{yourOktaDomain}/api/v1/ssf/stream/verification", + "format": "uri", + "type": "string" + } + }, + "title": "Shared signals framework metadata", + "type": "object" + }, + "WellKnownSSFMetadataSpecUrn": { + "properties": { + "spec_urn": { + "description": "The URN that describes the specification of the protocol being used", + "example": "urn:ietf:rfc:6749", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "WellKnownURIArrayResponse": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "self": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + }, + "representation": { + "description": "The well-known URI content in a JSON array of objects format", + "type": "array" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "WellKnownURIObjectResponse": { + "properties": { + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "self": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + }, + "representation": { + "description": "The well-known URI content in JSON format", + "type": "object" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "WellKnownURIRequest": { + "properties": { + "representation": { + "description": "The well-known URI content in JSON object format", + "type": "object" + } + }, + "required": [ + "representation" + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "WellKnownURIsRoot": { + "properties": { + "_embedded": { + "properties": { + "apple-app-site-association": { + "description": "Contains the customized well-known URI content and links", + "properties": { + "customized": { + "$ref": "#/components/schemas/WellKnownURIObjectResponse" + } + }, + "type": "object" + }, + "assetlinks.json": { + "description": "Contains the customized well-known URI content and links", + "properties": { + "customized": { + "$ref": "#/components/schemas/WellKnownURIArrayResponse" + } + }, + "type": "object" + }, + "webauthn": { + "description": "Contains the customized well-known URI content and links", + "properties": { + "customized": { + "$ref": "#/components/schemas/WellKnownURIObjectResponse" + } + }, + "type": "object" + } + }, + "readOnly": true, + "type": "object" + }, + "_links": { + "allOf": [ + { + "$ref": "#/components/schemas/LinksSelf" + }, + { + "properties": { + "apple-app-site-association": { + "$ref": "#/components/schemas/HrefObject" + }, + "assetlinks.json": { + "$ref": "#/components/schemas/HrefObject" + }, + "webauthn": { + "$ref": "#/components/schemas/HrefObject" + } + } + } + ] + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "WidgetConfigurationI18n": { + "additionalProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "description": "Internationalization overrides. Keys are locale codes (e.g. \"en\", \"ja\", \"fr\"), values are objects mapping i18n keys to string overrides.", + "type": "object" + }, + "WidgetConfigurationThemeTokens": { + "additionalProperties": false, + "description": "Design tokens for customizing the Sign-In Widget appearance", + "properties": { + "BorderColorDangerControl": { + "type": "string" + }, + "BorderColorDangerDark": { + "type": "string" + }, + "BorderColorDangerLight": { + "type": "string" + }, + "BorderColorDisabled": { + "type": "string" + }, + "BorderColorDisplay": { + "type": "string" + }, + "BorderColorPrimaryControl": { + "type": "string" + }, + "BorderColorPrimaryDark": { + "type": "string" + }, + "BorderRadiusMain": { + "type": "string" + }, + "BorderRadiusTight": { + "type": "string" + }, + "BorderStyleMain": { + "type": "string" + }, + "BorderWidthMain": { + "type": "string" + }, + "FocusOutlineColorPrimary": { + "type": "string" + }, + "FocusOutlineOffsetMain": { + "type": "string" + }, + "FocusOutlineOffsetTight": { + "type": "string" + }, + "FocusOutlineStyle": { + "type": "string" + }, + "FocusOutlineWidthMain": { + "type": "string" + }, + "FocusOutlineWidthTight": { + "type": "string" + }, + "HueBlue100": { + "type": "string" + }, + "HueBlue200": { + "type": "string" + }, + "HueBlue300": { + "type": "string" + }, + "HueBlue400": { + "type": "string" + }, + "HueBlue50": { + "type": "string" + }, + "HueBlue500": { + "type": "string" + }, + "HueBlue600": { + "type": "string" + }, + "HueBlue700": { + "type": "string" + }, + "HueBlue800": { + "type": "string" + }, + "HueBlue900": { + "type": "string" + }, + "HueGreen100": { + "type": "string" + }, + "HueGreen200": { + "type": "string" + }, + "HueGreen300": { + "type": "string" + }, + "HueGreen400": { + "type": "string" + }, + "HueGreen50": { + "type": "string" + }, + "HueGreen500": { + "type": "string" + }, + "HueGreen600": { + "type": "string" + }, + "HueGreen700": { + "type": "string" + }, + "HueGreen800": { + "type": "string" + }, + "HueGreen900": { + "type": "string" + }, + "HueNeutral100": { + "type": "string" + }, + "HueNeutral200": { + "type": "string" + }, + "HueNeutral300": { + "type": "string" + }, + "HueNeutral400": { + "type": "string" + }, + "HueNeutral50": { + "type": "string" + }, + "HueNeutral500": { + "type": "string" + }, + "HueNeutral600": { + "type": "string" + }, + "HueNeutral700": { + "type": "string" + }, + "HueNeutral800": { + "type": "string" + }, + "HueNeutral900": { + "type": "string" + }, + "HueNeutralWhite": { + "type": "string" + }, + "HueRed100": { + "type": "string" + }, + "HueRed200": { + "type": "string" + }, + "HueRed300": { + "type": "string" + }, + "HueRed400": { + "type": "string" + }, + "HueRed50": { + "type": "string" + }, + "HueRed500": { + "type": "string" + }, + "HueRed600": { + "type": "string" + }, + "HueRed700": { + "type": "string" + }, + "HueRed800": { + "type": "string" + }, + "HueRed900": { + "type": "string" + }, + "HueYellow100": { + "type": "string" + }, + "HueYellow200": { + "type": "string" + }, + "HueYellow300": { + "type": "string" + }, + "HueYellow400": { + "type": "string" + }, + "HueYellow50": { + "type": "string" + }, + "HueYellow500": { + "type": "string" + }, + "HueYellow600": { + "type": "string" + }, + "HueYellow700": { + "type": "string" + }, + "HueYellow800": { + "type": "string" + }, + "HueYellow900": { + "type": "string" + }, + "PaletteDangerDark": { + "type": "string" + }, + "PaletteDangerDarker": { + "type": "string" + }, + "PaletteDangerHeading": { + "type": "string" + }, + "PaletteDangerHighlight": { + "type": "string" + }, + "PaletteDangerLight": { + "type": "string" + }, + "PaletteDangerLighter": { + "type": "string" + }, + "PaletteDangerMain": { + "type": "string" + }, + "PaletteDangerText": { + "type": "string" + }, + "PalettePrimaryDark": { + "type": "string" + }, + "PalettePrimaryDarker": { + "type": "string" + }, + "PalettePrimaryHeading": { + "type": "string" + }, + "PalettePrimaryHighlight": { + "type": "string" + }, + "PalettePrimaryLight": { + "type": "string" + }, + "PalettePrimaryLighter": { + "type": "string" + }, + "PalettePrimaryMain": { + "type": "string" + }, + "PalettePrimaryText": { + "type": "string" + }, + "PaletteSuccessDark": { + "type": "string" + }, + "PaletteSuccessDarker": { + "type": "string" + }, + "PaletteSuccessHeading": { + "type": "string" + }, + "PaletteSuccessHighlight": { + "type": "string" + }, + "PaletteSuccessLight": { + "type": "string" + }, + "PaletteSuccessLighter": { + "type": "string" + }, + "PaletteSuccessMain": { + "type": "string" + }, + "PaletteSuccessText": { + "type": "string" + }, + "PaletteWarningDark": { + "type": "string" + }, + "PaletteWarningDarker": { + "type": "string" + }, + "PaletteWarningHeading": { + "type": "string" + }, + "PaletteWarningHighlight": { + "type": "string" + }, + "PaletteWarningLight": { + "type": "string" + }, + "PaletteWarningLighter": { + "type": "string" + }, + "PaletteWarningMain": { + "type": "string" + }, + "PaletteWarningText": { + "type": "string" + }, + "Spacing0": { + "type": "string" + }, + "Spacing1": { + "type": "string" + }, + "Spacing2": { + "type": "string" + }, + "Spacing3": { + "type": "string" + }, + "Spacing4": { + "type": "string" + }, + "Spacing5": { + "type": "string" + }, + "Spacing6": { + "type": "string" + }, + "Spacing7": { + "type": "string" + }, + "Spacing8": { + "type": "string" + }, + "Spacing9": { + "type": "string" + }, + "TransitionDurationMain": { + "type": "string" + }, + "TypographyColorAction": { + "type": "string" + }, + "TypographyColorBody": { + "type": "string" + }, + "TypographyColorDanger": { + "type": "string" + }, + "TypographyColorDisabled": { + "type": "string" + }, + "TypographyColorHeading": { + "type": "string" + }, + "TypographyColorInverse": { + "type": "string" + }, + "TypographyColorSubordinate": { + "type": "string" + }, + "TypographyColorSuccess": { + "type": "string" + }, + "TypographyColorSupport": { + "type": "string" + }, + "TypographyColorWarning": { + "type": "string" + }, + "TypographyFamilyBody": { + "type": "string" + }, + "TypographyFamilyButton": { + "type": "string" + }, + "TypographyFamilyHeading": { + "type": "string" + }, + "TypographyLineHeightBody": { + "description": "Unitless line-height multiplier for body text (e.g. 1.5)", + "type": "number" + }, + "TypographyLineHeightHeading1": { + "description": "Unitless line-height multiplier for heading 1", + "type": "number" + }, + "TypographyLineHeightHeading2": { + "description": "Unitless line-height multiplier for heading 2", + "type": "number" + }, + "TypographyLineHeightHeading3": { + "description": "Unitless line-height multiplier for heading 3", + "type": "number" + }, + "TypographyLineHeightHeading4": { + "description": "Unitless line-height multiplier for heading 4", + "type": "number" + }, + "TypographyLineHeightHeading5": { + "description": "Unitless line-height multiplier for heading 5", + "type": "number" + }, + "TypographyLineHeightHeading6": { + "description": "Unitless line-height multiplier for heading 6", + "type": "number" + }, + "TypographyLineHeightOverline": { + "description": "Unitless line-height multiplier for overline text", + "type": "number" + }, + "TypographyLineHeightUi": { + "description": "Unitless line-height multiplier for UI text", + "type": "number" + }, + "TypographyLineLengthMax": { + "type": "string" + }, + "TypographySizeBody": { + "type": "string" + }, + "TypographySizeHeading1": { + "type": "string" + }, + "TypographySizeHeading2": { + "type": "string" + }, + "TypographySizeHeading3": { + "type": "string" + }, + "TypographySizeHeading4": { + "type": "string" + }, + "TypographySizeHeading5": { + "type": "string" + }, + "TypographySizeHeading6": { + "type": "string" + }, + "TypographySizeSubordinate": { + "type": "string" + }, + "TypographyWeightBody": { + "type": "string" + }, + "TypographyWeightBodyBold": { + "type": "string" + }, + "TypographyWeightHeading": { + "type": "string" + }, + "TypographyWeightHeadingBold": { + "type": "string" + } + }, + "type": "object" + }, + "WidgetGeneration": { + "description": "The generation of the Sign-in Widget", + "enum": [ + "G2", + "G3" + ], + "type": "string" + }, + "WindowsOSAccountProfile": { + "properties": { + "GUID": { + "description": "Globally Unique Identifier for the account", + "example": "4ac29c85-d847-4492-96cb-46e337170c33", + "format": "uuid", + "type": "string" + }, + "directoryJoinStatus": { + "description": "Active Directory join status", + "example": "AD", + "type": "string" + }, + "downLevelUsername": { + "description": "Domain\\username format (down-level logon name)", + "example": "okta\\carmel.sonne", + "type": "string" + }, + "fullName": { + "description": "Full name of the account user", + "example": "Carmel Sonne", + "type": "string" + }, + "qualifiedUsername": { + "description": "Fully qualified username", + "example": "okta\\carmel.sonne", + "type": "string" + }, + "securityId": { + "description": "Windows Security Identifier (SID)", + "example": "S-1-5-21-1004336348-1177238915-682003330-512", + "type": "string" + }, + "type": { + "description": "Profile type discriminator", + "enum": [ + "WINDOWS" + ], + "type": "string" + }, + "upn": { + "description": "User principal name", + "example": "carmel.sonne@okta.com", + "type": "string" + } + }, + "type": "object" + }, + "WorkflowActionProvider": { + "allOf": [ + { + "$ref": "#/components/schemas/ActionProvider" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "WorkflowAvailableActionProvider": { + "allOf": [ + { + "$ref": "#/components/schemas/AvailableActionProvider" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "WorkflowsValidationDetailProvider": { + "allOf": [ + { + "$ref": "#/components/schemas/ValidationDetailProvider" + } + ], + "description": "Workflows-specific validation details for action flows", + "properties": { + "code": { + "description": "Error code identifying the validation issue", + "type": "string" + }, + "flowName": { + "description": "The name of the action flow", + "type": "string" + }, + "link": { + "description": "The URL to the action flow interface in Workflows platform", + "format": "uri", + "type": "string" + }, + "message": { + "description": "Validation error message", + "type": "string" + } + }, + "required": [ + "flowName", + "message", + "code", + "link" + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "WsFederationApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/Application" + }, + { + "properties": { + "credentials": { + "$ref": "#/components/schemas/ApplicationCredentials" + }, + "name": { + "description": "`template_wsfed` is the key name for a WS-Federated app instance with a SAML 2.0 token", + "enum": [ + "template_wsfed" + ], + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/WsFederationApplicationSettings" + } + }, + "required": [ + "name", + "settings" + ], + "type": "object" + } + ], + "x-okta-defined-as": { + "name": "template_wsfed" + } + }, + "WsFederationApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/WsFederationApplicationSettingsApplication" + } + }, + "type": "object" + } + ] + }, + "WsFederationApplicationSettingsApplication": { + "properties": { + "attributeStatements": { + "description": "You can federate user attributes such as Okta profile fields, LDAP, Active Directory, and Workday values. The SP uses the federated WS-Fed attribute values accordingly.", + "type": "string" + }, + "audienceRestriction": { + "description": "The entity ID of the SP. Use the entity ID value exactly as provided by the SP.", + "type": "string" + }, + "authnContextClassRef": { + "description": "Identifies the SAML authentication context class for the assertion's authentication statement", + "type": "string" + }, + "groupFilter": { + "description": "A regular expression that filters for the User Groups you want included with the `groupName` attribute. If the matching User Group has a corresponding AD group, then the attribute statement includes the value of the attribute specified by `groupValueFormat`. If the matching User Group doesn't contain a corresponding AD group, then the `groupName` is used in the attribute statement.", + "type": "string" + }, + "groupName": { + "description": "The group name to include in the WS-Fed response attribute statement. This property is used in conjunction with the `groupFilter` property. Groups that are filtered through the `groupFilter` expression are included with the `groupName` in the attribute statement. Any users that belong to the group you've filtered are included in the WS-Fed response attribute statement.", + "type": "string" + }, + "groupValueFormat": { + "description": "Specifies the WS-Fed assertion attribute value for filtered groups. This attribute is only applied to Active Directory groups.", + "enum": [ + "windowsDomainQualifiedName", + "samAccountName", + "dn" + ], + "type": "string" + }, + "nameIDFormat": { + "description": "The username format that you send in the WS-Fed response", + "type": "string" + }, + "realm": { + "description": "The uniform resource identifier (URI) of the WS-Fed app that's used to share resources securely within a domain. It's the identity that's sent to the Okta IdP when signing in. See [Realm name](https://help.okta.com/okta_help.htm?type=oie&id=ext_Apps_Configure_Okta_Template_WS_Federation#Realm).", + "type": "string" + }, + "siteURL": { + "description": "Launch URL for the web app", + "type": "string" + }, + "usernameAttribute": { + "description": "Specifies additional username attribute statements to include in the WS-Fed assertion", + "enum": [ + "username", + "upn", + "upnAndUsername", + "none" + ], + "type": "string" + }, + "wReplyOverride": { + "description": "Enables a web app to override the `wReplyURL` URL with a reply parameter.", + "type": "boolean" + }, + "wReplyURL": { + "description": "The WS-Fed SP endpoint where your users sign in", + "example": "http://test.acme.com/example-post-sign/", + "type": "string" + } + }, + "required": [ + "audienceRestriction", + "groupValueFormat", + "wReplyURL", + "nameIDFormat", + "authnContextClassRef", + "siteURL", + "usernameAttribute" + ], + "type": "object" + }, + "X5c": { + "description": "Base64-encoded X.509 certificate chain with DER encoding", + "items": { + "example": "MIIDnjCCAoagAwIBAgIGAVG3MN+PMA0GCSqGSIb3DQEBBQUAMIGPMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEDAOBgNVBAMMB2V4YW1wbGUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMTUxMjE4MjIyMjMyWhcNMjUxMjE4MjIyMzMyWjCBjzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRAwDgYDVQQDDAdleGFtcGxlMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtcnyvuVCrsFEKCwHDenS3Ocjed8eWDv3zLtD2K/iZfE8BMj2wpTfn6Ry8zCYey3mWlKdxIybnV9amrujGRnE0ab6Q16v9D6RlFQLOG6dwqoRKuZy33Uyg8PGdEudZjGbWuKCqqXEp+UKALJHV+k4wWeVH8g5d1n3KyR2TVajVJpCrPhLFmq1Il4G/IUnPe4MvjXqB6CpKkog1+ThWsItPRJPAM+RweFHXq7KfChXsYE7Mmfuly8sDQlvBmQyxZnFHVuiPfCvGHJjpvHy11YlHdOjfgqHRvZbmo30+y0X/oY/yV4YEJ00LL6eJWU4wi7ViY3HP6/VCdRjHoRdr5L/DwIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCzzhOFkvyYLNFj2WDcq1YqD4sBy1iCia9QpRH3rjQvMKDwQDYWbi6EdOX0TQ/IYR7UWGj+2pXd6v0t33lYtoKocp/4lUvT3tfBnWZ5KnObi+J2uY2teUqoYkASN7F+GRPVOuMVoVgm05ss8tuMb2dLc9vsx93sDt+XlMTv/2qi5VPwaDtqduKkzwW9lUfn4xIMkTiVvCpe0X2HneD2Bpuao3/U8Rk0uiPfq6TooWaoW3kjsmErhEAs9bA7xuqo1KKY9CdHcFhkSsMhoeaZylZHtzbnoipUlQKSLMdJQiiYZQ0bYL83/Ta9fulr1EERICMFt3GUmtYaZZKHpWSfdJp9", + "type": "string" + }, + "type": "array" + }, + "ZoomUsApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/OINApplication" + }, + { + "type": "object" + }, + { + "properties": { + "name": { + "enum": [ + "zoomus" + ], + "example": "zoomus", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/ZoomUsApplicationSettings" + }, + "signOnMode": { + "enum": [ + "SAML_2_0" + ], + "type": "string" + } + }, + "required": [ + "name", + "label", + "settings" + ] + } + ], + "description": "Schema for the Zoom app (key name: `zoomus`)\n\nTo create a Zoom app, use the [Create an Application](/openapi/okta-management/management/tags/application/other/createapplication) request with the following parameters in the request body.\n> **Note:** The Zoom app only supports `SAML_2_0` sign-on mode.\n", + "example": { + "label": "Sample Zoom App", + "name": "zoomus", + "settings": { + "app": { + "subDomain": "my-zoom-subdomain" + } + }, + "signOnMode": "SAML_2_0" + }, + "title": "Zoom", + "x-okta-defined-as": { + "name": "zoomus" + }, + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-tags": [ + "Application" + ] + }, + "ZoomUsApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "type": "object" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/ZoomUsApplicationSettingsApplication" + }, + "signOn": { + "$ref": "#/components/schemas/OINSaml20ApplicationSettingsSignOn" + } + }, + "required": [ + "app" + ] + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ZoomUsApplicationSettingsApplication": { + "description": "Zoom app instance properties", + "properties": { + "subDomain": { + "description": "Your Zoom subdomain", + "type": "string" + } + }, + "required": [ + "subDomain" + ], + "type": "object" + }, + "ZscalerbyzApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/OINApplication" + }, + { + "type": "object" + }, + { + "properties": { + "name": { + "enum": [ + "zscalerbyz" + ], + "example": "zscalerbyz", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/ZscalerbyzApplicationSettings" + }, + "signOnMode": { + "enum": [ + "BROWSER_PLUGIN", + "SAML_2_0" + ], + "type": "string" + } + }, + "required": [ + "name", + "label", + "settings" + ] + } + ], + "description": "Schema for the Zscaler 2.0 app (key name: `zscalerbyz`)\n\nTo create a Zscaler 2.0 app, use the [Create an Application](/openapi/okta-management/management/tags/application/other/createapplication) request with the following parameters in the request body.\n> **Note:** The Zscaler 2.0 app only supports `BROWSER_PLUGIN` and `SAML_2_0` sign-on modes.\n", + "example": { + "label": "Sample Zscaler 2.0 App", + "name": "zscalerbyz", + "signOnMode": "SAML_2_0" + }, + "title": "Zscaler 2.0", + "x-okta-defined-as": { + "name": "zscalerbyz" + }, + "x-okta-ignore-redocly-rules-for-sdk": true, + "x-tags": [ + "Application" + ] + }, + "ZscalerbyzApplicationSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationSettings" + }, + { + "type": "object" + }, + { + "properties": { + "app": { + "$ref": "#/components/schemas/ZscalerbyzApplicationSettingsApplication" + }, + "signOn": { + "$ref": "#/components/schemas/OINSaml20ApplicationSettingsSignOn" + } + }, + "required": [ + "app" + ] + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "ZscalerbyzApplicationSettingsApplication": { + "description": "Zscaler app instance properties", + "properties": { + "siteDomain": { + "description": "Your Zscaler domain", + "type": "string" + } + }, + "type": "object" + }, + "_embedded": { + "description": "The Public Key Details are defined in the `_embedded` property of the Key object.", + "properties": { + "alg": { + "description": "Algorithm used in the key", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "e": { + "description": "RSA key value (exponent) for key binding", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "kid": { + "description": "Unique identifier for the certificate", + "nullable": false, + "readOnly": true, + "type": "string", + "uniqueItems": true + }, + "kty": { + "description": "Cryptographic algorithm family for the certificate's keypair", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "n": { + "description": "RSA key value (modulus) for key binding", + "nullable": false, + "readOnly": true, + "type": "string" + }, + "use": { + "description": "Acceptable use of the certificate", + "nullable": true, + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "createdProperty": { + "description": "Timestamp when the object was created", + "example": "2017-03-28T01:11:10.000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "enabledPagesType": { + "enum": [ + "SIGN_IN", + "SSPR", + "SSR" + ], + "title": "enabledPages", + "type": "string", + "x-enumDescriptions": { + "SIGN_IN": "User sign-in page", + "SSPR": "Self-service Password Recovery page", + "SSR": "Self-service Registration page" + } + }, + "entitlementTypes": { + "description": "List of supported entitlement types", + "items": { + "properties": { + "attributes": { + "description": "Attributes for the entitlement type", + "properties": { + "multivalued": { + "default": false, + "description": "A boolean value to indicate if a user can have multiple entitlements of this type", + "type": "boolean" + }, + "required": { + "default": false, + "description": "A boolean value to indicate if this entitlement type is required for the user", + "type": "boolean" + } + }, + "type": "object" + }, + "description": { + "description": "Description of the entitlement type", + "type": "string" + }, + "endpoint": { + "description": "URL of the entitlement type endpoint", + "type": "string" + }, + "mappings": { + "description": "The property mapping between an Okta entitlement and an app entitlement", + "properties": { + "description": { + "description": "The field that maps to entitlement description", + "type": "string" + }, + "displayName": { + "description": "The field that maps to the entitlement display name", + "type": "string" + }, + "id": { + "description": "The field that maps to the entitlement ID", + "type": "string" + } + }, + "required": [ + "id", + "displayName" + ], + "type": "object" + }, + "name": { + "description": "The entitlement type name", + "type": "string" + } + }, + "required": [ + "name", + "endpoint", + "attributes", + "mappings" + ], + "type": "object" + }, + "type": "array" + }, + "lastUpdatedProperty": { + "description": "Timestamp when the object was last updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "orgBillingContactType": { + "description": "Org billing contact", + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the org billing contact type object using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "properties": { + "billing": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the org billing [contact type user](/openapi/okta-management/management/orgsettingcontact/#tag/OrgSettingContact/operation/getOrgContactUser) resource" + } + ] + } + }, + "readOnly": true, + "type": "object" + }, + "contactType": { + "$ref": "#/components/schemas/OrgContactType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "orgGeneralSettingLinks": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the org using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "properties": { + "contacts": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the [Org Contacts](/openapi/okta-management/management/orgsettingcontact/) resource" + } + ] + }, + "logo": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the org logo" + } + ] + }, + "oktaCommunication": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the [Org Communication Settings](/openapi/okta-management/management/orgsettingcommunication/) resource" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "oktaSupport": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the [Org Support Settings](/openapi/okta-management/management/orgsettingsupport/) resource" + } + ] + }, + "preferences": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the [Org Preferences](/openapi/okta-management/management/orgsettingcustomization/getorgpreferences) resource" + } + ] + }, + "uploadLogo": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the [Upload Org Logo](/openapi/okta-management/management/orgsettingcustomization) resource" + } + ] + } + }, + "readOnly": true, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "orgTechnicalContactType": { + "description": "Org technical contact", + "properties": { + "_links": { + "description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the org technical Contact Type object using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification", + "properties": { + "technical": { + "allOf": [ + { + "$ref": "#/components/schemas/HrefObject" + }, + { + "description": "Link to the org technical [Contact Type User](/openapi/okta-management/management/orgsettingcontact/#tag/OrgSettingContact/operation/getOrgContactUser) resource" + } + ] + } + }, + "readOnly": true, + "type": "object" + }, + "contactType": { + "$ref": "#/components/schemas/OrgContactType" + } + }, + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + }, + "postAPIServiceIntegrationInstance": { + "allOf": [ + { + "$ref": "#/components/schemas/APIServiceIntegrationInstance" + }, + { + "properties": { + "clientSecret": { + "description": "The client secret for the API Service Integration instance. This property is only returned in a POST response.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "postAPIServiceIntegrationInstanceRequest": { + "properties": { + "grantedScopes": { + "description": "The list of Okta management scopes granted to the API Service Integration instance. See [Okta management OAuth 2.0 scopes](/oauth2/#okta-admin-management).", + "example": [ + "okta.logs.read" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "properties": { + "$ref": "#/components/schemas/AppProperties" + }, + "type": { + "description": "The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name. For example, `my_api_log_integration`.", + "example": "my_app_cie", + "type": "string" + } + }, + "required": [ + "type", + "grantedScopes" + ], + "type": "object" + }, + "profile": { + "additionalProperties": true, + "description": "Specific profile properties for the privileged resource", + "readOnly": true, + "type": "object" + }, + "subject": { + "nullable": false, + "properties": { + "format": { + "description": "The user identifier", + "enum": [ + "opaque" + ], + "nullable": false, + "type": "string", + "writeOnly": true + }, + "id": { + "description": "ID of the user", + "nullable": false, + "type": "string", + "writeOnly": true + } + }, + "type": "object" + }, + "tempPassword": { + "properties": { + "tempPassword": { + "description": "A temporary password that the user can sign in with. This is only returned when expiring a password with a temporary password.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "useNumberMatchingChallenge": { + "description": "Select whether to use a number matching challenge for a `push` factor.\n\n> **Note:** Sending a request with a body is required when you verify a `push` factor with a number matching challenge.", + "example": true, + "type": "boolean", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "userLink": { + "properties": { + "user": { + "$ref": "#/components/schemas/HrefObjectUserLink" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "apiToken": { + "description": "Pass the API token as the Authorization header value prefixed with SSWS: `Authorization: SSWS {API Token}`", + "in": "header", + "name": "Authorization", + "type": "apiKey" + }, + "oauth2": { + "description": "Pass the access_token as the value of the Authorization header: `Authorization: Bearer {access_token}`", + "flows": { + "authorizationCode": { + "authorizationUrl": "/oauth2/v1/authorize", + "scopes": { + "okta.agentPools.manage": "Allows the app to create and manage agent pools in your Okta organization", + "okta.agentPools.read": "Allows the app to read agent pools in your Okta organization", + "okta.apiTokens.manage": "Allows the app to manage API Tokens in your Okta organization", + "okta.apiTokens.read": "Allows the app to read API Tokens in your Okta organization", + "okta.appGrants.manage": "Allows the app to create and manage grants in your Okta organization", + "okta.appGrants.read": "Allows the app to read grants in your Okta organization", + "okta.apps.interclientTrust.manage": "Allows the app to manage trusted relationship for native to web SSO", + "okta.apps.interclientTrust.read": "Allows the app to read configured trusted relationship for native to web SSO", + "okta.apps.manage": "Allows the app to create and manage Apps in your Okta organization", + "okta.apps.read": "Allows the app to read information about Apps in your Okta organization", + "okta.authenticators.manage": "Allows the app to manage all authenticators. For example, enrollments or resets.", + "okta.authenticators.read": "Allows the app to read org authenticators information", + "okta.authorizationServers.manage": "Allows the app to create and manage Authorization Servers in your Okta organization", + "okta.authorizationServers.read": "Allows the app to read information about Authorization Servers in your Okta organization", + "okta.behaviors.manage": "Allows the app to create and manage behavior detection rules in your Okta organization", + "okta.behaviors.read": "Allows the app to read behavior detection rules in your Okta org", + "okta.botProtection.manage": "Allows the app to manage bot protection configuration in your Okta org", + "okta.botProtection.read": "Allows the app to read bot protection configuration in your Okta org", + "okta.brands.manage": "Allows the app to create and manage Brands and Themes in your Okta organization", + "okta.brands.read": "Allows the app to read information about Brands and Themes in your Okta organization", + "okta.captchas.manage": "Allows the app to create and manage CAPTCHAs in your Okta organization", + "okta.captchas.read": "Allows the app to read information about CAPTCHAs in your Okta organization", + "okta.customTelephonyProvider.manage": "Allows the app to create and manage custom telephony provider credentials", + "okta.customTelephonyProvider.read": "Allows the app to read custom telephony provider credentials", + "okta.deviceAssurance.manage": "Allows the app to manage device assurances", + "okta.deviceAssurance.read": "Allows the app to read device assurances", + "okta.deviceIntegrations.manage": "Allows the app to manage device integrations", + "okta.deviceIntegrations.read": "Allows the app to read device integrations", + "okta.devicePostureChecks.manage": "Allows the app to manage device posture checks", + "okta.devicePostureChecks.read": "Allows the app to read device posture checks", + "okta.devices.manage": "Allows the app to manage device status transitions and delete a device", + "okta.devices.read": "Allows the app to read the existing device's profile and search devices", + "okta.directories.groups.manage": "Allows the app to manage AD/LDAP groups for your Okta organization", + "okta.directories.groups.read": "Allows the app to read AD/LDAP groups for your Okta organization", + "okta.domains.manage": "Allows the app to manage custom Domains for your Okta organization", + "okta.domains.read": "Allows the app to read information about custom Domains for your Okta organization", + "okta.dr.manage": "Allows the app to manage disaster recovery", + "okta.dr.read": "Allows the app to read the disaster recovery status", + "okta.emailDomains.manage": "Allows the app to manage Email Domains for your Okta organization", + "okta.emailDomains.read": "Allows the app to read information about Email Domains for your Okta organization", + "okta.emailServers.manage": "Allows the app to manage Email Servers for your Okta organization", + "okta.emailServers.read": "Allows the app to read information about Email Servers for your Okta organization", + "okta.eventHooks.manage": "Allows the app to create and manage Event Hooks in your Okta organization", + "okta.eventHooks.read": "Allows the app to read information about Event Hooks in your Okta organization", + "okta.features.manage": "Allows the app to create and manage Features in your Okta organization", + "okta.features.read": "Allows the app to read information about Features in your Okta organization", + "okta.groups.manage": "Allows the app to create and manage groups in your Okta organization", + "okta.groups.read": "Allows the app to read information about groups and their members in your Okta organization", + "okta.identitySources.manage": "Allows the custom identity sources to manage user entities in your Okta organization", + "okta.identitySources.read": "Allows to read session information for custom identity sources in your Okta organization", + "okta.idps.manage": "Allows the app to create and manage Identity Providers in your Okta organization", + "okta.idps.read": "Allows the app to read information about Identity Providers in your Okta organization", + "okta.inlineHooks.manage": "Allows the app to create and manage Inline Hooks in your Okta organization", + "okta.inlineHooks.read": "Allows the app to read information about Inline Hooks in your Okta organization", + "okta.linkedObjects.manage": "Allows the app to manage linked object definitions in your Okta organization", + "okta.linkedObjects.read": "Allows the app to read linked object definitions in your Okta organization", + "okta.logStreams.manage": "Allows the app to create and manage log streams in your Okta organization", + "okta.logStreams.read": "Allows the app to read information about log streams in your Okta organization", + "okta.logs.read": "Allows the app to read information about System Log entries in your Okta organization", + "okta.networkZones.manage": "Allows the app to create and manage Network Zones in your Okta organization", + "okta.networkZones.read": "Allows the app to read Network Zones in your Okta organization", + "okta.oauthIntegrations.manage": "Allows the app to create and manage API service Integration instances in your Okta organization", + "okta.oauthIntegrations.read": "Allows the app to read API service Integration instances in your Okta organization", + "okta.orgs.manage": "Allows the app to manage organization-specific details for your Okta organization", + "okta.orgs.read": "Allows the app to read organization-specific details about your Okta organization", + "okta.personal.adminSettings.manage": "Allows the app to manage the personal admin settings for the signed-in user", + "okta.personal.adminSettings.read": "Allows the app to read the personal admin settings for the signed-in user", + "okta.policies.manage": "Allows the app to manage policies in your Okta organization", + "okta.policies.read": "Allows the app to read information about policies in your Okta organization", + "okta.principalRateLimits.manage": "Allows the app to create and manage Principal Rate Limits in your Okta organization", + "okta.principalRateLimits.read": "Allows the app to read information about Principal Rate Limits in your Okta organization", + "okta.profileMappings.manage": "Allows the app to manage user profile mappings in your Okta organization", + "okta.profileMappings.read": "Allows the app to read user profile mappings in your Okta organization", + "okta.pushProviders.manage": "Allows the app to create and manage push notification providers such as APNs and FCM", + "okta.pushProviders.read": "Allows the app to read push notification providers such as APNs and FCM", + "okta.rateLimits.manage": "Allows the app to create and manage rate limits in your Okta organization", + "okta.rateLimits.read": "Allows the app to read information about rate limits in your Okta organization", + "okta.realmAssignments.manage": "Allows a user to manage realm assignments", + "okta.realmAssignments.read": "Allows a user to read realm assignments", + "okta.realms.manage": "Allows the app to create new realms and to manage their details", + "okta.realms.read": "Allows the app to read the existing realms and their details", + "okta.roles.manage": "Allows the app to manage administrative role assignments for users in your Okta organization. Delegated admins with this permission can only manage user credential fields and not the credential values themselves.", + "okta.roles.read": "Allows the app to read administrative role assignments for users in your Okta organization. Delegated admins with this permission can only read user credential fields and not the credential values themselves.", + "okta.schemas.manage": "Allows the app to create and manage Schemas in your Okta organization", + "okta.schemas.read": "Allows the app to read information about Schemas in your Okta organization", + "okta.securityEventsProviders.manage": "Allows the app to create and manage Security Events Providers in your Okta organization", + "okta.securityEventsProviders.read": "Allows the app to read information about Security Events Providers in your Okta organization", + "okta.serviceAccounts.manage": "Allows the app to manage service accounts in your Okta organization", + "okta.serviceAccounts.okta.manage": "Allows the app to manage Okta managed user accounts in your Okta org", + "okta.serviceAccounts.okta.read": "Allows the app to read Okta managed user accounts in your Okta org", + "okta.serviceAccounts.read": "Allows the app to read service accounts in your Okta organization", + "okta.sessions.manage": "Allows the app to manage all sessions in your Okta organization", + "okta.sessions.read": "Allows the app to read all sessions in your Okta organization", + "okta.templates.manage": "Allows the app to manage all custom templates in your Okta organization", + "okta.templates.read": "Allows the app to read all custom templates in your Okta organization", + "okta.threatInsights.manage": "Allows the app to manage all ThreatInsight configurations in your Okta organization", + "okta.threatInsights.read": "Allows the app to read all ThreatInsight configurations in your Okta organization", + "okta.trustedOrigins.manage": "Allows the app to manage all Trusted Origins in your Okta organization", + "okta.trustedOrigins.read": "Allows the app to read all Trusted Origins in your Okta organization", + "okta.uischemas.manage": "Allows the app to manage all the UI Schemas in your Okta organization", + "okta.uischemas.read": "Allows the app to read all the UI Schemas in your Okta organization", + "okta.userRisk.manage": "Allows the app to manage a user's risk in your Okta org", + "okta.userRisk.read": "Allows the app to read a user's risk in your Okta org", + "okta.userTypes.manage": "Allows the app to manage user types in your Okta org", + "okta.userTypes.read": "Allows the app to read user types in your Okta org", + "okta.users.manage": "Allows the app to create new users and to manage all users' profile and credentials information", + "okta.users.read": "Allows the app to read the existing users' profiles and credentials", + "ssf.manage": "Allows the app to create and manage Shared Signals Framework (SSF) in your Okta organization", + "ssf.read": "Allows the app to read information about Shared Signals Framework (SSF) in your Okta organization" + }, + "tokenUrl": "/oauth2/v1/token" + } + }, + "type": "oauth2" + } + } + }, + "externalDocs": { + "description": "Find more info here", + "url": "https://developer.okta.com/docs/reference/" + }, + "info": { + "contact": { + "email": "devex-public@okta.com", + "name": "Okta Developer Team", + "url": "https://developer.okta.com/" + }, + "description": "Allows customers to easily access the Okta Management APIs", + "license": { + "name": "Apache-2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "termsOfService": "https://developer.okta.com/terms/", + "title": "Okta Admin Management API", + "version": "2026.06.2", + "x-logo": { + "altText": "Okta Developer", + "backgroundColor": "transparent", + "url": "logo.svg" + } + }, + "openapi": "3.0.3", + "paths": { + "/.well-known/app-authenticator-configuration": { + "get": { + "description": "Retrieves the well-known app authenticator configuration. Includes an app authenticator's settings, supported methods, and other details.", + "operationId": "getWellKnownAppAuthenticatorConfiguration", + "parameters": [ + { + "description": "Filters app authenticator configurations by `oauthClientId`", + "in": "query", + "name": "oauthClientId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AuthenticatorConfiguration": { + "$ref": "#/components/examples/WellKnownAppAuthenticatorConfigurationCustomApp" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/WellKnownAppAuthenticatorConfiguration" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorMissingRequiredParameter400" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [], + "summary": "Retrieve the well-known app authenticator configuration", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/.well-known/apple-app-site-association": { + "get": { + "description": "Retrieves the content of the `apple-app-site-assocation` well-known URI\n\n> **Note:** When serving this URI, Okta adds `authsrv` content to provide a seamless experience for Okta Verify. You can't modify the content in the `authsrv` object.", + "operationId": "getAppleAppSiteAssociationWellKnownURI", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Response": { + "$ref": "#/components/examples/PublicAppleAppSiteWellKnownURIResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/PublicAppleAppSiteWellKnownURI" + } + } + }, + "description": "Success" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [], + "summary": "Retrieve the customized apple-app-site-association URI content", + "tags": [ + "AssociatedDomainCustomizations" + ] + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "/.well-known/assetlinks.json": { + "get": { + "description": "Retrieves the content of the `assetlinks.json` well-known URI", + "operationId": "getAssetLinksWellKnownURI", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Response": { + "$ref": "#/components/examples/PublicAssetLinksWellKnownURIResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/PublicAssetLinksWellKnownURI" + } + } + }, + "description": "Success" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [], + "summary": "Retrieve the customized assetlinks.json URI content", + "tags": [ + "AssociatedDomainCustomizations" + ] + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "/.well-known/okta-organization": { + "get": { + "description": "Retrieves the org metadata, which includes the org ID, configured custom domains, and authentication pipeline", + "operationId": "getWellknownOrgMetadata", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Classic Engine org": { + "$ref": "#/components/examples/WellKnownOrgMetadataResponseClassic" + }, + "Identity Engine org with a custom domain": { + "$ref": "#/components/examples/WellKnownOrgMetadataResponseCustomUrlOie" + } + }, + "schema": { + "$ref": "#/components/schemas/WellKnownOrgMetadata" + } + } + }, + "description": "Success" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [], + "summary": "Retrieve the Org metadata", + "tags": [ + "OrgSettingMetadata" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/.well-known/ssf-configuration": { + "get": { + "description": "Retrieves SSF transmitter configuration metadata. This includes all supported endpoints and key information about certain properties of the Okta org as the transmitter, such as `delivery_methods_supported`, `issuer`, and `jwks_uri`.", + "operationId": "getWellknownSsfMetadata", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "wellKnownSSFMetadataExample": { + "$ref": "#/components/examples/wellKnownSSFMetadataExample" + } + }, + "schema": { + "$ref": "#/components/schemas/WellKnownSSFMetadata" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [], + "summary": "Retrieve the SSF transmitter metadata", + "tags": [ + "SSFTransmitter" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/.well-known/webauthn": { + "get": { + "description": "Retrieves the content of the `webauthn` well-known URI", + "operationId": "getWebAuthnWellKnownURI", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Response": { + "$ref": "#/components/examples/PublicWebauthnWellKnownURIResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/PublicWebauthnSiteWellKnownURI" + } + } + }, + "description": "Success" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [], + "summary": "Retrieve the customized webauthn URI content", + "tags": [ + "AssociatedDomainCustomizations" + ] + }, + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "/api/v1/agentPools": { + "get": { + "description": "Lists all agent pools with pagination support", + "operationId": "listAgentPools", + "parameters": [ + { + "$ref": "#/components/parameters/queryLimitPerPoolType" + }, + { + "$ref": "#/components/parameters/queryPoolType" + }, + { + "$ref": "#/components/parameters/queryAfter" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAllAgentPoolsResponse": { + "$ref": "#/components/examples/ListAllAgentPoolsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AgentPool" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.read" + ] + } + ], + "summary": "List all agent pools", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/agentPools/{poolId}/updates": { + "get": { + "description": "Lists all agent pool updates", + "operationId": "listAgentPoolsUpdates", + "parameters": [ + { + "$ref": "#/components/parameters/queryScheduled" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAllAgentPoolUpdatesResponse": { + "$ref": "#/components/examples/ListAllAgentPoolUpdatesResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AgentPoolUpdate" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.read" + ] + } + ], + "summary": "List all agent pool updates", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPoolId" + } + ], + "post": { + "description": "Creates an agent pool update", + "operationId": "createAgentPoolsUpdate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.manage" + ] + } + ], + "summary": "Create an agent pool update", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/agentPools/{poolId}/updates/settings": { + "get": { + "description": "Retrieves the current state of the agent pool update instance settings", + "operationId": "getAgentPoolsUpdateSettings", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdateSettingResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.read" + ] + } + ], + "summary": "Retrieve an agent pool update's settings", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPoolId" + } + ], + "post": { + "description": "Updates an agent pool update instance settings", + "operationId": "updateAgentPoolsUpdateSettings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdateSettingRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdateSettingResponse" + } + } + }, + "description": "Updated" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.manage" + ] + } + ], + "summary": "Update an agent pool update settings", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/agentPools/{poolId}/updates/{updateId}": { + "delete": { + "description": "Deletes agent pool update", + "operationId": "deleteAgentPoolsUpdate", + "responses": { + "204": { + "description": "Deleted" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.manage" + ] + } + ], + "summary": "Delete an agent pool update", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an agent pool update by its `updateId`", + "operationId": "getAgentPoolsUpdateInstance", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.read" + ] + } + ], + "summary": "Retrieve an agent pool update by ID", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPoolId" + }, + { + "$ref": "#/components/parameters/pathUpdateId" + } + ], + "post": { + "description": "Updates an agent pool update instance and returns the latest agent pool update", + "operationId": "updateAgentPoolsUpdate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "description": "Updated" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.manage" + ] + } + ], + "summary": "Update an agent pool update by ID", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/agentPools/{poolId}/updates/{updateId}/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPoolId" + }, + { + "$ref": "#/components/parameters/pathUpdateId" + } + ], + "post": { + "description": "Activates a scheduled agent pool update", + "operationId": "activateAgentPoolsUpdate", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "description": "Activated" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.manage" + ] + } + ], + "summary": "Activate an agent pool update", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/agentPools/{poolId}/updates/{updateId}/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPoolId" + }, + { + "$ref": "#/components/parameters/pathUpdateId" + } + ], + "post": { + "description": "Deactivates scheduled agent pool update", + "operationId": "deactivateAgentPoolsUpdate", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "description": "Deactivated" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.manage" + ] + } + ], + "summary": "Deactivate an agent pool update", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/agentPools/{poolId}/updates/{updateId}/pause": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPoolId" + }, + { + "$ref": "#/components/parameters/pathUpdateId" + } + ], + "post": { + "description": "Pauses a running or queued agent pool update", + "operationId": "pauseAgentPoolsUpdate", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "description": "Paused" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.manage" + ] + } + ], + "summary": "Pause an agent pool update", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/agentPools/{poolId}/updates/{updateId}/resume": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPoolId" + }, + { + "$ref": "#/components/parameters/pathUpdateId" + } + ], + "post": { + "description": "Resumes a running or queued agent pool update", + "operationId": "resumeAgentPoolsUpdate", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "description": "Resumed" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.manage" + ] + } + ], + "summary": "Resume an agent pool update", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/agentPools/{poolId}/updates/{updateId}/retry": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPoolId" + }, + { + "$ref": "#/components/parameters/pathUpdateId" + } + ], + "post": { + "description": "Retries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update", + "operationId": "retryAgentPoolsUpdate", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "description": "Retried" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.manage" + ] + } + ], + "summary": "Retry an agent pool update", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/agentPools/{poolId}/updates/{updateId}/stop": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPoolId" + }, + { + "$ref": "#/components/parameters/pathUpdateId" + } + ], + "post": { + "description": "Stops an agent pool update", + "operationId": "stopAgentPoolsUpdate", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentPoolUpdate" + } + } + }, + "description": "Stopped" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.agentPools.manage" + ] + } + ], + "summary": "Stop an agent pool update", + "tags": [ + "AgentPools" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/api-tokens": { + "get": { + "description": "Lists all the metadata of the active API tokens", + "operationId": "listApiTokens", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "List Tokens": { + "$ref": "#/components/examples/ApiTokenListMetadataResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/ApiToken" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apiTokens.read" + ] + } + ], + "summary": "List all API token metadata", + "tags": [ + "ApiToken" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/api-tokens/current": { + "delete": { + "description": "Revokes the API token provided in the Authorization header", + "operationId": "revokeCurrentApiToken", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + } + ], + "summary": "Revoke the current API token", + "tags": [ + "ApiToken" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/api-tokens/{apiTokenId}": { + "delete": { + "description": "Revokes an API token by `apiTokenId`", + "operationId": "revokeApiToken", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apiTokens.manage" + ] + } + ], + "summary": "Revoke an API token", + "tags": [ + "ApiToken" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves the metadata for an active API token by `apiTokenId`", + "operationId": "getApiToken", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "HCaptcha": { + "$ref": "#/components/examples/ApiTokenMetadataResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ApiToken" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apiTokens.read" + ] + } + ], + "summary": "Retrieve an API token's metadata", + "tags": [ + "ApiToken" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathApiTokenId" + } + ], + "put": { + "description": "Upserts an API Token Network Condition by `apiTokenId`", + "operationId": "upsertApiToken", + "requestBody": { + "content": { + "application/json": { + "example": { + "clientName": "client_name", + "created": "2021-11-09T20:38:10.000Z", + "name": "api_token_name", + "network": { + "connection": "ANYWHERE" + }, + "userId": "00uabcdefg1234567890" + }, + "schema": { + "$ref": "#/components/schemas/ApiTokenUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "HCaptcha": { + "$ref": "#/components/examples/ApiTokenMetadataResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ApiToken" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apiTokens.manage" + ] + } + ], + "summary": "Upsert an API token network condition", + "tags": [ + "ApiToken" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps": { + "get": { + "description": "Lists all apps in the org with pagination. A subset of apps can be returned that match a supported filter expression or query. The results are [paginated](/#pagination) according to the `limit` parameter. If there are multiple pages of results, the header contains a `next` link. Treat the link as an opaque value (follow it, don't parse it).\n\n> **Note:** To list all of a member's assigned app links, use the [List all assigned app links endpoint in the User Resources API](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/userresources/other/listapplinks).", + "operationId": "listApplications", + "parameters": [ + { + "description": "Searches for apps with `name` or `label` properties that starts with the `q` value using the `startsWith` operation", + "in": "query", + "name": "q", + "schema": { + "example": "Okta", + "type": "string" + } + }, + { + "description": "Specifies the [pagination](/#pagination) cursor for the next page of results. Treat this as an opaque value obtained through the `next` link relationship.", + "in": "query", + "name": "after", + "schema": { + "example": 16278919418571, + "type": "string" + } + }, + { + "description": "Specifies whether to use query optimization. If you specify `useOptimization=true` in the request query, the response contains a subset of app instance properties.", + "in": "query", + "name": "useOptimization", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Specifies whether to include the VPN configuration for existing notifications in the result, regardless of whether VPN notifications are configured", + "in": "query", + "name": "alwaysIncludeVpnSettings", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Specifies the number of results per page", + "in": "query", + "name": "limit", + "schema": { + "default": -1, + "format": "int32", + "maximum": 200, + "type": "integer" + } + }, + { + "description": "Filters apps with a supported expression for a subset of properties. Filtering supports the following limited number of properties: `id`, `status`, `credentials.signing.kid`, `settings.slo.enabled`, or `name`. See [Filter](https://developer.okta.com/docs/api/#filter).", + "examples": { + "ActiveStatusEx": { + "summary": "Filter for active apps", + "value": "status eq \"ACTIVE\"" + }, + "CredKidEx": { + "summary": "Filter for apps using a specific key", + "value": "credentials.signing.kid eq \"SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-F1bm4\"" + }, + "NameFilterEx": { + "summary": "Filter for apps with `okta_org2org` name", + "value": "name eq \"okta_org2org\"" + } + }, + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/queryAppsExpand" + }, + { + "description": "Specifies whether to include non-active, but not deleted apps in the results", + "in": "query", + "name": "includeNonDeleted", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ResponseExample1": { + "$ref": "#/components/examples/GetApplicationsByUserResponseEx" + }, + "ResponseExample2": { + "$ref": "#/components/examples/GetApplicationsByGroupResponseEx" + }, + "ResponseExample3": { + "$ref": "#/components/examples/GetApplicationsByKeyResponseEx" + }, + "ResponseExample4": { + "$ref": "#/components/examples/GetApplicationsByNameResponseEx" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/Application" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "List all applications", + "tags": [ + "Application" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates an app instance in your Okta org.\n\nYou can either create an OIN app instance or a custom app instance:\n* OIN app instances have prescribed `name` (key app definition) and `signOnMode` options. See the [OIN schemas](/openapi/okta-management/management/application/googleapplication) for the request body.\n* For custom app instances, select the [signOnMode](/openapi/okta-management/management/tags/application/other/createapplication#application/createapplication/t=request&path=&d=0/signonmode) that pertains to your app and specify the required parameters in the request body.\n", + "operationId": "createApplication", + "parameters": [ + { + "description": "Executes activation lifecycle operation when creating the app", + "in": "query", + "name": "activate", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "in": "header", + "name": "OktaAccessGateway-Agent", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "AUTO_LOGIN": { + "$ref": "#/components/examples/AutoLoginEx" + }, + "BASIC_AUTH": { + "$ref": "#/components/examples/BasicAuthEx" + }, + "BOOKMARK": { + "$ref": "#/components/examples/BookmarkEx" + }, + "BROWSER_PLUGIN": { + "$ref": "#/components/examples/BrowserPluginEx" + }, + "BROWSER_PLUGIN_SWA_3FIELD": { + "$ref": "#/components/examples/BrowserPluginSwa3FieldEx" + }, + "OPENID_CONNECT": { + "$ref": "#/components/examples/OpenidConnectEx" + }, + "SAML_2_0": { + "$ref": "#/components/examples/Saml2.0Ex" + }, + "SECURE_PASSWORD_STORE": { + "$ref": "#/components/examples/SecurePasswordStoreEx" + }, + "WS_FEDERATION": { + "$ref": "#/components/examples/WSFederationEx" + } + }, + "schema": { + "$ref": "#/components/schemas/Application" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AUTO_LOGIN": { + "$ref": "#/components/examples/AutoLoginAppResponseEx" + }, + "BASIC_AUTH": { + "$ref": "#/components/examples/BasicAuthResponseEx" + }, + "BOOKMARK": { + "$ref": "#/components/examples/BookmarkAppResponseEx" + }, + "BROWSER_PLUGIN": { + "$ref": "#/components/examples/BrowserPluginResponseEx" + }, + "BROWSER_PLUGIN_SWA_3FIELD": { + "$ref": "#/components/examples/BrowserPluginSwa3FieldResponseEx" + }, + "OPENID_CONNECT": { + "$ref": "#/components/examples/OpenidConnectResponseEx" + }, + "SAML_2_0": { + "$ref": "#/components/examples/Saml2.0ResponseEx" + }, + "SECURE_PASSWORD_STORE": { + "$ref": "#/components/examples/SecurePasswordStoreResponseEx" + }, + "WS_FEDERATION": { + "$ref": "#/components/examples/WSFederationResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/Application" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Create an application", + "tags": [ + "Application" + ], + "x-codegen-request-body-name": "application", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/google/{appId}/oauth2/callback": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/office365/{appId}/oauth2/callback": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/{appId}": { + "delete": { + "description": "Deletes an inactive application", + "operationId": "deleteApplication", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Delete an application", + "tags": [ + "Application" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an application from your Okta organization by `id`", + "operationId": "getApplication", + "parameters": [ + { + "description": "An optional query parameter to return the specified [Application User](/openapi/okta-management/management/tags/applicationusers) in the `_embedded` property.\nValid value: `expand=user/{userId}`", + "in": "query", + "name": "expand", + "schema": { + "example": "user/0oa1gjh63g214q0Hq0g4", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "RetrieveEx1": { + "$ref": "#/components/examples/GetApplicationsResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/Application" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve an application", + "tags": [ + "Application" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "put": { + "description": "Replaces properties for an application\n> **Notes:**\n> * All required properties must be specified in the request body\n> * You can't modify system-assigned properties, such as `id`, `name`, `status`, `created`, and `lastUpdated`. The values for these properties in the PUT request body are ignored.\n", + "operationId": "replaceApplication", + "requestBody": { + "content": { + "application/json": { + "examples": { + "AUTO_LOGIN": { + "$ref": "#/components/examples/AutoLoginPutEx" + }, + "BASIC_AUTH": { + "$ref": "#/components/examples/BasicAuthPutEx" + }, + "BOOKMARK": { + "$ref": "#/components/examples/BookmarkPutEx" + }, + "BROWSER_PLUGIN": { + "$ref": "#/components/examples/BrowserPluginPutEx" + }, + "BROWSER_PLUGIN_SWA_3FIELD": { + "$ref": "#/components/examples/BrowserPluginSwa3FieldPutEx" + }, + "OPENID_CONNECT": { + "$ref": "#/components/examples/OpenidConnectPutEx" + }, + "SAML_2_0": { + "$ref": "#/components/examples/Saml2.0PutEx" + }, + "SECURE_PASSWORD_STORE": { + "$ref": "#/components/examples/SecurePasswordStorePutEx" + }, + "WS_FEDERATION": { + "$ref": "#/components/examples/WSFederationPutEx" + } + }, + "schema": { + "$ref": "#/components/schemas/Application" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AUTO_LOGIN": { + "$ref": "#/components/examples/AutoLoginPutResponseEx" + }, + "BASIC_AUTH": { + "$ref": "#/components/examples/BasicAuthPutResponseEx" + }, + "BOOKMARK": { + "$ref": "#/components/examples/BookmarkPutResponseEx" + }, + "BROWSER_PLUGIN": { + "$ref": "#/components/examples/BrowserPluginPutResponseEx" + }, + "BROWSER_PLUGIN_SWA_3FIELD": { + "$ref": "#/components/examples/BrowserPluginSwa3FieldPutResponseEx" + }, + "OPENID_CONNECT": { + "$ref": "#/components/examples/OpenidConnectPutResponseEx" + }, + "SAML_2_0": { + "$ref": "#/components/examples/Saml2.0PutResponseEx" + }, + "SECURE_PASSWORD_STORE": { + "$ref": "#/components/examples/SecurePasswordStorePutResponseEx" + }, + "WS_FEDERATION": { + "$ref": "#/components/examples/WSFederationPutResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/Application" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Replace an application", + "tags": [ + "Application" + ], + "x-codegen-request-body-name": "application", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/connections/default": { + "get": { + "description": "Retrieves the default provisioning connection for an app", + "operationId": "getDefaultProvisioningConnectionForApplication", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ProvisioningConnectionOauthO365Ex": { + "$ref": "#/components/examples/ProvisioningConnectionOauthResponseEx" + }, + "ProvisioningConnectionTokenOrg2OrgEx": { + "$ref": "#/components/examples/ProvisioningConnectionTokenResponseWithProfileOrg2OrgEx" + }, + "ProvisioningConnectionTokenZscalerEx": { + "$ref": "#/components/examples/ProvisioningConnectionTokenResponseWithProfileZscalerEx" + } + }, + "schema": { + "$ref": "#/components/schemas/ProvisioningConnectionResponse" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve the default provisioning connection", + "tags": [ + "ApplicationConnections" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Updates the default provisioning connection for an app", + "operationId": "updateDefaultProvisioningConnectionForApplication", + "parameters": [ + { + "description": "Activates the provisioning connection", + "in": "query", + "name": "activate", + "schema": { + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "ProvisioningConnectionOAuthOrg2OrgEx": { + "$ref": "#/components/examples/ProvisioningConnectionOAuthOrg2OrgWithRotationRequestEx" + }, + "ProvisioningConnectionOauthO365Ex": { + "$ref": "#/components/examples/ProvisioningConnectionOauthO365RequestEx" + }, + "ProvisioningConnectionTokenOrg2OrgEx": { + "$ref": "#/components/examples/ProvisioningConnectionTokenOrg2OrgRequestEx" + }, + "ProvisioningConnectionTokenZscalerEx": { + "$ref": "#/components/examples/ProvisioningConnectionTokenRequestEx" + } + }, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ProvisioningConnectionTokenRequest" + }, + { + "$ref": "#/components/schemas/ProvisioningConnectionOauthRequest" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ProvisioningConnectionOAuthOrg2OrgEx": { + "$ref": "#/components/examples/ProvisioningConnectionOAuthOrg2OrgWithRotationResponseEx" + }, + "ProvisioningConnectionOauthO365Ex": { + "$ref": "#/components/examples/ProvisioningConnectionOauthResponseEx" + }, + "ProvisioningConnectionTokenOrg2OrgEx": { + "$ref": "#/components/examples/ProvisioningConnectionTokenResponseWithProfileOrg2OrgEx" + }, + "ProvisioningConnectionTokenZscalerEx": { + "$ref": "#/components/examples/ProvisioningConnectionTokenResponseWithProfileZscalerEx" + } + }, + "schema": { + "$ref": "#/components/schemas/ProvisioningConnectionResponse" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Update the default provisioning connection", + "tags": [ + "ApplicationConnections" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/connections/default/jwks": { + "get": { + "description": "Retrieves a JWKS for the default provisioning connection. This can be used by the OAuth 2.0 app's `jwk_uri` property in the target org.", + "operationId": "getUserProvisioningConnectionJWKS", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UserProvisioningJsonWebKeysResponseExample": { + "$ref": "#/components/examples/UserProvisioningJsonWebKeysResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/AppConnectionUserProvisionJWKResponse" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve a JSON Web Key Set (JWKS) for the default provisioning connection", + "tags": [ + "ApplicationConnections" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isCorsEnabled": true, + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/{appId}/connections/default/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Activates the default provisioning connection for an app", + "operationId": "activateDefaultProvisioningConnectionForApplication", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Activate the default provisioning connection", + "tags": [ + "ApplicationConnections" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/connections/default/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Deactivates the default provisioning connection for an app", + "operationId": "deactivateDefaultProvisioningConnectionForApplication", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Deactivate the default provisioning connection", + "tags": [ + "ApplicationConnections" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/credentials/csrs": { + "get": { + "description": "Lists all certificate signing requests for an app", + "operationId": "listCsrsForApplication", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Csr" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "List all certificate signing requests", + "tags": [ + "ApplicationSSOCredentialKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Generates a new key pair and returns the certificate signing request (CSR) for it. The information in a CSR is used by the Certificate Authority (CA) to verify and create your certificate. It also contains the public key that's included in your certificate.\n\nReturns CSR in `pkcs#10` format if the `Accept` media type is `application/pkcs10` or a CSR object if the `Accept` media type is `application/json`.\n> **Note:** The key pair isn't listed in the key credentials for the app until it's published.", + "operationId": "generateCsrForApplication", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CsrMetadata" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "CsrJsonResponse": { + "$ref": "#/components/examples/AppCsrJsonResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Csr" + } + }, + "application/pkcs10": { + "examples": { + "CsrPkcs10Response": { + "$ref": "#/components/examples/AppCsrPkcs10Response" + } + }, + "schema": { + "$ref": "#/components/schemas/AppCsrPkcs10" + } + } + }, + "description": "Created", + "headers": { + "Content-Transfer-Encoding": { + "description": "Encoding of the response", + "example": "base64", + "schema": { + "type": "string" + } + }, + "Content-Type": { + "description": "The Content-Type of the response", + "examples": { + "json": { + "summary": "application/json Content-Type header", + "value": "application/json" + }, + "pkcs10Header": { + "summary": "application/pkcs10 Content-Type header", + "value": "application/pkcs10; filename=okta.p10" + } + }, + "schema": { + "type": "string" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Generate a certificate signing request", + "tags": [ + "ApplicationSSOCredentialKey" + ], + "x-codegen-request-body-name": "metadata", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/credentials/csrs/{csrId}": { + "delete": { + "description": "Revokes a certificate signing request and deletes the key pair from the app", + "operationId": "revokeCsrFromApplication", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Revoke a certificate signing request", + "tags": [ + "ApplicationSSOCredentialKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a certificate signing request (CSR) for the app by `csrId`.\n\nReturns a Base64-encoded CSR in DER format if the `Accept` media type is `application/pkcs10` or a CSR object if the `Accept` media type is `application/json`.", + "operationId": "getCsrForApplication", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CsrJsonResponse": { + "$ref": "#/components/examples/AppCsrJsonResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Csr" + } + }, + "application/pkcs10": { + "examples": { + "CsrPkcs10Response": { + "$ref": "#/components/examples/AppCsrPkcs10Response" + } + }, + "schema": { + "$ref": "#/components/schemas/AppCsrPkcs10" + } + } + }, + "description": "Success", + "headers": { + "Content-Transfer-Encoding": { + "description": "Encoding of the response", + "example": "base64", + "schema": { + "type": "string" + } + }, + "Content-Type": { + "description": "The Content-Type of the response", + "examples": { + "json": { + "summary": "application/json Content-Type header", + "value": "application/json" + }, + "pkcs10Header": { + "summary": "application/pkcs10 Content-Type header", + "value": "application/pkcs10; filename=okta.p10" + } + }, + "schema": { + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve a certificate signing request", + "tags": [ + "ApplicationSSOCredentialKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathCsrId" + } + ] + }, + "/api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathCsrId" + } + ], + "post": { + "description": "Publishes a certificate signing request (CSR) for the app with a signed X.509 certificate and adds it into the application key credentials.\n> **Note:** Publishing a certificate completes the lifecycle of the CSR and it's no longer accessible.", + "operationId": "publishCsrFromApplication", + "requestBody": { + "content": { + "application/pkix-cert": { + "schema": { + "description": "X.509 certificate in `DER` format.\nThe client can either post in binary or Base64URL-encoded. If the post is Base64URL-encoded, set the `Content-Transfer-Encoding` header to `base64`.", + "example": "MIIFgjCCA2qgAwIBAgICEAcwDQYJKoZIhvcNAQELBQAwXjELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMQ0wCwYDVQQKDARPa3RhMQwwCgYDVQQLDANFbmcxDTALBgNVBAMMBFJvb3QwHhcNMTcwMzI3MjEyMDQ3WhcNMTgwNDA2MjEyMDQ3WjB4MQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzETMBEGA1UECgwKT2t0YSwgSW5jLjEQMA4GA1UECwwHSmFua3lDbzEVMBMGA1UEAwwMSWRQIElzc3VlciA3MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmkC6yAJVvFwUlmM9gKjb2d+YK5qHFt+mXSsbjWKKs4EfNm+BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL/q7n0f/SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH+bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQIDAQABo4IBLjCCASowCQYDVR0TBAIwADARBglghkgBhvhCAQEEBAMCBkAwMwYJYIZIAYb4QgENBCYWJE9wZW5TU0wgR2VuZXJhdGVkIFNlcnZlciBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQUVqJukDmyENw/2pTApbxc/HRKbngwgZAGA1UdIwSBiDCBhYAUFx245ZZXqWTTbARfMlFWN77L9EahYqRgMF4xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJDQTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEMMAoGA1UECwwDRW5nMQ0wCwYDVQQDDARSb290ggkAlIfpwZjO5o8wDgYDVR0PAQH/BAQDAgWgMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUAA4ICAQCcoBSRtY+9cJY00hLvq6AloYZcdn/kUQupfmyz4n3lKE3wV2FB0swKnK0QDi8iNuQJFdag/19vDHC4/LhoSuv1Q+KXM61pPZVRXXPyC1+e7Y6hj93tEI5HcqLPcDRH1AIG2l8tE7LBn+MQB5Vh6oxjG2IdoWxg6abMfISU+MauPWql4vMDUWo9iNShAo44Z5fd+nuz+hlAinU9Xn9Jf2QsfKvcbMRq7iuqgkabgdmObmWb9KK0Vm7TDkxCH0pB0onPr6epVUP8Obg/pT1Oj/1hOLbfR8CHHWdAWzUBGGvp2TIy2A8LUaEoFnwkxZfdL7Bnd0RH/ClBtAjzLOxmUo7NbZmEnYCcD5pZz7BdZI0db/eBXFqfOlA88rEe+9Sv+NndIq0/WNIIsJi2RgjJnxsxvB5MjhhzmItpFIUl5yqoO3C9jcCp6HDBJxtCGbvAr5ALPn5RCJeBIr67WpAiTd7L3Ebu9SQZlXnoHX8kP04EA6ylR3W0EFbh7KUtq8M2H2vo0wjMj7ysl/3tT7cEZ97s1ygO5iJx3GfMDyrDhtLXSBJ20uSxTJeptRw8SDiwTqunIh1WyKlcQz1WGauSbW4eXdj/r9KYMJ3qMMkdP/9THQUtTcOYx51r8RV9pdzqF2HPnZZNziBa+wXJZHEWp70NyoakNthgYwtypqiDHs2f3Q==", + "format": "binary", + "type": "string", + "x-okta-operationId": "publishBinaryDerCert" + } + }, + "application/x-pem-file": { + "schema": { + "description": "X.509 certificate in `PEM` format", + "example": "@certificate.pem", + "format": "binary", + "type": "string", + "x-okta-operationId": "publishBinaryPemCert" + } + }, + "application/x-x509-ca-cert": { + "schema": { + "description": "X.509 certificate in `CER` format.\nThe client can either post in binary or Base64URL-encoded. If the post is Base64URL-encoded, set the `Content-Transfer-Encoding` header to `base64`.", + "example": "@certificate.pem", + "format": "binary", + "type": "string", + "x-okta-operationId": "publishBinaryCerCert" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "PublishCSR": { + "$ref": "#/components/examples/KeyCredentialExample" + } + }, + "schema": { + "$ref": "#/components/schemas/JsonWebKey" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorPublishCSRCertDoesNotMatchCSR": { + "$ref": "#/components/examples/ErrorPublishCSRCertDoesNotMatchCSR" + }, + "ErrorPublishCSRCertValidityLessThan90Days": { + "$ref": "#/components/examples/ErrorPublishCSRCertValidityLessThan90Days" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Publish a certificate signing request", + "tags": [ + "ApplicationSSOCredentialKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/credentials/jwks": { + "get": { + "description": "Lists all JSON Web Keys for an OAuth 2.0 client app", + "operationId": "listJwk", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OAuthClientJsonWebKeyListResponseExample": { + "$ref": "#/components/examples/oAuthClientJsonWebKeyListResponse" + } + }, + "schema": { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonSigningKeyResponse" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonEncryptionKeyResponse" + } + ] + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "List all the OAuth 2.0 client JSON Web Keys", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Adds a new JSON Web Key to the client`s JSON Web Keys.\n> **Note:** This API doesn't allow you to add a key if the existing key doesn't have a `kid`. This is also consistent with how the [Dynamic Client Registration](/openapi/okta-oauth/oauth/client) or [Applications](/openapi/okta-management/management/tags/application) APIs behave, as they don't allow the creation of multiple keys without `kids`. Use the [Replace an Application](/openapi/okta-management/management/application/replaceapplication) or the [Replace a Client Application](/openapi/okta-oauth/oauth/client/replaceclient) operation to update the JWKS or [Delete an OAuth 2.0 Client JSON Web Key](/openapi/okta-management/management/applicationssopublickeys/deletejwk) and re-add the key with a `kid`.", + "operationId": "addJwk", + "requestBody": { + "content": { + "application/json": { + "examples": { + "createOAuth2ClientJsonActiveEncryptionKeyRequestBody": { + "$ref": "#/components/examples/oAuthClientJsonActiveEncryptionKeyRequest" + }, + "createOAuth2ClientJsonInactiveEncryptionKeyRequestBody": { + "$ref": "#/components/examples/oAuthClientJsonInactiveEncryptionKeyRequest" + }, + "createOAuth2ClientJsonWebKeyRequestBody": { + "$ref": "#/components/examples/oAuthClientJsonWebKeyRequest" + } + }, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonSigningKeyRequest" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonEncryptionKeyRequest" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "newOAuth2ClientJsonActiveEncryptionKeyResponse": { + "$ref": "#/components/examples/oAuthClientJsonActiveEncryptionKey" + }, + "newOAuth2ClientJsonInactiveEncryptionKeyResponse": { + "$ref": "#/components/examples/oAuthClientJsonInactiveEncryptionKey" + }, + "newOAuth2ClientJsonWebKeyResponse": { + "$ref": "#/components/examples/oAuthClientJsonWebKey" + } + }, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonSigningKeyResponse" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonEncryptionKeyResponse" + } + ] + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorClientJsonWebKeyDuplicateKid": { + "$ref": "#/components/examples/ErrorClientJsonWebKeyDuplicateKid" + }, + "ErrorClientJsonWebKeyKidLengthTooShort": { + "$ref": "#/components/examples/ErrorClientJsonWebKeyKidLengthTooShort" + }, + "ErrorClientJsonWebKeyNonUniqueKid": { + "$ref": "#/components/examples/ErrorClientJsonWebKeyNonUniqueKid" + }, + "ErrorClientJsonWebKeyTooManyKids": { + "$ref": "#/components/examples/ErrorClientJsonWebKeyTooManyKids" + }, + "ErrorOnlyOneActiveEncryptionKeyAllowed": { + "$ref": "#/components/examples/ErrorOnlyOneActiveEncryptionKeyAllowed" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Add a JSON Web Key", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/credentials/jwks/{keyId}": { + "delete": { + "description": "Deletes an OAuth 2.0 Client JSON Web Key by `keyId`. You can only delete an inactive key.", + "operationId": "deletejwk", + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorDeleteActiveJsonWebKey": { + "$ref": "#/components/examples/ErrorDeleteActiveJsonWebKey" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Delete an OAuth 2.0 client JSON Web Key", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an OAuth 2.0 client JSON Web Key by `keyId`", + "operationId": "getJwk", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OAuthClientJsonWebKeyResponseExample": { + "$ref": "#/components/examples/oAuthClientJsonWebKey" + } + }, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonSigningKeyResponse" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonEncryptionKeyResponse" + } + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve an OAuth 2.0 client JSON Web Key", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathJsonWebKeyId" + } + ] + }, + "/api/v1/apps/{appId}/credentials/jwks/{keyId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathJsonWebKeyId" + } + ], + "post": { + "description": "Activates an OAuth 2.0 client JSON Web Key by `keyId`\n> **Note:** You can have only one active encryption key at any given time for an app. When you activate an inactive key, the current active key is automatically deactivated.", + "operationId": "activateOAuth2ClientJsonWebKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "activateOAuth2ClientJsonWebKeyResponse": { + "$ref": "#/components/examples/oAuthClientJsonWebKey" + } + }, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuth2ClientJsonSigningKeyResponse" + }, + { + "$ref": "#/components/schemas/OAuth2ClientJsonEncryptionKeyResponse" + } + ] + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Activate an OAuth 2.0 client JSON Web Key", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/credentials/jwks/{keyId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathJsonWebKeyId" + } + ], + "post": { + "description": "Deactivates an OAuth 2.0 client JSON Web Key by `keyId`\n> **Note:** You can only deactivate signing keys. Deactivating the active encryption key isn't allowed if the client has ID token encryption enabled. You can activate another encryption key, which makes the current key inactive.", + "operationId": "deactivateOAuth2ClientJsonWebKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "deactivateOAuth2ClientJsonWebKeyResponse": { + "$ref": "#/components/examples/deactivateOAuth2ClientJsonWebKeyResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ClientJsonSigningKeyResponse" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorDeactivateEncryptionKey": { + "$ref": "#/components/examples/ErrorDeactivateEncryptionKey" + }, + "ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod": { + "$ref": "#/components/examples/ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod" + }, + "ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm": { + "$ref": "#/components/examples/ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Deactivate an OAuth 2.0 client JSON Web Key", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/credentials/keys": { + "get": { + "description": "Lists all key credentials for an app", + "operationId": "listApplicationKeys", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAllKeyCredentialsExample": { + "$ref": "#/components/examples/ListAllKeyCredentialsExample" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/JsonWebKey" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "List all key credentials", + "tags": [ + "ApplicationSSOCredentialKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/{appId}/credentials/keys/generate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Generates a new X.509 certificate for an app key credential\n> **Note:** To update an app with the newly generated key credential, use the [Replace an Application](/openapi/okta-management/management/application/replaceapplication) request with the new [credentials.signing.kid](/openapi/okta-management/management/application/replaceapplication#application/replaceapplication/t=request&path=&d=0/credentials/signing/kid) value in the request body. You can provide just the [signing credential object](/openapi/okta-management/management/application/replaceapplication#application/replaceapplication/t=request&path=&d=0/credentials/signing) instead of the entire [application credential object](/openapi/okta-management/management/application/replaceapplication#application/replaceapplication/t=response&c=200&path=&d=0/credentials).", + "operationId": "generateApplicationKey", + "parameters": [ + { + "description": "Expiry years of the application key credential", + "in": "query", + "name": "validityYears", + "required": true, + "schema": { + "example": 5, + "type": "integer" + } + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "KeyCredentialExample": { + "$ref": "#/components/examples/KeyCredentialExample" + } + }, + "schema": { + "$ref": "#/components/schemas/JsonWebKey" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorKeyCredentialInvalidValidity": { + "$ref": "#/components/examples/ErrorKeyCredentialInvalidValidity" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Generate a key credential", + "tags": [ + "ApplicationSSOCredentialKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/credentials/keys/{keyId}": { + "get": { + "description": "Retrieves a specific application key credential by `kid`", + "operationId": "getApplicationKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "KeyCredentialExample": { + "$ref": "#/components/examples/KeyCredentialExample" + } + }, + "schema": { + "$ref": "#/components/schemas/JsonWebKey" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve a key credential", + "tags": [ + "ApplicationSSOCredentialKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathKeyId" + } + ] + }, + "/api/v1/apps/{appId}/credentials/keys/{keyId}/clone": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathKeyId" + } + ], + "post": { + "description": "Clones an X.509 certificate for an application key credential from a source app to a target app.\n\nFor step-by-step instructions to clone a credential, see [Share application key credentials for IdPs across apps](https://developer.okta.com/docs/guides/sharing-cert/main/).\n> **Note:** Sharing certificates isn't a recommended security practice.", + "operationId": "cloneApplicationKey", + "parameters": [ + { + "description": "Unique key of the target app", + "in": "query", + "name": "targetAid", + "required": true, + "schema": { + "example": "0ouuytCAJSSDELFTUIDS", + "type": "string" + } + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "KeyCredentialExample": { + "$ref": "#/components/examples/KeyCredentialExample" + } + }, + "schema": { + "$ref": "#/components/schemas/JsonWebKey" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorKeyCredentialCloneDuplicateKey": { + "$ref": "#/components/examples/ErrorKeyCredentialCloneDuplicateKey" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Clone a key credential", + "tags": [ + "ApplicationSSOCredentialKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/credentials/secrets": { + "get": { + "description": "Lists all client secrets for an OAuth 2.0 client app", + "operationId": "listOAuth2ClientSecrets", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OAuthClientSecretListResponseExample": { + "$ref": "#/components/examples/oAuthClientSecretListResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2ClientSecret" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "List all OAuth 2.0 client secrets", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Creates an OAuth 2.0 client secret object with a new active client secret. You can create up to two secret objects. An error is returned if you attempt to create more than two secret objects.\n> **Note:** This API lets you bring your own secret. If [token_endpoint_auth_method](/openapi/okta-oauth/oauth/client/createclient#client/createclient/t=request&path=token_endpoint_auth_method) of the app is `client_secret_jwt`, then the minimum length of `client_secret` is 32 characters. If no secret is specified in the request, Okta adds a new system-generated secret.", + "operationId": "createOAuth2ClientSecret", + "requestBody": { + "content": { + "application/json": { + "examples": { + "createOAuth2ClientSecretCustomRequestBody": { + "$ref": "#/components/examples/createOAuth2ClientSecretCustomRequestBody" + }, + "createOAuth2ClientSecretSystemGeneratedRequestBody": { + "$ref": "#/components/examples/createOAuth2ClientSecretSystemGeneratedRequestBody" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ClientSecretRequestBody" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "newOAuth2ClientSecretResponse": { + "$ref": "#/components/examples/oAuth2ClientSecretResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ClientSecret" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorClientSecretNonAscii": { + "$ref": "#/components/examples/ErrorClientSecretNonAscii" + }, + "ErrorClientSecretPrivateKeyJWT": { + "$ref": "#/components/examples/ErrorClientSecretWithPrivateKeyJWT" + }, + "ErrorClientSecretTooLong": { + "$ref": "#/components/examples/ErrorClientSecretTooLong" + }, + "ErrorClientSecretTooShort": { + "$ref": "#/components/examples/ErrorClientSecretTooShort" + }, + "ErrorClientSecretTooShortJWT": { + "$ref": "#/components/examples/ErrorClientSecretTooShortWithClientSecretJWT" + }, + "ErrorMaxNumberOfSecrets": { + "$ref": "#/components/examples/ErrorMaxNumberOfSecrets" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Create an OAuth 2.0 client secret", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/credentials/secrets/{secretId}": { + "delete": { + "description": "Deletes an OAuth 2.0 client secret by `secretId`. You can only delete an inactive secret.", + "operationId": "deleteOAuth2ClientSecret", + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorDeleteActiveClientSecret": { + "$ref": "#/components/examples/ErrorDeleteActiveSecret" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Delete an OAuth 2.0 client secret", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an OAuth 2.0 client secrets by `secretId`", + "operationId": "getOAuth2ClientSecret", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OAuthClientSecretResponseExample": { + "$ref": "#/components/examples/oAuth2ClientSecretResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ClientSecret", + "type": "object" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve an OAuth 2.0 client secret", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathClientSecretId" + } + ] + }, + "/api/v1/apps/{appId}/credentials/secrets/{secretId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathClientSecretId" + } + ], + "post": { + "description": "Activates an OAuth 2.0 client secret by `secretId`", + "operationId": "activateOAuth2ClientSecret", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "activateOAuth2ClientSecretResponse": { + "$ref": "#/components/examples/activateOAuth2ClientSecretResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ClientSecret" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Activate an OAuth 2.0 client secret", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/credentials/secrets/{secretId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathClientSecretId" + } + ], + "post": { + "description": "Deactivates an OAuth 2.0 client secret by `secretId`. You can't deactivate a secret if it's the only secret of the client.", + "operationId": "deactivateOAuth2ClientSecret", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "deactivateOAuth2ClientSecretResponse": { + "$ref": "#/components/examples/deactivateOAuth2ClientSecretResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ClientSecret" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorDeactivateTheOnlyClientSecret": { + "$ref": "#/components/examples/ErrorDeactivateTheOnlyClientSecret" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Deactivate an OAuth 2.0 client secret", + "tags": [ + "ApplicationSSOPublicKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/cwo/connections": { + "get": { + "description": "Retrieves inbound and outbound Cross App Access connections associated with an app\n", + "operationId": "getAllCrossAppAccessConnections", + "parameters": [ + { + "description": "Specifies the pagination cursor for the next page of connection results", + "in": "query", + "name": "after", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of results to return per page. The values:\n * -1: Return all results (up to system maximum)\n * 0: Return an empty result set\n * Positive integer: Return up to that many results (capped at system maximum)\n", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": -1, + "format": "int32", + "maximum": 200, + "type": "integer" + } + }, + { + "description": "Filters connections by their lifecycle status. When specified, only connections that match the specified status are returned.\n", + "example": "ACTIVE", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + } + }, + { + "description": "Filters only connections where the app with the specified ID is the requesting app", + "example": "0oa8mm6ktyXqkcs5t0g7", + "in": "query", + "name": "requestingAppId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filters only connections where the app with the specified ID is the requesting app", + "example": "0oa8mmm7ruidxWhlf0g7", + "in": "query", + "name": "resourceAppId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "When set to true, filters the result to include only connections where both the requesting and resource app have a status of ACTIVE", + "example": true, + "in": "query", + "name": "activeAppsOnly", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Filters connections where the requesting app's name matches the provided search string", + "example": "zoom", + "in": "query", + "name": "requestingAppName", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filters connections where the resource app's name matches the provided search string", + "example": "box", + "in": "query", + "name": "resourceAppName", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/OrgCrossAppAccessConnection" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve all Cross App Access connections", + "tags": [ + "ApplicationCrossAppAccessConnections" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Creates a Cross App Access connection\n", + "operationId": "createCrossAppAccessConnection", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrgCrossAppAccessConnection" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrgCrossAppAccessConnection" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Create a Cross App Access connection", + "tags": [ + "ApplicationCrossAppAccessConnections" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + } + }, + "/api/v1/apps/{appId}/cwo/connections/{connectionId}": { + "delete": { + "description": "Deletes a Cross App Access connection with the specified ID\n", + "operationId": "deleteCrossAppAccessConnection", + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Delete a Cross App Access connection", + "tags": [ + "ApplicationCrossAppAccessConnections" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "get": { + "description": "Retrieves the Cross App Access connection with the specified ID\n", + "operationId": "getCrossAppAccessConnection", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrgCrossAppAccessConnection" + } + } + }, + "description": "Success" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve a Cross App Access connection", + "tags": [ + "ApplicationCrossAppAccessConnections" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/connectionId" + } + ], + "patch": { + "description": "Updates the Cross App Access connection with the specified ID\n", + "operationId": "updateCrossAppAccessConnection", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrgCrossAppAccessConnectionPatchRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrgCrossAppAccessConnection" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Update a Cross App Access connection", + "tags": [ + "ApplicationCrossAppAccessConnections" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + } + }, + "/api/v1/apps/{appId}/express-configure/oauth2/authorize": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/{appId}/express-configure/{capabilityType}": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/capabilityType" + } + ] + }, + "/api/v1/apps/{appId}/features": { + "get": { + "description": "Lists all features for an app\n> **Note:** This request returns an error if provisioning isn't enabled for the app.\n> To set up provisioning, see [Update the default provisioning connection](/openapi/okta-management/management/applicationconnections/updatedefaultprovisioningconnectionforapplication).\n", + "operationId": "listFeaturesForApplication", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAppFeatureResponse": { + "$ref": "#/components/examples/AppFeatureListResponseEx" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/ApplicationFeature" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ListAppFeatureAPIValidationFailed": { + "$ref": "#/components/examples/ErrorAppFeatureAPIValidationFailed" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "List all features", + "tags": [ + "ApplicationFeatures" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/{appId}/features/{featureName}": { + "get": { + "description": "Retrieves a Feature object for an app", + "operationId": "getFeatureForApplication", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AppFeatureResponse": { + "$ref": "#/components/examples/AppFeatureResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/ApplicationFeature" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve a feature", + "tags": [ + "ApplicationFeatures" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathFeatureName" + } + ], + "put": { + "description": "Updates a Feature object for an app\n> **Note:** This endpoint supports partial updates.\n", + "operationId": "updateFeatureForApplication", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UpdateAppFeatureEx": { + "$ref": "#/components/examples/UpdateAppFeatureRequestEx" + }, + "UpdateInboundProvisioningFeatureEx": { + "$ref": "#/components/examples/UpdateInboundProvisioningFeatureRequestEx" + } + }, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/CapabilitiesObject" + }, + { + "$ref": "#/components/schemas/CapabilitiesInboundProvisioningObject" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UpdateAppFeatureEx": { + "$ref": "#/components/examples/UpdateAppFeatureResponseEx" + }, + "UpdateInboundProvisioningFeatureEx": { + "$ref": "#/components/examples/UpdateInboundProvisioningFeatureResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/ApplicationFeature" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Update a feature", + "tags": [ + "ApplicationFeatures" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/federated-claims": { + "get": { + "description": "Lists all federated claims for your app", + "operationId": "listFederatedClaims", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "listFederatedClaimResponse": { + "$ref": "#/components/examples/listFederatedClaimResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/FederatedClaim" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "List all configured federated claims", + "tags": [ + "ApplicationSSOFederatedClaims" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Creates a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)", + "operationId": "createFederatedClaim", + "requestBody": { + "content": { + "application/json": { + "examples": { + "createFederatedClaimRequestBody": { + "$ref": "#/components/examples/createFederatedClaimRequestBody" + } + }, + "schema": { + "$ref": "#/components/schemas/FederatedClaimRequestBody" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "federatedClaimResponse": { + "$ref": "#/components/examples/federatedClaimResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/FederatedClaim" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Create a federated claim", + "tags": [ + "ApplicationSSOFederatedClaims" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/federated-claims/{claimId}": { + "delete": { + "description": "Deletes a federated claim by `claimId`", + "operationId": "deleteFederatedClaim", + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Delete a federated claim", + "tags": [ + "ApplicationSSOFederatedClaims" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a federated claim by `claimId`", + "operationId": "getFederatedClaim", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "federatedClaimResponse": { + "$ref": "#/components/examples/federatedClaimResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/FederatedClaimRequestBody", + "type": "object" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve a federated claim", + "tags": [ + "ApplicationSSOFederatedClaims" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/claimId" + } + ], + "put": { + "description": "Replaces a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)", + "operationId": "replaceFederatedClaim", + "requestBody": { + "content": { + "application/json": { + "examples": { + "replaceFederatedClaim": { + "$ref": "#/components/examples/replaceFederatedClaimRequestBody" + } + }, + "schema": { + "$ref": "#/components/schemas/FederatedClaim" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "replaceFederatedClaimResponse": { + "$ref": "#/components/examples/replaceFederatedClaimResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/FederatedClaim" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Replace a federated claim", + "tags": [ + "ApplicationSSOFederatedClaims" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/grants": { + "get": { + "description": "Lists all scope consent Grants for the app", + "operationId": "listScopeConsentGrants", + "parameters": [ + { + "$ref": "#/components/parameters/queryAppGrantsExpand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAppGrantsExample": { + "$ref": "#/components/examples/ListAppGrantsEx" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2ScopeConsentGrant" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.appGrants.read" + ] + } + ], + "summary": "List all app grants", + "tags": [ + "ApplicationGrants" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Grants consent for the app to request an OAuth 2.0 Okta scope", + "operationId": "grantConsentToScope", + "requestBody": { + "content": { + "application/json": { + "examples": { + "AppGrantsExample": { + "$ref": "#/components/examples/AppGrantsPostEx" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ScopeConsentGrant" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "AppGrantsExample": { + "$ref": "#/components/examples/AppGrantsEx" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ScopeConsentGrant" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.appGrants.manage" + ] + } + ], + "summary": "Grant consent to scope", + "tags": [ + "ApplicationGrants" + ], + "x-codegen-request-body-name": "oAuth2ScopeConsentGrant", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/grants/{grantId}": { + "delete": { + "description": "Revokes permission for the app to grant the given scope", + "operationId": "revokeScopeConsentGrant", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.appGrants.manage" + ] + } + ], + "summary": "Revoke an app grant", + "tags": [ + "ApplicationGrants" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a single scope consent Grant object for the app", + "operationId": "getScopeConsentGrant", + "parameters": [ + { + "$ref": "#/components/parameters/queryAppGrantsExpand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AppGrantsExample": { + "$ref": "#/components/examples/AppGrantsEx" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ScopeConsentGrant" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.appGrants.read" + ] + } + ], + "summary": "Retrieve an app grant", + "tags": [ + "ApplicationGrants" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathGrantId" + } + ] + }, + "/api/v1/apps/{appId}/group-push/mappings": { + "get": { + "description": "Lists all group push mappings with pagination support", + "operationId": "listGroupPushMappings", + "parameters": [ + { + "description": "Specifies the pagination cursor for the next page of mappings", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of results returned", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "format": "int32", + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Filters group push mappings by last updated date. The `lastUpdated` parameter supports the following format: `YYYY-MM-DDTHH:mm:ssZ`. This filters mappings updated on or after the specified date and time in UTC.\n\nIf you don't specify a value, all group push mappings are returned.", + "in": "query", + "name": "lastUpdated", + "schema": { + "example": "2025-01-01T00:00:00Z", + "type": "string" + } + }, + { + "description": "Filters group push mappings by source group ID. If you don't specify a value, all group push mappings are returned.", + "in": "query", + "name": "sourceGroupId", + "schema": { + "example": "00g00000000000000000", + "type": "string" + } + }, + { + "description": "Filters group push mappings by status. If you don't specify a value, all group push mappings are returned.", + "in": "query", + "name": "status", + "schema": { + "$ref": "#/components/schemas/GroupPushMappingStatus" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "List group push mappings": { + "$ref": "#/components/examples/ListGroupPushMappingsResponse_Example" + }, + "List group push mappings with active filter": { + "$ref": "#/components/examples/ListGroupPushMappingsResponse_ExampleWithActiveFilter" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/GroupPushMapping" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read", + "okta.groups.read" + ] + } + ], + "summary": "List all group push mappings", + "tags": [ + "GroupPushMapping" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Creates or links a group push mapping.\n\n**Note:** Either `targetGroupId` or `targetGroupName` must be provided, but not both. If `targetGroupId` is provided, it links to an existing group. If `targetGroupName` is provided, it creates a new group.", + "operationId": "createGroupPushMapping", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Create group push mapping (Active Directory)": { + "$ref": "#/components/examples/CreateGroupPushMappingRequest_ExampleCreate_ActiveDirectory" + }, + "Create group push mapping (create new group)": { + "$ref": "#/components/examples/CreateGroupPushMappingRequest_ExampleCreate" + }, + "Create group push mapping (link existing group)": { + "$ref": "#/components/examples/CreateGroupPushMappingRequest_ExampleLink" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateGroupPushMappingRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "Create group push mapping": { + "$ref": "#/components/examples/CreateGroupPushMappingResponse_ExampleCreate" + }, + "Create group push mapping (Active Directory)": { + "$ref": "#/components/examples/CreateGroupPushMappingResponse_ExampleCreate_ActiveDirectory" + }, + "Create group push mapping (link existing group)": { + "$ref": "#/components/examples/CreateGroupPushMappingResponse_ExampleLink" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupPushMapping" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage", + "okta.groups.manage" + ] + } + ], + "summary": "Create a group push mapping", + "tags": [ + "GroupPushMapping" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/group-push/mappings/{mappingId}": { + "delete": { + "description": "Deletes a specific group push mapping. The group push mapping must be in an `INACTIVE` state.", + "operationId": "deleteGroupPushMapping", + "parameters": [ + { + "description": "If set to `true`, the target group is also deleted. If set to `false`, the target group isn't deleted.", + "in": "query", + "name": "deleteTargetGroup", + "required": true, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden", + "headers": {} + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage", + "okta.groups.manage" + ] + } + ], + "summary": "Delete a group push mapping", + "tags": [ + "GroupPushMapping" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a group push mapping by ID", + "operationId": "getGroupPushMapping", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Retrieve group push mapping": { + "$ref": "#/components/examples/RetrieveGroupPushMappingResponse_Example" + }, + "Retrieve group push mapping (Active Directory)": { + "$ref": "#/components/examples/RetrieveGroupPushMappingResponse_Example_ActiveDirectory" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupPushMapping" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read", + "okta.groups.read" + ] + } + ], + "summary": "Retrieve a group push mapping", + "tags": [ + "GroupPushMapping" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathGroupPushMappingId" + } + ], + "patch": { + "description": "Updates the status of a group push mapping", + "operationId": "updateGroupPushMapping", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Update group push mapping": { + "$ref": "#/components/examples/UpdateGroupPushMappingRequest_Example" + } + }, + "schema": { + "$ref": "#/components/schemas/UpdateGroupPushMappingRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Update group push mapping": { + "$ref": "#/components/examples/UpdateGroupPushMappingResponse_Example" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupPushMapping" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage", + "okta.groups.manage" + ] + } + ], + "summary": "Update a group push mapping", + "tags": [ + "GroupPushMapping" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/groups": { + "get": { + "description": "Lists all app group assignments", + "operationId": "listApplicationGroupAssignments", + "parameters": [ + { + "description": "Specifies a filter for a list of assigned groups returned based on their names. The value of `q` is matched against the group `name`.\nThis filter only supports the `startsWith` operation that matches the `q` string against the beginning of the [group name](openapi/okta-management/management/group#tag/Group/operation/listGroups!c=200&path=profile/name&t=response).", + "in": "query", + "name": "q", + "schema": { + "example": "test", + "type": "string" + } + }, + { + "description": "Specifies the pagination cursor for the `next` page of results. Treat this as an opaque value obtained through the next link relationship. See [Pagination](https://developer.okta.com/docs/api/#pagination).", + "in": "query", + "name": "after", + "schema": { + "example": 16275000448691, + "type": "string" + } + }, + { + "$ref": "#/components/parameters/queryGroupAssignmentLimit" + }, + { + "$ref": "#/components/parameters/queryGroupAssignmentWithMetadataExpand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "listGroupAssignmentsResponseExample": { + "$ref": "#/components/examples/GroupAssignmentExListResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/ApplicationGroupAssignment" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "List all application groups", + "tags": [ + "ApplicationGroups" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/{appId}/groups/{groupId}": { + "delete": { + "description": "Unassigns a Group from an app", + "operationId": "unassignApplicationFromGroup", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Unassign an application group", + "tags": [ + "ApplicationGroups" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an app group assignment", + "operationId": "getApplicationGroupAssignment", + "parameters": [ + { + "$ref": "#/components/parameters/queryGroupAssignmentWithGroupExpand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "getGroupAssignmentResponseExample": { + "$ref": "#/components/examples/EmbeddedGroupAssignmentSampleResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ApplicationGroupAssignment" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve an application group", + "tags": [ + "ApplicationGroups" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathGroupId" + } + ], + "patch": { + "description": "Updates a group assignment to an app", + "operationId": "updateGroupAssignmentToApplication", + "requestBody": { + "content": { + "application/json": { + "examples": { + "groupAssignmentPatchRequetExample": { + "$ref": "#/components/examples/GroupAssignmentPatchRequestExample" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/JsonPatchOperation" + }, + "type": "array" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "patchGroupAssignmentResponseExample": { + "$ref": "#/components/examples/GroupAssignmentPatchResponseExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ApplicationGroupAssignment" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Update an application group", + "tags": [ + "ApplicationGroups" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Assigns a [Group](/openapi/okta-management/management/tags/group) to an app, which in turn assigns the app to each [User](/openapi/okta-management/management/tags/user) that belongs to the group.\nThe resulting application user [scope](/openapi/okta-management/management/applicationusers/listapplicationusers#applicationusers/listapplicationusers/t=response&c=200&path=scope) is `GROUP` since the assignment was from the group membership.", + "operationId": "assignGroupToApplication", + "requestBody": { + "content": { + "application/json": { + "examples": { + "putGroupAssignmentRequestExample": { + "$ref": "#/components/examples/GroupAssignmentPutRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ApplicationGroupAssignment" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "putGroupAssignmentResponseExample": { + "$ref": "#/components/examples/GroupAssignmentPutResponseExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ApplicationGroupAssignment" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Assign an application group", + "tags": [ + "ApplicationGroups" + ], + "x-codegen-request-body-name": "applicationGroupAssignment", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/interclient-allowed-apps": { + "get": { + "description": "Lists all apps allowed by this app to request interclient SSO using the interclient token", + "operationId": "listInterclientAllowedApplications", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListInterclientAllowedAppsResponse": { + "$ref": "#/components/examples/ListInterclientAllowedAppsResponse" + } + }, + "schema": { + "description": "A list of allowed app IDs", + "items": { + "description": "The ID of an allowed app", + "type": "string" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.interclientTrust.read" + ] + } + ], + "summary": "List all allowed apps for a target app", + "tags": [ + "ApplicationInterclientTrustMappings" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Creates a mapping between the target app and an allowed app for interclient SSO using the interclient token", + "operationId": "createInterclientTrustMapping", + "requestBody": { + "content": { + "application/json": { + "examples": { + "createInterclientTrustMappingRequest": { + "$ref": "#/components/examples/createInterclientTrustMappingRequestBody" + } + }, + "schema": { + "$ref": "#/components/schemas/InterclientTrustMappingRequestBody" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "createInterclientTrustMappingResponse": { + "$ref": "#/components/examples/InterclientTrustMappingResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/InterclientTrustMapping" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorTargetAppType": { + "$ref": "#/components/examples/ErrorTargetAppType" + }, + "ErrorTooManyAllowedApps": { + "$ref": "#/components/examples/ErrorTooManyAllowedApps" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.interclientTrust.manage" + ] + } + ], + "summary": "Create an allowed app mapping for a target app", + "tags": [ + "ApplicationInterclientTrustMappings" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + } + }, + "/api/v1/apps/{appId}/interclient-allowed-apps/{allowedAppId}": { + "delete": { + "description": "Deletes the mapping between the target app and an allowed app", + "operationId": "deleteInterclientTrustMapping", + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.interclientTrust.manage" + ] + } + ], + "summary": "Delete an interclient trust mapping", + "tags": [ + "ApplicationInterclientTrustMappings" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/appIdToDelete" + } + ] + }, + "/api/v1/apps/{appId}/interclient-target-apps": { + "get": { + "description": "Lists all the target apps that allow this app to request interclient SSO using an interclient token", + "operationId": "listInterclientTargetApplications", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListInterclientTargetAppsResponse": { + "$ref": "#/components/examples/ListInterclientTargetAppsResponse" + } + }, + "schema": { + "description": "A list of target app IDs", + "items": { + "description": "The ID of the target app", + "type": "string" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.interclientTrust.read" + ] + } + ], + "summary": "List all target apps for an allowed app", + "tags": [ + "ApplicationInterclientTrustMappings" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/{appId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Activates an inactive application", + "operationId": "activateApplication", + "responses": { + "200": { + "content": {}, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Activate an application", + "tags": [ + "Application" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Deactivates an active application\n\n> **Note:** Deactivating an app triggers a full reconciliation of all users assigned to the app by groups. This reconcile process removes the app assignment for the deactivated app, and might also correct assignments that were supposed to be removed but failed previously.", + "operationId": "deactivateApplication", + "responses": { + "200": { + "content": {}, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Deactivate an application", + "tags": [ + "Application" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/logo": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Uploads a logo for the app instance.\nIf the app already has a logo, this operation replaces the previous logo.\n\nThe logo is visible in the Admin Console as an icon for your app instance.\nIf you have one `appLink` object configured, this logo also appears in the End-User Dashboard as an icon for your app.\n> **Note:** If you have multiple `appLink` objects, use the Admin Console to add logos for each app link.\n> You can't use the API to add logos for multiple app links.\n", + "operationId": "uploadApplicationLogo", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "file": { + "description": "The image file containing the logo.\n\nThe file must be in PNG, JPG, SVG, or GIF format, and less than one MB in size.\nFor best results, use an image with a transparent background and a square dimension of 200 x 200 pixels to prevent upscaling.\n\n> **Notes:**\n> * Only SVG files encoded in UTF-8 are supported. For example, `<xml version=\"1.0\" encoding=\"UTF-8\">` is a valid SVG file declaration.\n> * `multipart/form-data` isn't supported for Python. Remove the `\"Content-Type\": \"multipart/form-data\"` line if you use the Python request sample code.\n", + "format": "binary", + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "Content Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Upload an application logo", + "tags": [ + "ApplicationLogos" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appId}/policies/{policyId}": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathPolicyId" + } + ], + "put": { + "description": "Assigns an app to an [app sign-in policy](/openapi/okta-management/management/tags/policy/), identified by `policyId`.\nIf the app was previously assigned to another policy, this operation replaces that assignment with the updated policy identified by `policyId`.\n\n> **Note:** When you [merge duplicate app sign-in policies](https://help.okta.com/okta_help.htm?type=oie&id=ext-merge-auth-policies),\nthe policy and mapping CRUD operations may be unavailable during the consolidation. When the consolidation is complete, you receive an email with merged results.", + "operationId": "assignApplicationPolicy", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Assign an app sign-in policy", + "tags": [ + "ApplicationPolicies" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/apps/{appId}/sso/saml/metadata": { + "get": { + "description": "Previews the SSO SAML metadata for an application", + "operationId": "previewSAMLmetadataForApplication", + "parameters": [ + { + "in": "query", + "name": "kid", + "required": true, + "schema": { + "example": "mXtzOtml09Dg1ZCeKxTRBo3KrQuBWFkJ5oxhVagjTzo", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "text/xml": { + "examples": { + "previewSAML": { + "summary": "SAML metadata example", + "value": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"exk39sivhuytV2D8H0h7\">\n <md:IDPSSODescriptor WantAuthnRequestsSigned=\"false\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\">\n <md:KeyDescriptor use=\"signing\">\n <ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\">\n <ds:X509Data>\n <ds:X509Certificate>MIIDqDCCApCgAwIBAgIGAVGNO4qeMA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEG\nA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU\nMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJ\nARYNaW5mb0Bva3RhLmNvbTAeFw0xNTEyMTAxODUwMDhaFw0xNzEyMTAxODUxMDdaMIGUMQswCQYD\nVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsG\nA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEc\nMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\nggEBALAakG48bgcTWHdwmVLHig0mkiRejxIVm3wbzrNSJcBruTq2zCYZ1rGfVxTYON8kJqvkXPmv\nkzWKhpEkvhubL+mx29XpXY0AsNIfgcm5xIV56yhXSvlMdqzGo3ciRwoACaF+ClNLxmXK9UTZD89B\nbVVGCG5AEvja0eCQ0GYsO5i9aSI5aTroab8Aew31PuWl/RGQWmjVy8+7P4wwkKKJNKCpxMYDlhfa\nWRp0zwUSbUCO0qEyeAYdZx6CLES4FGrDi/7D6G+ewWC+kbz1tL1XpF2Dcg3+IOlHrV6VWzz3rG39\nv9zFIncjvoQJFDGWhpqGqcmXvgH0Ze3SVcVF01T+bK0CAwEAATANBgkqhkiG9w0BAQUFAAOCAQEA\nAHmnSZ4imjNrIf9wxfQIcqHXEBoJ+oJtd59cw1Ur/YQY9pKXxoglqCQ54ZmlIf4GghlcZhslLO+m\nNdkQVwSmWMh6KLxVM18/xAkq8zyKbMbvQnTjFB7x45bgokwbjhivWqrB5LYHHCVN7k/8mKlS4eCK\nCi6RGEmErjojr4QN2xV0qAqP6CcGANgpepsQJCzlWucMFKAh0x9Kl8fmiQodfyLXyrebYsVnLrMf\njxE1b6dg4jKvv975tf5wreQSYZ7m//g3/+NnuDKkN/03HqhV7hTNi1fyctXk8I5Nwgyr+pT5LT2k\nYoEdncuy+GQGzE9yLOhC4HNfHQXpqp2tMPdRlw==</ds:X509Certificate>\n </ds:X509Data>\n </ds:KeyInfo>\n </md:KeyDescriptor>\n <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat>\n <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>\n <md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://{yourOktaDomain}/app/sample-app/exk39sivhuytV2D8H0h7/sso/saml\"/>\n <md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://{yourOktaDomain}/app/sample-app/exk39sivhuytV2D8H0h7/sso/saml\"/>\n </md:IDPSSODescriptor>\n</md:EntityDescriptor>\n" + } + }, + "schema": { + "description": "SAML metadata in XML", + "type": "string" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Preview the application SAML metadata", + "tags": [ + "ApplicationSSO" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/{appId}/tokens": { + "delete": { + "description": "Revokes all OAuth 2.0 refresh tokens for the specified app. Any access tokens issued with these refresh tokens are also revoked, but access tokens issued without a refresh token aren't affected.", + "operationId": "revokeOAuth2TokensForApplication", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Revoke all application tokens", + "tags": [ + "ApplicationTokens" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Lists all refresh tokens for an app\n\n> **Note:** The results are [paginated](/#pagination) according to the `limit` parameter.\n> If there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it).\n", + "operationId": "listOAuth2TokensForApplication", + "parameters": [ + { + "$ref": "#/components/parameters/queryAppGrantsExpand" + }, + { + "$ref": "#/components/parameters/queryAppAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "getOAuth2TokenForApplicationListExample": { + "$ref": "#/components/examples/OAuth2RefreshTokenResponseListEx" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2RefreshToken" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "List all application refresh tokens", + "tags": [ + "ApplicationTokens" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/{appId}/tokens/{tokenId}": { + "delete": { + "description": "Revokes the specified token for the specified app", + "operationId": "revokeOAuth2TokenForApplication", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Revoke an application token", + "tags": [ + "ApplicationTokens" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a refresh token for the specified app", + "operationId": "getOAuth2TokenForApplication", + "parameters": [ + { + "$ref": "#/components/parameters/queryAppGrantsExpand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "getOAuth2TokenForApplicationExample": { + "$ref": "#/components/examples/OAuth2RefreshTokenResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2RefreshToken" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve an application token", + "tags": [ + "ApplicationTokens" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathTokenId" + } + ] + }, + "/api/v1/apps/{appId}/unconfirmed-users": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ] + }, + "/api/v1/apps/{appId}/users": { + "get": { + "description": "Lists all assigned users for an app", + "operationId": "listApplicationUsers", + "parameters": [ + { + "$ref": "#/components/parameters/queryAppAfter" + }, + { + "$ref": "#/components/parameters/queryAppLimit" + }, + { + "$ref": "#/components/parameters/queryAppUserQ" + }, + { + "$ref": "#/components/parameters/queryAppUserExpand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAppUsersExample": { + "$ref": "#/components/examples/AppUserListEx" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AppUser" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "List all application users", + "tags": [ + "ApplicationUsers" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Assigns a user to an app for:\n\n * SSO only<br>\n Assignments to SSO apps typically don't include a user profile.\n However, if your SSO app requires a profile but doesn't have provisioning enabled, you can add profile attributes in the request body.\n\n * SSO and provisioning<br>\n Assignments to SSO and provisioning apps typically include credentials and an app-specific profile.\n Profile mappings defined for the app are applied first before applying any profile properties that are specified in the request body.\n > **Notes:**\n > * When Universal Directory is enabled, you can only specify profile properties that aren't defined in profile mappings.\n > * Omit mapped properties during assignment to minimize assignment errors.", + "operationId": "assignUserToApplication", + "requestBody": { + "content": { + "application/json": { + "examples": { + "AppUserProvEx": { + "$ref": "#/components/examples/AppUserAssignProvRequest" + }, + "AppUserSSOEx": { + "$ref": "#/components/examples/AppUserAssignSSORequest" + } + }, + "schema": { + "$ref": "#/components/schemas/AppUserAssignRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AppUserProvEx": { + "$ref": "#/components/examples/AppUserProvResponse" + }, + "AppUserSSOEx": { + "$ref": "#/components/examples/AppUserSSOResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/AppUser" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAppUserForbidden403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Assign an application user", + "tags": [ + "ApplicationUsers" + ], + "x-codegen-request-body-name": "appUser" + } + }, + "/api/v1/apps/{appId}/users/{userId}": { + "delete": { + "description": "Unassigns a user from an app\n\nFor directories like Active Directory and LDAP, they act as the owner of the user's credential with Okta delegating authentication (DelAuth) to that directory.\nIf this request is successful for a user when DelAuth is enabled, then the user is in a state with no password. You can then reset the user's password.\n\n> **Important:** This is a destructive operation. You can't recover the user's app profile. If the app is enabled for provisioning and configured to deactivate users, the user is also deactivated in the target app.", + "operationId": "unassignUserFromApplication", + "parameters": [ + { + "description": "Sends a deactivation email to the administrator if `true`", + "in": "query", + "name": "sendEmail", + "schema": { + "default": false, + "type": "boolean" + }, + "x-okta-added-version": "1.5.0" + } + ], + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Unassign an application user", + "tags": [ + "ApplicationUsers" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a specific user assignment for a specific app", + "operationId": "getApplicationUser", + "parameters": [ + { + "$ref": "#/components/parameters/queryAppUserExpand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GetAppUserExample": { + "$ref": "#/components/examples/AppUserProvExpandResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/AppUser" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve an application user", + "tags": [ + "ApplicationUsers" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + }, + { + "$ref": "#/components/parameters/pathAppUserId" + } + ], + "post": { + "description": "Updates the profile or credentials of a user assigned to an app", + "operationId": "updateApplicationUser", + "requestBody": { + "content": { + "application/json": { + "examples": { + "AppUserUpdateCredEx": { + "$ref": "#/components/examples/AppUserUpdateCredRequest" + }, + "AppUserUpdateProfileEx": { + "$ref": "#/components/examples/AppUserUpdateProfileRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/AppUserUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AppUserUpdateCredEx": { + "$ref": "#/components/examples/AppUserCredUpdateResponse" + }, + "AppUserUpdateProfileEx": { + "$ref": "#/components/examples/AppUserProfUpdateResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/AppUser" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorAppUserUpdateBadRequest400" + }, + "403": { + "$ref": "#/components/responses/ErrorAppUserForbidden403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Update an application user", + "tags": [ + "ApplicationUsers" + ], + "x-codegen-request-body-name": "appUser", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/apps/{appName}/{appId}/oauth2/callback": { + "parameters": [ + { + "$ref": "#/components/parameters/pathOAuthProvisioningAppName" + }, + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Verifies the OAuth 2.0-based connection as part of the OAuth 2.0 consent flow. The validation of the consent flow is the last step of the provisioning setup for an OAuth 2.0-based connection.\nCurrently, this operation only supports `office365`,`google`, `zoomus`, and `slack` apps.\n", + "operationId": "verifyProvisioningConnectionForApplication", + "parameters": [ + { + "in": "query", + "name": "code", + "schema": { + "description": "Unique string associated with each authentication request", + "type": "string" + } + }, + { + "in": "query", + "name": "state", + "schema": { + "description": "A temporary code string that the client exchanges for an access token", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Verify the provisioning connection", + "tags": [ + "ApplicationConnections" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/authenticators": { + "get": { + "description": "Lists all authenticators", + "operationId": "listAuthenticators", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OrgAuthenticatorsEx": { + "$ref": "#/components/examples/AuthenticatorsResponse" + }, + "OrgAuthenticatorsExWithWebAuthnNameAndDescription": { + "$ref": "#/components/examples/AuthenticatorsResponseWithWebAuthnNameAndDescription" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AuthenticatorBase" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.read" + ] + } + ], + "summary": "List all authenticators", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "post": { + "description": "Creates an authenticator", + "operationId": "createAuthenticator", + "parameters": [ + { + "description": "Whether to execute the activation lifecycle operation when Okta creates the authenticator", + "in": "query", + "name": "activate", + "schema": { + "default": true, + "type": "boolean" + } + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/AuthenticatorRequestBody" + }, + "responses": { + "200": { + "$ref": "#/components/responses/AuthenticatorResponse" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Create an authenticator", + "tags": [ + "Authenticator" + ], + "x-codegen-request-body-name": "authenticator", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/authenticators/{authenticatorId}": { + "get": { + "description": "Retrieves an authenticator from your Okta organization by `authenticatorId`", + "operationId": "getAuthenticator", + "responses": { + "200": { + "$ref": "#/components/responses/AuthenticatorResponse" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.read" + ] + } + ], + "summary": "Retrieve an authenticator", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthenticatorId" + } + ], + "put": { + "description": "Replaces the properties for an authenticator identified by `authenticatorId`", + "operationId": "replaceAuthenticator", + "requestBody": { + "$ref": "#/components/requestBodies/AuthenticatorRequestBody" + }, + "responses": { + "200": { + "$ref": "#/components/responses/AuthenticatorResponse" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Replace an authenticator", + "tags": [ + "Authenticator" + ], + "x-codegen-request-body-name": "authenticator", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/authenticators/{authenticatorId}/aaguids": { + "get": { + "description": "Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org\n\nOnly custom AAGUIDs that an admin has created are returned.", + "operationId": "listAllCustomAAGUIDs", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "default": { + "$ref": "#/components/examples/AllCustomAAGUIDResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/AllCustomAAGUIDResponseObject" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.read" + ] + } + ], + "summary": "List all custom AAGUIDs", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthenticatorId" + } + ], + "post": { + "description": "Creates a custom AAGUID for the Passkey (FIDO2 WebAuthn) authenticator", + "operationId": "createCustomAAGUID", + "requestBody": { + "content": { + "application/json": { + "examples": { + "default": { + "$ref": "#/components/examples/CustomAAGUIDRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomAAGUIDCreateRequestObject" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "default": { + "$ref": "#/components/examples/CustomAAGUIDResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomAAGUIDResponseObject" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Create a custom AAGUID", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}": { + "delete": { + "description": "Deletes a custom AAGUID\n\nYou can only delete custom AAGUIDs that an admin has created.", + "operationId": "deleteCustomAAGUID", + "responses": { + "204": { + "description": "Deleted" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Delete a custom AAGUID", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a custom AAGUID", + "operationId": "getCustomAAGUID", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "default": { + "$ref": "#/components/examples/CustomAAGUIDResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomAAGUIDResponseObject" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.read" + ] + } + ], + "summary": "Retrieve a custom AAGUID", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthenticatorId" + }, + { + "$ref": "#/components/parameters/pathAAGUID" + } + ], + "patch": { + "description": "Updates the properties of a custom AAGUID by the `authenticatorId` and `aaguid` ID", + "operationId": "updateCustomAAGUID", + "requestBody": { + "content": { + "application/merge-patch+json": { + "examples": { + "default": { + "$ref": "#/components/examples/CustomAAGUIDUpdateRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomAAGUIDUpdateRequestObject" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "default": { + "$ref": "#/components/examples/CustomAAGUIDResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomAAGUIDResponseObject" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Update a custom AAGUID", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces a custom AAGUID for the specified Passkey (FIDO2 WebAuthn) authenticator", + "operationId": "replaceCustomAAGUID", + "requestBody": { + "content": { + "application/json": { + "examples": { + "default": { + "$ref": "#/components/examples/CustomAAGUIDUpdateRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomAAGUIDUpdateRequestObject" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "default": { + "$ref": "#/components/examples/CustomAAGUIDResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomAAGUIDResponseObject" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Replace a custom AAGUID", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authenticators/{authenticatorId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthenticatorId" + } + ], + "post": { + "description": "Activates an authenticator by `authenticatorId`", + "operationId": "activateAuthenticator", + "responses": { + "200": { + "$ref": "#/components/responses/AuthenticatorResponse" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Activate an authenticator", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/authenticators/{authenticatorId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthenticatorId" + } + ], + "post": { + "description": "Deactivates an authenticator by `authenticatorId`", + "operationId": "deactivateAuthenticator", + "responses": { + "200": { + "$ref": "#/components/responses/AuthenticatorResponseInactiveWebAuthn" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Deactivate an authenticator", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/authenticators/{authenticatorId}/methods": { + "get": { + "description": "Lists all methods of an authenticator identified by `authenticatorId`", + "operationId": "listAuthenticatorMethods", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Phone": { + "$ref": "#/components/examples/AuthenticatorMethodPhone" + }, + "TAC": { + "$ref": "#/components/examples/AuthenticatorMethodTac" + }, + "WebAuthn": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthn" + }, + "WebAuthnWithRebrandSettings": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthnWithRebrandSettings" + }, + "WebAuthnWithRpId": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthnWithRpId" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.read" + ] + } + ], + "summary": "List all methods of an authenticator", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthenticatorId" + } + ] + }, + "/api/v1/authenticators/{authenticatorId}/methods/{methodType}": { + "get": { + "description": "Retrieves a method identified by `methodType` of an authenticator identified by `authenticatorId`", + "operationId": "getAuthenticatorMethod", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "WebAuthnWithRebrandSettings": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthnWithRebrandSettings" + }, + "sms": { + "$ref": "#/components/examples/AuthenticatorMethodSms" + }, + "tac": { + "$ref": "#/components/examples/AuthenticatorMethodTac" + }, + "voice": { + "$ref": "#/components/examples/AuthenticatorMethodInactiveVoice" + }, + "webauthn": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthn" + }, + "webauthnWithRpId": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthnWithRpId" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.read" + ] + } + ], + "summary": "Retrieve an authenticator method", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthenticatorId" + }, + { + "$ref": "#/components/parameters/pathMethodType" + } + ], + "put": { + "description": "Replaces a method of `methodType` for an authenticator identified by `authenticatorId`", + "operationId": "replaceAuthenticatorMethod", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "sms": { + "$ref": "#/components/examples/AuthenticatorMethodSms" + }, + "tac": { + "$ref": "#/components/examples/AuthenticatorMethodTac" + }, + "voice": { + "$ref": "#/components/examples/AuthenticatorMethodInactiveVoice" + }, + "webauthn": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthn" + }, + "webauthnWithRebrandSettings": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthnWithRebrandSettings" + }, + "webauthnWithRpId": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthnWithRpId" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Replace an authenticator method", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthenticatorId" + }, + { + "$ref": "#/components/parameters/pathMethodType" + } + ], + "post": { + "description": "Activates a method for an authenticator identified by `authenticatorId` and `methodType`", + "operationId": "activateAuthenticatorMethod", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "sms": { + "$ref": "#/components/examples/AuthenticatorMethodSms" + }, + "tac": { + "$ref": "#/components/examples/AuthenticatorMethodTac" + }, + "webauthn": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthn" + }, + "webauthnWithRpId": { + "$ref": "#/components/examples/AuthenticatorMethodWebAuthnWithRpId" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Activate an authenticator method", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthenticatorId" + }, + { + "$ref": "#/components/parameters/pathMethodType" + } + ], + "post": { + "description": "Deactivates a method for an authenticator identified by `authenticatorId` and `methodType`", + "operationId": "deactivateAuthenticatorMethod", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "voice": { + "$ref": "#/components/examples/AuthenticatorMethodInactiveVoice" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorMethodBase" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Deactivate an authenticator method", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/authenticators/{authenticatorId}/methods/{webAuthnMethodType}/verify-rp-id-domain": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthenticatorId" + }, + { + "$ref": "#/components/parameters/pathWebAuthnMethodType" + } + ], + "post": { + "description": "Verifies the [Relying Party identifier (RP ID)](https://www.w3.org/TR/webauthn/#relying-party-identifier) domain for the specified Passkey (FIDO2 WebAuthn) authenticator and the specific `webauthn` authenticator method", + "operationId": "verifyRpIdDomain", + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authenticators.manage" + ] + } + ], + "summary": "Verify a Relying Party ID domain", + "tags": [ + "Authenticator" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/authorizationServers": { + "get": { + "description": "Lists all custom authorization servers in the org", + "operationId": "listAuthorizationServers", + "parameters": [ + { + "description": "Searches the `name` and `audiences` of authorization servers for matching values", + "example": "customasone", + "in": "query", + "name": "q", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of authorization server results on a page. Maximum value: 200", + "in": "query", + "name": "limit", + "schema": { + "default": 200, + "format": "int32", + "type": "integer" + } + }, + { + "description": "Specifies the pagination cursor for the next page of authorization servers. Treat as an opaque value and obtain through the next link relationship.", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAuthServers": { + "$ref": "#/components/examples/ListAuthServersResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AuthorizationServer" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "List all authorization servers", + "tags": [ + "AuthorizationServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates an authorization server", + "operationId": "createAuthorizationServer", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateAuthServer": { + "$ref": "#/components/examples/CreateAuthServerBody" + }, + "CreateAuthServerWithAccessTokenEncryption": { + "$ref": "#/components/examples/CreateAuthServerWithAccessTokenEncryptionBody" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServer" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "CreateAuthServer": { + "$ref": "#/components/examples/CreateAuthServerResponse" + }, + "CreateAuthServerWithAccessTokenEncryption": { + "$ref": "#/components/examples/CreateAuthServerWithAccessTokenEncryptionResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServer" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Create an authorization server", + "tags": [ + "AuthorizationServer" + ], + "x-codegen-request-body-name": "authorizationServer", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}": { + "delete": { + "description": "Deletes an authorization server", + "operationId": "deleteAuthorizationServer", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Delete an authorization server", + "tags": [ + "AuthorizationServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an authorization server", + "operationId": "getAuthorizationServer", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "RetrieveAuthServer": { + "$ref": "#/components/examples/RetrieveAuthServerResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServer" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "Retrieve an authorization server", + "tags": [ + "AuthorizationServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ], + "put": { + "description": "Replaces an authorization server", + "operationId": "replaceAuthorizationServer", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ReplaceAuthServer": { + "$ref": "#/components/examples/ReplaceAuthServerBody" + }, + "ReplaceAuthServerEnableTokenEncryption": { + "$ref": "#/components/examples/ReplaceAuthServerEnableTokenEncryptionBody" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServer" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ReplaceAuthServer": { + "$ref": "#/components/examples/ReplaceAuthServerResponse" + }, + "ReplaceAuthServerEnableTokenEncryption": { + "$ref": "#/components/examples/ReplaceAuthServerEnableTokenEncryptionResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServer" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Replace an authorization server", + "tags": [ + "AuthorizationServer" + ], + "x-codegen-request-body-name": "authorizationServer", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/associatedServers": { + "get": { + "description": "Lists all associated Authorization Servers by trusted type for the given `authServerId`", + "operationId": "listAssociatedServersByTrustedType", + "parameters": [ + { + "description": "Searches trusted authorization servers when `true` or searches untrusted authorization servers when `false`", + "in": "query", + "name": "trusted", + "schema": { + "type": "boolean" + } + }, + { + "description": "Searches for the name or audience of the associated authorization servers", + "example": "customasone", + "in": "query", + "name": "q", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of results for a page", + "in": "query", + "name": "limit", + "schema": { + "default": 200, + "format": "int32", + "type": "integer" + } + }, + { + "description": "Specifies the pagination cursor for the next page of the associated authorization servers", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAssocAuthServer": { + "$ref": "#/components/examples/ListAssocAuthServerResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AuthorizationServer" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "List all associated authorization servers", + "tags": [ + "AuthorizationServerAssoc" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ], + "post": { + "description": "Creates trusted relationships between the given authorization server and other authorization servers", + "operationId": "createAssociatedServers", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateAssocAuthServer": { + "$ref": "#/components/examples/CreateAssocAuthServerBody" + } + }, + "schema": { + "$ref": "#/components/schemas/AssociatedServerMediated" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CreateAssocAuthServer": { + "$ref": "#/components/examples/CreateAssocAuthServerResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AuthorizationServer" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Create an associated authorization server", + "tags": [ + "AuthorizationServerAssoc" + ], + "x-codegen-request-body-name": "associatedServerMediated", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/associatedServers/{associatedServerId}": { + "delete": { + "description": "Deletes an associated Authorization Server", + "operationId": "deleteAssociatedServer", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Delete an associated authorization server", + "tags": [ + "AuthorizationServerAssoc" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathAssociatedServerId" + } + ] + }, + "/api/v1/authorizationServers/{authServerId}/claims": { + "get": { + "description": "Lists all custom token Claims defined for a specified custom authorization server", + "operationId": "listOAuth2Claims", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListCustomTokenClaims": { + "$ref": "#/components/examples/ListCustomTokenClaimsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2Claim" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "List all custom token claims", + "tags": [ + "AuthorizationServerClaims" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ], + "post": { + "description": "Creates a custom token Claim for a custom authorization server", + "operationId": "createOAuth2Claim", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateCustomTokenClaim": { + "$ref": "#/components/examples/CreateCustomTokenClaimBody" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2Claim" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "CreateCustomTokenClaim": { + "$ref": "#/components/examples/CreateCustomTokenClaimResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2Claim" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Create a custom token claim", + "tags": [ + "AuthorizationServerClaims" + ], + "x-codegen-request-body-name": "oAuth2Claim", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/claims/{claimId}": { + "delete": { + "description": "Deletes a custom token Claim specified by the `claimId`", + "operationId": "deleteOAuth2Claim", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Delete a custom token claim", + "tags": [ + "AuthorizationServerClaims" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a custom token Claim by the specified `claimId`", + "operationId": "getOAuth2Claim", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "RetrieveCustomTokenClaim": { + "$ref": "#/components/examples/RetrieveCustomTokenClaimResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2Claim" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "Retrieve a custom token claim", + "tags": [ + "AuthorizationServerClaims" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathClaimId" + } + ], + "put": { + "description": "Replaces a custom token Claim specified by the `claimId`", + "operationId": "replaceOAuth2Claim", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ReplaceCustomTokenClaim": { + "$ref": "#/components/examples/ReplaceCustomTokenClaimBody" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2Claim" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ReplaceCustomTokenClaim": { + "$ref": "#/components/examples/ReplaceCustomTokenClaimResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2Claim" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Replace a custom token claim", + "tags": [ + "AuthorizationServerClaims" + ], + "x-codegen-request-body-name": "oAuth2Claim", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/clients": { + "get": { + "description": "Lists all client resources for which the specified authorization server has tokens.\n\n> **Note:** To list a specific user's client resources for which they have tokens or grants, use the [List all clients endpoint in the User Resources API](/openapi/okta-management/management/userresources/listuserclients).", + "operationId": "listOAuth2ClientsForAuthorizationServer", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListClients": { + "$ref": "#/components/examples/ListClientsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2Client" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "List all client resources for an authorization server", + "tags": [ + "AuthorizationServerClients" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ] + }, + "/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens": { + "delete": { + "description": "Revokes all refresh tokens for a Client", + "operationId": "revokeRefreshTokensForAuthorizationServerAndClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Revoke all refresh tokens for a client", + "tags": [ + "AuthorizationServerClients" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Lists all refresh tokens issued by an authorization server for a specific Client", + "operationId": "listRefreshTokensForAuthorizationServerAndClient", + "parameters": [ + { + "description": "Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.", + "in": "query", + "name": "expand", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the pagination cursor for the next page of tokens", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "The maximum number of tokens to return (maximum 200)", + "in": "query", + "name": "limit", + "schema": { + "default": -1, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListRefreshTokenClients": { + "$ref": "#/components/examples/ListRefreshTokensClientsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2RefreshToken" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "List all refresh tokens for a client", + "tags": [ + "AuthorizationServerClients" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathClientId" + } + ] + }, + "/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}": { + "delete": { + "description": "Revokes a refresh token for a Client", + "operationId": "revokeRefreshTokenForAuthorizationServerAndClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Revoke a refresh token for a client", + "tags": [ + "AuthorizationServerClients" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a refresh token for a Client", + "operationId": "getRefreshTokenForAuthorizationServerAndClient", + "parameters": [ + { + "description": "Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.", + "in": "query", + "name": "expand", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "RetrieveRefreshTokenClient": { + "$ref": "#/components/examples/RetrieveRefreshTokenClientResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2RefreshToken" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "Retrieve a refresh token for a client", + "tags": [ + "AuthorizationServerClients" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathClientId" + }, + { + "$ref": "#/components/parameters/pathTokenId" + } + ] + }, + "/api/v1/authorizationServers/{authServerId}/credentials/keys": { + "get": { + "description": "Lists all of the current, future, and expired Keys used by the Custom Authorization Server", + "operationId": "listAuthorizationServerKeys", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAuthorizationServerKeys": { + "$ref": "#/components/examples/ListAuthorizationServerKeys" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AuthorizationServerJsonWebKey" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "List all credential keys", + "tags": [ + "AuthorizationServerKeys" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ] + }, + "/api/v1/authorizationServers/{authServerId}/credentials/keys/{keyId}": { + "get": { + "description": "Retrieves an Authorization Server Key specified by the `keyId`", + "operationId": "getAuthorizationServerKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ActiveAuthorizationServerKey": { + "$ref": "#/components/examples/ActiveAuthorizationServerKey" + }, + "ExpiredAuthorizationServerKey": { + "$ref": "#/components/examples/ExpiredAuthorizationServerKey" + }, + "NextAuthorizationServerKey": { + "$ref": "#/components/examples/NextAuthorizationServerKey" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerJsonWebKey" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "Retrieve an authorization server key", + "tags": [ + "AuthorizationServerKeys" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathCredentialKeyId" + } + ] + }, + "/api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ], + "post": { + "description": "Rotates the current Keys for a Custom Authorization Server. If you rotate Keys,\nthe `ACTIVE` Key becomes the `EXPIRED` Key, the `NEXT` Key becomes the `ACTIVE` Key,\nand the Custom Authorization Server immediately begins using the new active\nKey to sign tokens.\n\n> **Note:** Okta rotates your Keys automatically in `AUTO` mode. You can rotate Keys\nyourself in either mode. If Keys are rotated manually, you should invalidate any intermediate cache.\nand fetch the Keys again using the Keys endpoint.", + "operationId": "rotateAuthorizationServerKeys", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JwkUse" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "RotateAuthorizationServerKeys": { + "$ref": "#/components/examples/ListAuthorizationServerKeys" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AuthorizationServerJsonWebKey" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "examples": { + "InvalidRotateUse": { + "$ref": "#/components/examples/InvalidRotateUse" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Rotate all credential keys", + "tags": [ + "AuthorizationServerKeys" + ], + "x-codegen-request-body-name": "use", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ], + "post": { + "description": "Activates an authorization server", + "operationId": "activateAuthorizationServer", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Activate an authorization server", + "tags": [ + "AuthorizationServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ], + "post": { + "description": "Deactivates an authorization server", + "operationId": "deactivateAuthorizationServer", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Deactivate an authorization server", + "tags": [ + "AuthorizationServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/policies": { + "get": { + "description": "Lists all policies", + "operationId": "listAuthorizationServerPolicies", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAuthorizationServerPolicies": { + "$ref": "#/components/examples/ListAuthorizationServerPolicies" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AuthorizationServerPolicy" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "List all policies", + "tags": [ + "AuthorizationServerPolicies" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ], + "post": { + "description": "Creates a policy", + "operationId": "createAuthorizationServerPolicy", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateAuthorizationServerPolicyRule": { + "$ref": "#/components/examples/CreateAuthorizationServerPolicyRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerPolicy" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "AuthorizationServerPolicy": { + "$ref": "#/components/examples/AuthorizationServerPolicy" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerPolicy" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Create a policy", + "tags": [ + "AuthorizationServerPolicies" + ], + "x-codegen-request-body-name": "policy", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/policies/{policyId}": { + "delete": { + "description": "Deletes a policy", + "operationId": "deleteAuthorizationServerPolicy", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Delete a policy", + "tags": [ + "AuthorizationServerPolicies" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a policy", + "operationId": "getAuthorizationServerPolicy", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AuthorizationServerPolicy": { + "$ref": "#/components/examples/AuthorizationServerPolicy" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerPolicy" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "Retrieve a policy", + "tags": [ + "AuthorizationServerPolicies" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathPolicyId" + } + ], + "put": { + "description": "Replaces a policy", + "operationId": "replaceAuthorizationServerPolicy", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UpdateAuthorizationServerPolicyRule": { + "$ref": "#/components/examples/UpdateAuthorizationServerPolicyRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerPolicy" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AuthorizationServerPolicy": { + "$ref": "#/components/examples/AuthorizationServerPolicy" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerPolicy" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Replace a policy", + "tags": [ + "AuthorizationServerPolicies" + ], + "x-codegen-request-body-name": "policy", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathPolicyId" + } + ], + "post": { + "description": "Activates an authorization server policy", + "operationId": "activateAuthorizationServerPolicy", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Activate a policy", + "tags": [ + "AuthorizationServerPolicies" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathPolicyId" + } + ], + "post": { + "description": "Deactivates an authorization server policy", + "operationId": "deactivateAuthorizationServerPolicy", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Deactivate a policy", + "tags": [ + "AuthorizationServerPolicies" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules": { + "get": { + "description": "Lists all policy rules for the specified Custom Authorization Server and Policy", + "operationId": "listAuthorizationServerPolicyRules", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAuthorizationServerPolicyRules": { + "$ref": "#/components/examples/ListAuthorizationServerPolicyRules" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AuthorizationServerPolicyRule" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "List all policy rules", + "tags": [ + "AuthorizationServerRules" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathPolicyId" + } + ], + "post": { + "description": "Creates a policy rule for the specified Custom Authorization Server and Policy", + "operationId": "createAuthorizationServerPolicyRule", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateAuthorizationServerPolicyRule": { + "$ref": "#/components/examples/CreateAuthorizationServerPolicyRuleRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerPolicyRuleRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "AuthorizationServerPolicyRule": { + "$ref": "#/components/examples/AuthorizationServerPolicyRule" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerPolicyRule" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Create a policy rule", + "tags": [ + "AuthorizationServerRules" + ], + "x-codegen-request-body-name": "policyRule", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}": { + "delete": { + "description": "Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy", + "operationId": "deleteAuthorizationServerPolicyRule", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Delete a policy rule", + "tags": [ + "AuthorizationServerRules" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a policy rule by `ruleId`", + "operationId": "getAuthorizationServerPolicyRule", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AuthorizationServerPolicyRule": { + "$ref": "#/components/examples/AuthorizationServerPolicyRule" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerPolicyRule" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "Retrieve a policy rule", + "tags": [ + "AuthorizationServerRules" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathPolicyId" + }, + { + "$ref": "#/components/parameters/pathRuleId" + } + ], + "put": { + "description": "Replaces the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy", + "operationId": "replaceAuthorizationServerPolicyRule", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UpdateAuthorizationServerPolicyRule": { + "$ref": "#/components/examples/UpdateAuthorizationServerPolicyRuleRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerPolicyRuleRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AuthorizationServerPolicyRule": { + "$ref": "#/components/examples/AuthorizationServerPolicyRule" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthorizationServerPolicyRule" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Replace a policy rule", + "tags": [ + "AuthorizationServerRules" + ], + "x-codegen-request-body-name": "policyRule", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathPolicyId" + }, + { + "$ref": "#/components/parameters/pathRuleId" + } + ], + "post": { + "description": "Activates an authorization server policy rule", + "operationId": "activateAuthorizationServerPolicyRule", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Activate a policy rule", + "tags": [ + "AuthorizationServerRules" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathPolicyId" + }, + { + "$ref": "#/components/parameters/pathRuleId" + } + ], + "post": { + "description": "Deactivates an authorization server policy rule", + "operationId": "deactivateAuthorizationServerPolicyRule", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Deactivate a policy rule", + "tags": [ + "AuthorizationServerRules" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys": { + "get": { + "description": "Lists all the public keys used by the custom authorization server", + "operationId": "listOAuth2ResourceServerJsonWebKeys", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListOAuth2ResourceServerJsonWebKeys": { + "$ref": "#/components/examples/ListOAuth2ResourceServerJsonWebKeys" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2ResourceServerJsonWebKey" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "List all Custom Authorization Server Public JSON Web Keys", + "tags": [ + "OAuth2ResourceServerCredentialsKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ], + "post": { + "description": "Adds a new JSON Web Key to the custom authorization server`s JSON web keys.\n> **Note:** This API doesn't allow you to add a key if the existing key doesn't have a `kid`. Use the [Replace an Authorization Server](/openapi/okta-management/management/authorizationserver/replaceauthorizationserver) operation to update the JWKS or [Delete a Custom Authorization Server Public JSON Web Key](/openapi/okta-management/management/oauth2resourceservercredentialskeys/deleteoauth2resourceserverjsonwebkey) and re-add the key with a `kid`.\n> **Note:** This API doesn't allow you to add a key with an ACTIVE status. You need to add an INACTIVE key first, and then ACTIVATE the key.", + "operationId": "addOAuth2ResourceServerJsonWebKey", + "requestBody": { + "content": { + "application/json": { + "examples": { + "addOAuth2ResourceServerJsonWebKeyRequestBody": { + "$ref": "#/components/examples/AddOAuth2ResourceServerJsonWebKeyRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ResourceServerJsonWebKeyRequestBody" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "getOAuth2ResourceServerKey": { + "$ref": "#/components/examples/OAuth2ResourceServerJsonWebKey" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ResourceServerJsonWebKey" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorJsonWebKeyCannotAddActiveKey": { + "$ref": "#/components/examples/ErrorJsonWebKeyCannotAddActiveKey" + }, + "ErrorJsonWebKeyKidLengthTooShort": { + "$ref": "#/components/examples/ErrorJsonWebKeyKidLengthTooShort" + }, + "ErrorJsonWebKeyNonUniqueKid": { + "$ref": "#/components/examples/ErrorJsonWebKeyNonUniqueKid" + }, + "ErrorJsonWebKeyTooManyKids": { + "$ref": "#/components/examples/ErrorJsonWebKeyTooManyKids" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Add a JSON Web Key", + "tags": [ + "OAuth2ResourceServerCredentialsKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}": { + "delete": { + "description": "Deletes a custom authorization server public JSON web key by key `id`. You can only delete an inactive key.", + "operationId": "deleteOAuth2ResourceServerJsonWebKey", + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorDeleteCustomAsActiveJsonWebKey": { + "$ref": "#/components/examples/ErrorDeleteCustomAsActiveJsonWebKey" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Delete a Custom Authorization Server Public JSON Web Key", + "tags": [ + "OAuth2ResourceServerCredentialsKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a custom authorization server public JSON web key by key `id`", + "operationId": "getOAuth2ResourceServerJsonWebKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OAuthResourceServerJsonWebKeyResponseExample": { + "$ref": "#/components/examples/OAuth2ResourceServerJsonWebKey" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ResourceServerJsonWebKey", + "type": "object" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "Retrieve a Custom Authorization Server Public JSON Web Key", + "tags": [ + "OAuth2ResourceServerCredentialsKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/CustomAsPathJsonWebKeyId" + } + ] + }, + "/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/CustomAsPathJsonWebKeyId" + } + ], + "post": { + "description": "Activates a custom authorization server public JSON web key by key `id`.\n> **Note:** You can have only one active key at any given time for the authorization server. When you activate an inactive key, Okta automatically deactivates the current active key.", + "operationId": "activateOAuth2ResourceServerJsonWebKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "activateOAuth2ResourceServerJsonWebKeyResponse": { + "$ref": "#/components/examples/OAuth2ResourceServerJsonWebKey" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ResourceServerJsonWebKey" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Activate a Custom Authorization Server Public JSON Web Key", + "tags": [ + "OAuth2ResourceServerCredentialsKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/CustomAsPathJsonWebKeyId" + } + ], + "post": { + "description": "Deactivates a custom authorization server public JSON web key by key `id`.\n> **Note:** Deactivating the active key isn't allowed if the authorization server has access token encryption enabled. You can activate another key, which makes the current key inactive.", + "operationId": "deactivateOAuth2ResourceServerJsonWebKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "deactivateOAuth2ResourceServerJsonWebKeyResponse": { + "$ref": "#/components/examples/OAuth2ResourceServerJsonWebKey" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2ResourceServerJsonWebKey" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ErrorDeactivateActiveKey": { + "$ref": "#/components/examples/ErrorDeactivateActiveKey" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Deactivate a Custom Authorization Server Public JSON Web Key", + "tags": [ + "OAuth2ResourceServerCredentialsKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/scopes": { + "get": { + "description": "Lists all custom token scopes", + "operationId": "listOAuth2Scopes", + "parameters": [ + { + "description": "Searches the `name` of Custom Token Scopes for matching values", + "in": "query", + "name": "q", + "schema": { + "type": "string" + } + }, + { + "description": "Filter expression for Custom Token Scopes", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the pagination cursor for the next page of scopes.\nTreat the after cursor as an opaque value and obtain it through the next link relationship. See [Pagination](https://developer.okta.com/docs/api/#pagination).", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of objects to return per page.\nIf there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it). See [Pagination](https://developer.okta.com/docs/api/#pagination).", + "in": "query", + "name": "limit", + "schema": { + "maximum": 200, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ExampleScopes": { + "$ref": "#/components/examples/ExampleOAuth2Scopes" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2Scope" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "List all custom token scopes", + "tags": [ + "AuthorizationServerScopes" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + } + ], + "post": { + "description": "Creates a custom token scope", + "operationId": "createOAuth2Scope", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateOAuth2ScopeRequest": { + "$ref": "#/components/examples/CreateOAuth2ScopeRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2Scope" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "ExampleOAuth2Scope": { + "$ref": "#/components/examples/ExampleOAuth2Scope" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2Scope" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Create a custom token scope", + "tags": [ + "AuthorizationServerScopes" + ], + "x-codegen-request-body-name": "oAuth2Scope", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/authorizationServers/{authServerId}/scopes/{scopeId}": { + "delete": { + "description": "Deletes a custom token scope", + "operationId": "deleteOAuth2Scope", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Delete a custom token scope", + "tags": [ + "AuthorizationServerScopes" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a custom token scope", + "operationId": "getOAuth2Scope", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ExampleOAuth2Scope": { + "$ref": "#/components/examples/ExampleOAuth2Scope" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2Scope" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.read" + ] + } + ], + "summary": "Retrieve a custom token scope", + "tags": [ + "AuthorizationServerScopes" + ], + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAuthServerId" + }, + { + "$ref": "#/components/parameters/pathScopeId" + } + ], + "put": { + "description": "Replaces a custom token scope", + "operationId": "replaceOAuth2Scope", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UpdateOAuth2Scope": { + "$ref": "#/components/examples/UpdateOAuth2ScopeRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2Scope" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UpdatedOAuth2Scope": { + "$ref": "#/components/examples/UpdatedOAuth2ScopeResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OAuth2Scope" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.authorizationServers.manage" + ] + } + ], + "summary": "Replace a custom token scope", + "tags": [ + "AuthorizationServerScopes" + ], + "x-codegen-request-body-name": "oAuth2Scope", + "x-okta-lifecycle": { + "SKUs": [ + "API Access Management" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/behaviors": { + "get": { + "description": "Lists all behavior detection rules with pagination support", + "operationId": "listBehaviorDetectionRules", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/BehaviorRule" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.behaviors.read" + ] + } + ], + "summary": "List all behavior detection rules", + "tags": [ + "Behavior" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new behavior detection rule", + "operationId": "createBehaviorDetectionRule", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Behavior Rule Request": { + "$ref": "#/components/examples/BehaviorRuleRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/BehaviorRule" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Behavior Rule Response": { + "$ref": "#/components/examples/BehaviorRuleResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/BehaviorRule" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "examples": { + "API Validation Failed": { + "$ref": "#/components/examples/ErrorApiValidationFailed" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.behaviors.manage" + ] + } + ], + "summary": "Create a behavior detection rule", + "tags": [ + "Behavior" + ], + "x-codegen-request-body-name": "rule", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/behaviors/{behaviorId}": { + "delete": { + "description": "Deletes a Behavior Detection Rule by `behaviorId`", + "operationId": "deleteBehaviorDetectionRule", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "content": { + "application/json": { + "examples": { + "Resource Not Found": { + "$ref": "#/components/examples/ErrorResourceNotFound" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.behaviors.manage" + ] + } + ], + "summary": "Delete a behavior detection rule", + "tags": [ + "Behavior" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a Behavior Detection Rule by `behaviorId`", + "operationId": "getBehaviorDetectionRule", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Behavior Rule Response": { + "$ref": "#/components/examples/BehaviorRuleResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/BehaviorRule" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "content": { + "application/json": { + "examples": { + "Resource Not Found": { + "$ref": "#/components/examples/ErrorResourceNotFound" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.behaviors.read" + ] + } + ], + "summary": "Retrieve a behavior detection rule", + "tags": [ + "Behavior" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBehaviorId" + } + ], + "put": { + "description": "Replaces a Behavior Detection Rule by `behaviorId`", + "operationId": "replaceBehaviorDetectionRule", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Behavior Rule Request": { + "$ref": "#/components/examples/BehaviorRuleRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/BehaviorRule" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Behavior Rule Response": { + "$ref": "#/components/examples/BehaviorRuleResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/BehaviorRule" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "examples": { + "API Validation Failed": { + "$ref": "#/components/examples/ErrorApiValidationFailed" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "content": { + "application/json": { + "examples": { + "Resource Not Found": { + "$ref": "#/components/examples/ErrorResourceNotFound" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.behaviors.manage" + ] + } + ], + "summary": "Replace a behavior detection rule", + "tags": [ + "Behavior" + ], + "x-codegen-request-body-name": "rule", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/behaviors/{behaviorId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathBehaviorId" + } + ], + "post": { + "description": "Activates a behavior detection rule", + "operationId": "activateBehaviorDetectionRule", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Behavior Rule Response": { + "$ref": "#/components/examples/BehaviorRuleResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/BehaviorRule" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.behaviors.manage" + ] + } + ], + "summary": "Activate a behavior detection rule", + "tags": [ + "Behavior" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/behaviors/{behaviorId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathBehaviorId" + } + ], + "post": { + "description": "Deactivates a behavior detection rule", + "operationId": "deactivateBehaviorDetectionRule", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Behavior Rule Response": { + "$ref": "#/components/examples/BehaviorRuleResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/BehaviorRule" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.behaviors.manage" + ] + } + ], + "summary": "Deactivate a behavior detection rule", + "tags": [ + "Behavior" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/bot-protection/configuration": { + "get": { + "description": "Retrieves the bot protection configuration for your org", + "operationId": "getBotProtectionConfiguration", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Default": { + "$ref": "#/components/examples/BotProtectionConfigurationDefault" + }, + "Enforced": { + "$ref": "#/components/examples/BotProtectionConfigurationEnforced" + } + }, + "schema": { + "$ref": "#/components/schemas/BotProtectionConfiguration" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.botProtection.read" + ] + } + ], + "summary": "Retrieve the bot protection configuration", + "tags": [ + "BotProtection" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "post": { + "description": "Updates the bot protection configuration for your org", + "operationId": "updateBotProtectionConfiguration", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Enforced": { + "$ref": "#/components/examples/BotProtectionConfigurationRequestEnforced" + }, + "LogOnly": { + "$ref": "#/components/examples/BotProtectionConfigurationRequestLogOnly" + } + }, + "schema": { + "$ref": "#/components/schemas/BotProtectionConfiguration" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Enforced": { + "$ref": "#/components/examples/BotProtectionConfigurationEnforced" + }, + "LogOnly": { + "$ref": "#/components/examples/BotProtectionConfigurationDefault" + } + }, + "schema": { + "$ref": "#/components/schemas/BotProtectionConfiguration" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ApiValidationFailed": { + "$ref": "#/components/examples/ErrorApiValidationFailed" + }, + "EnforcementTypeRequired": { + "$ref": "#/components/examples/ErrorBotProtectionEnforcementTypeRequired" + }, + "LevelRequired": { + "$ref": "#/components/examples/ErrorBotProtectionLevelRequired" + }, + "ModeRequired": { + "$ref": "#/components/examples/ErrorBotProtectionModeRequired" + }, + "SupportedFlowsRequired": { + "$ref": "#/components/examples/ErrorBotProtectionSupportedFlowsRequired" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.botProtection.manage" + ] + } + ], + "summary": "Update the bot protection configuration", + "tags": [ + "BotProtection" + ], + "x-codegen-request-body-name": "botProtectionConfiguration", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/brands": { + "get": { + "description": "Lists all the brands in your org", + "operationId": "listBrands", + "parameters": [ + { + "$ref": "#/components/parameters/queryExpandBrand" + }, + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + }, + { + "$ref": "#/components/parameters/queryFilter" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get brands response": { + "$ref": "#/components/examples/ListBrandsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/BrandWithEmbedded" + }, + "type": "array" + } + } + }, + "description": "Successfully returned the list of brands" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "List all brands", + "tags": [ + "Brands" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new brand in your org", + "operationId": "createBrand", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Create brand request": { + "$ref": "#/components/examples/CreateBrandRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateBrandRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "Create brand response": { + "$ref": "#/components/examples/CreateBrandResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Brand" + } + } + }, + "description": "Successfully created the brand" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "409": { + "content": { + "application/json": { + "examples": { + "Cannot create brand with the same name": { + "$ref": "#/components/examples/ErrorCreateBrandExists" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Could not create the new brand because same name already exist." + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Create a brand", + "tags": [ + "Brands" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}": { + "delete": { + "description": "Deletes a brand by `brandId`", + "operationId": "deleteBrand", + "responses": { + "204": { + "description": "Successfully deleted the brand." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "409": { + "content": { + "application/json": { + "examples": { + "Cannot delete brand associated with a domain": { + "$ref": "#/components/examples/ErrorDeleteBrandAssociatedWithDomain" + }, + "Cannot delete default brand": { + "$ref": "#/components/examples/ErrorDeleteDefaultBrand" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Conflict" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Delete a brand", + "tags": [ + "Brands" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a brand by `brandId`", + "operationId": "getBrand", + "parameters": [ + { + "$ref": "#/components/parameters/queryExpandBrand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get brand response": { + "$ref": "#/components/examples/GetBrandResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/BrandWithEmbedded" + } + } + }, + "description": "Successfully retrieved the brand" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve a brand", + "tags": [ + "Brands" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ], + "put": { + "description": "Replaces a brand by `brandId`\n\nPassing an invalid `brandId` returns a `404 Not Found` status code with the error code `E0000007`.\n\nNot providing `agreeToCustomPrivacyPolicy` with `customPrivacyPolicyUrl` returns a `400 Bad Request` status code with the error code `E0000001`.\n\n", + "operationId": "replaceBrand", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Update brand request": { + "$ref": "#/components/examples/UpdateBrandRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/BrandRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Update brand response": { + "$ref": "#/components/examples/UpdateBrandResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Brand" + } + } + }, + "description": "Successfully replaced the brand" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Replace a brand", + "tags": [ + "Brands" + ], + "x-codegen-request-body-name": "brand", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/domains": { + "get": { + "description": "Lists all domains associated with a brand by `brandId`", + "operationId": "listBrandDomains", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrandDomains" + } + } + }, + "description": "Successfully returned the list of domains for the brand" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "List all domains associated with a brand", + "tags": [ + "Brands" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ] + }, + "/api/v1/brands/{brandId}/pages/error": { + "get": { + "description": "Retrieves the error page sub-resources. The `expand` query parameter specifies which sub-resources to include in the response.", + "operationId": "getErrorPage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageRoot" + } + } + }, + "description": "Successfully retrieved the error page." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the error page sub-resources", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/queryExpandPageRoot" + } + ] + }, + "/api/v1/brands/{brandId}/pages/error/customized": { + "delete": { + "description": "Deletes the customized error page. As a result, the default error page appears in your live environment.", + "operationId": "deleteCustomizedErrorPage", + "responses": { + "204": { + "content": {}, + "description": "Successfully deleted the customized error page." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Delete the customized error page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves the customized error page. The customized error page appears in your live environment.", + "operationId": "getCustomizedErrorPage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorPage" + } + } + }, + "description": "Successfully retrieved the customized error page.", + "headers": { + "Location": { + "schema": { + "format": "uri", + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the customized error page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ], + "put": { + "description": "Replaces the customized error page. The customized error page appears in your live environment.", + "operationId": "replaceCustomizedErrorPage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorPage" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorPage" + } + } + }, + "description": "Successfully replaced the customized error page.", + "headers": { + "Location": { + "schema": { + "format": "uri", + "type": "string" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Replace the customized error page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/pages/error/default": { + "get": { + "description": "Retrieves the default error page. The default error page appears when no customized error page exists.", + "operationId": "getDefaultErrorPage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorPage" + } + } + }, + "description": "Successfully retrieved the default error page." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the default error page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ] + }, + "/api/v1/brands/{brandId}/pages/error/preview": { + "delete": { + "description": "Deletes the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.", + "operationId": "deletePreviewErrorPage", + "responses": { + "204": { + "content": {}, + "description": "Successfully deleted the preview error page." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Delete the preview error page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.", + "operationId": "getPreviewErrorPage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorPage" + } + } + }, + "description": "Successfully retrieved the preview error page.", + "headers": { + "Location": { + "schema": { + "format": "uri", + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the preview error page preview", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ], + "put": { + "description": "Replaces the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.", + "operationId": "replacePreviewErrorPage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorPage" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorPage" + } + } + }, + "description": "Successfully replaced the preview error page.", + "headers": { + "Location": { + "schema": { + "format": "uri", + "type": "string" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Replace the preview error page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/pages/sign-in": { + "get": { + "description": "Retrieves the sign-in page sub-resources. The `expand` query parameter specifies which sub-resources to include in the response.", + "operationId": "getSignInPage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageRoot" + } + } + }, + "description": "Successfully retrieved the sign-in page." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the sign-in page sub-resources", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/queryExpandPageRoot" + } + ] + }, + "/api/v1/brands/{brandId}/pages/sign-in/customized": { + "delete": { + "description": "Deletes the customized sign-in page. As a result, the default sign-in page appears in your live environment.", + "operationId": "deleteCustomizedSignInPage", + "responses": { + "204": { + "content": {}, + "description": "Successfully deleted the sign-in page." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Delete the customized sign-in page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves the customized sign-in page. The customized sign-in page appears in your live environment.", + "operationId": "getCustomizedSignInPage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignInPage" + } + } + }, + "description": "Successfully retrieved the customized sign-in page.", + "headers": { + "Location": { + "schema": { + "format": "uri", + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the customized sign-in page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ], + "put": { + "description": "Replaces the customized sign-in page. The customized sign-in page appears in your live environment.", + "operationId": "replaceCustomizedSignInPage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignInPage" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignInPage" + } + } + }, + "description": "Successfully replaced the customized sign-in page.", + "headers": { + "Location": { + "schema": { + "format": "uri", + "type": "string" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Replace the customized sign-in page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/pages/sign-in/default": { + "get": { + "description": "Retrieves the default sign-in page. The default sign-in page appears when no customized sign-in page exists.", + "operationId": "getDefaultSignInPage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignInPage" + } + } + }, + "description": "Successfully retrieved the default sign-in page." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the default sign-in page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ] + }, + "/api/v1/brands/{brandId}/pages/sign-in/preview": { + "delete": { + "description": "Deletes the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.", + "operationId": "deletePreviewSignInPage", + "responses": { + "204": { + "content": {}, + "description": "Successfully deleted the preview sign-in page." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Delete the preview sign-in page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.", + "operationId": "getPreviewSignInPage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignInPage" + } + } + }, + "description": "Successfully retrieved the preview sign-in page.", + "headers": { + "Location": { + "schema": { + "format": "uri", + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the preview sign-in page preview", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ], + "put": { + "description": "Replaces the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.", + "operationId": "replacePreviewSignInPage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignInPage" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignInPage" + } + } + }, + "description": "Successfully replaced the preview sign-in page.", + "headers": { + "Location": { + "schema": { + "format": "uri", + "type": "string" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Replace the preview sign-in page", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/pages/sign-in/widget-versions": { + "get": { + "description": "Lists all sign-in widget versions supported by the current org", + "operationId": "listAllSignInWidgetVersions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "pattern": "^\\d+\\.\\d+$", + "type": "string" + }, + "type": "array" + } + } + }, + "description": "Successfully listed the sign-in widget versions." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "List all Sign-In Widget versions", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ] + }, + "/api/v1/brands/{brandId}/pages/sign-out/customized": { + "get": { + "description": "Retrieves the sign-out page settings", + "operationId": "getSignOutPageSettings", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HostedPage" + } + } + }, + "description": "Successfully retrieved the sign-out page settings." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the sign-out page settings", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ], + "put": { + "description": "Replaces the sign-out page settings", + "operationId": "replaceSignOutPageSettings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HostedPage" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HostedPage" + } + } + }, + "description": "Successfully replaced the sign-out page settings." + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Replace the sign-out page settings", + "tags": [ + "CustomPages" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/templates/email": { + "get": { + "description": "Lists all supported email templates", + "operationId": "listEmailTemplates", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + }, + { + "$ref": "#/components/parameters/queryExpandEmailTemplate" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "List email templates response": { + "$ref": "#/components/examples/ListEmailTemplateResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/EmailTemplateResponse" + }, + "type": "array" + } + } + }, + "description": "Successfully returned the list of email templates.", + "headers": { + "Link": { + "description": "The pagination header containing links to the current and next page of results. See [Pagination](/#pagination) for more information.", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "List all email templates", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ] + }, + "/api/v1/brands/{brandId}/templates/email/{templateName}": { + "get": { + "description": "Retrieves the details of an email template by name", + "operationId": "getEmailTemplate", + "parameters": [ + { + "$ref": "#/components/parameters/queryExpandEmailTemplate" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get email template response": { + "$ref": "#/components/examples/GetEmailTemplateResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailTemplateResponse" + } + } + }, + "description": "Successfully retrieved the email template." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "Retrieve an email template", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathTemplateName" + } + ] + }, + "/api/v1/brands/{brandId}/templates/email/{templateName}/customizations": { + "delete": { + "description": "Deletes all customizations for an email template\n\n<x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is enabled, all customizations are deleted, including customizations for additional languages. If disabled, only customizations in Okta-supported languages are deleted.\n", + "operationId": "deleteAllCustomizations", + "responses": { + "204": { + "content": {}, + "description": "Successfully deleted all customizations for the email template." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.manage" + ] + } + ], + "summary": "Delete all email customizations", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Lists all customizations of an email template\n\n<x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is enabled, all existing customizations are retrieved, including customizations for additional languages. If disabled, only customizations for Okta-supported languages are returned.\n", + "operationId": "listEmailCustomizations", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "List Email customizations response": { + "$ref": "#/components/examples/ListEmailCustomizationResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/EmailCustomization" + }, + "type": "array" + } + } + }, + "description": "Successfully retrieved all email customizations for the specified email template." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "List all email customizations", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathTemplateName" + } + ], + "post": { + "description": "Creates a new Email Customization\n\n<x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is enabled, you can create a customization for any BCP47 language in addition to the Okta-supported languages.\n", + "operationId": "createEmailCustomization", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Create email customization request": { + "$ref": "#/components/examples/CreateUpdateEmailCustomizationRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailCustomization" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "Create email customization response": { + "$ref": "#/components/examples/CreateUpdateEmailCustomizationResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailCustomization" + } + } + }, + "description": "Successfully created the email customization." + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "409": { + "content": { + "application/json": { + "examples": { + "Default email customization already exists": { + "$ref": "#/components/examples/ErrorEmailCustomizationDefaultAlreadyExists" + }, + "Email customization already exists for the specified language": { + "$ref": "#/components/examples/ErrorEmailCustomizationLanguageAlreadyExists" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Could not create the email customization because it conflicts with an existing email customization." + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.manage" + ] + } + ], + "summary": "Create an email customization", + "tags": [ + "CustomTemplates" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}": { + "delete": { + "description": "Deletes an Email Customization by its unique identifier\n\n<x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, deletion of an existing additional language customization by ID doesn't register.\n", + "operationId": "deleteEmailCustomization", + "responses": { + "204": { + "content": {}, + "description": "Successfully deleted the email customization." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "409": { + "content": { + "application/json": { + "examples": { + "Cannot delete default email customization": { + "$ref": "#/components/examples/ErrorEmailCustomizationCannotDeleteDefault" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Could not delete the email customization deleted because it is the default email customization." + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.manage" + ] + } + ], + "summary": "Delete an email customization", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an email customization by its unique identifier\n\n<x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, requests to retrieve an additional language customization by ID result in a `404 Not Found` error response.\n", + "operationId": "getEmailCustomization", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get email customization response": { + "$ref": "#/components/examples/EmailCustomizationResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailCustomization" + } + } + }, + "description": "Successfully retrieved the email customization." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "Retrieve an email customization", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathTemplateName" + }, + { + "$ref": "#/components/parameters/pathCustomizationId" + } + ], + "put": { + "description": "Replaces an email customization using property values\n\n<x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, requests to update a customization for an additional language return a `404 Not Found` error response.\n", + "operationId": "replaceEmailCustomization", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Update email customization request": { + "$ref": "#/components/examples/CreateUpdateEmailCustomizationRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailCustomization" + } + } + }, + "description": "Request" + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Update email customization response": { + "$ref": "#/components/examples/CreateUpdateEmailCustomizationResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailCustomization" + } + } + }, + "description": "Successfully updated the email customization." + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "409": { + "content": { + "application/json": { + "examples": { + "Cannot set the default email customization's isDefault to false": { + "$ref": "#/components/examples/ErrorEmailCustomizationCannotClearDefault" + }, + "Default email customization already exists": { + "$ref": "#/components/examples/ErrorEmailCustomizationDefaultAlreadyExists" + }, + "Email customization already exists for the specified language": { + "$ref": "#/components/examples/ErrorEmailCustomizationLanguageAlreadyExists" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Could not update the email customization because the update would cause a conflict with an existing email customization." + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.manage" + ] + } + ], + "summary": "Replace an email customization", + "tags": [ + "CustomTemplates" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview": { + "get": { + "description": "Retrieves a Preview of an Email Customization. All variable references are populated from the current user's context. For example, `${user.profile.firstName}`.\n\n<x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, requests for the preview of an additional language customization by ID return a `404 Not Found` error response.\n", + "operationId": "getCustomizationPreview", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Preview email customization response": { + "$ref": "#/components/examples/PreviewEmailCustomizationResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailPreview" + } + } + }, + "description": "Successfully generated a preview of the email customization." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "Retrieve a preview of an email customization", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathTemplateName" + }, + { + "$ref": "#/components/parameters/pathCustomizationId" + } + ] + }, + "/api/v1/brands/{brandId}/templates/email/{templateName}/default-content": { + "get": { + "description": "Retrieves an email template's default content\n\n<x-lifecycle class=\"ea\"></x-lifecycle> Defaults to the current user's language given the following:\n- Custom languages for Okta Email Templates is enabled\n- An additional language is specified for the `language` parameter\n", + "operationId": "getEmailDefaultContent", + "parameters": [ + { + "$ref": "#/components/parameters/queryLanguage" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get email template default content response": { + "$ref": "#/components/examples/EmailTemplateDefaultContentResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailDefaultContent" + } + } + }, + "description": "Successfully retrieved the email template's default content." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "Retrieve an email template default content", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathTemplateName" + } + ] + }, + "/api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview": { + "get": { + "description": "Retrieves a preview of an Email Template's default content. All variable references are populated using the current user's context. For example, `${user.profile.firstName}`.\n\n<x-lifecycle class=\"ea\"></x-lifecycle> Defaults to the current user's language given the following:\n- Custom languages for Okta Email Templates is enabled\n- An additional language is specified for the `language` parameter\n", + "operationId": "getEmailDefaultPreview", + "parameters": [ + { + "$ref": "#/components/parameters/queryLanguage" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Preview email template default content response": { + "$ref": "#/components/examples/PreviewEmailTemplateDefaultContentResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailPreview" + } + } + }, + "description": "Successfully generated a preview of the email template's default content." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "Retrieve a preview of the email template default content", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathTemplateName" + } + ] + }, + "/api/v1/brands/{brandId}/templates/email/{templateName}/settings": { + "get": { + "description": "Retrieves an email template's settings", + "operationId": "getEmailSettings", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get email template settings response": { + "$ref": "#/components/examples/EmailSettingsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailSettingsResponse" + } + } + }, + "description": "Successfully retrieved the email template's settings." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "Retrieve the email template settings", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathTemplateName" + } + ], + "put": { + "description": "Replaces an email template's settings", + "operationId": "replaceEmailSettings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EmailSettings" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Update email template settings": { + "$ref": "#/components/examples/EmailSettingsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailSettings" + } + } + }, + "description": "Successfully updated the email template's settings." + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "409": { + "content": { + "application/json": { + "examples": { + "Conflict": { + "$ref": "#/components/examples/ErrorEmailSettingsRaceCondition" + } + }, + "schema": { + "$ref": "#/components/schemas/Error409" + } + } + }, + "description": "Conflict" + }, + "422": { + "content": { + "application/json": { + "examples": { + "Invalid email template recipients": { + "$ref": "#/components/examples/ErrorInvalidEmailTemplateRecipients" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Could not update the email template's settings due to an invalid setting value." + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.manage" + ] + } + ], + "summary": "Replace the email template settings", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/templates/email/{templateName}/test": { + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathTemplateName" + } + ], + "post": { + "description": "Sends a test email to the current user's primary and secondary email addresses. The email content is selected based on the following priority:\n1. The email customization for the language specified in the `language` query parameter\n<x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is enabled and the `language` parameter is an additional language, the test email uses the customization corresponding to the language.\n2. The email template's default customization\n3. The email template's default content, translated to the current user's language\n\nYou can only send customized test emails if you've configured a custom email domain. If you don't have a custom email domain, test emails use the Okta default template and are sent from the Okta email domain.\n\n> **Note:** Super admins can view customized email templates with the **Send a test email** request. However, when custom email templates are sent to super admins as part of actual email notification flows, the customizations aren't applied. Instead, the default email template is used. This only applies to super admins.", + "operationId": "sendTestEmail", + "parameters": [ + { + "$ref": "#/components/parameters/queryLanguage" + } + ], + "responses": { + "204": { + "content": {}, + "description": "Successfully sent a test email." + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "Send a test email", + "tags": [ + "CustomTemplates" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/themes": { + "get": { + "description": "Lists all the themes in your brand.\n\n> **Important:** Currently each org supports only one theme, therefore this contains a single object only.", + "operationId": "listBrandThemes", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get themes response": { + "$ref": "#/components/examples/ListThemesResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/ThemeResponse" + }, + "type": "array" + } + } + }, + "description": "Successfully returned the list of themes" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "List all themes", + "tags": [ + "Themes" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + } + ] + }, + "/api/v1/brands/{brandId}/themes/{themeId}": { + "get": { + "description": "Retrieves a theme for a brand", + "operationId": "getBrandTheme", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get theme response": { + "$ref": "#/components/examples/GetThemeResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ThemeResponse" + } + } + }, + "description": "Successfully retrieved the theme" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve a theme", + "tags": [ + "Themes" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathThemeId" + } + ], + "put": { + "description": "Replaces a theme for a brand", + "operationId": "replaceBrandTheme", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Update theme request": { + "$ref": "#/components/examples/UpdateThemeRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UpdateThemeRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Update theme response": { + "$ref": "#/components/examples/UpdateThemeResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ThemeResponse" + } + } + }, + "description": "Successfully replaced the theme" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Replace a theme", + "tags": [ + "Themes" + ], + "x-codegen-request-body-name": "theme", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/themes/{themeId}/background-image": { + "delete": { + "description": "Deletes a theme background image", + "operationId": "deleteBrandThemeBackgroundImage", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Delete the background image", + "tags": [ + "Themes" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathThemeId" + } + ], + "post": { + "description": "Uploads and replaces the background image for the theme. The file must be in PNG, JPG, or GIF format and less than 2 MB in size.", + "operationId": "uploadBrandThemeBackgroundImage", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "description": "The file must be in PNG, JPG, or GIF format and less than 2 MB in size.", + "properties": { + "file": { + "format": "binary", + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + } + } + }, + "description": "background image file" + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImageUploadResponse" + } + } + }, + "description": "Content Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Upload the background image", + "tags": [ + "Themes" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/themes/{themeId}/favicon": { + "delete": { + "description": "Deletes a theme favicon. The theme will use the default Okta favicon.", + "operationId": "deleteBrandThemeFavicon", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Delete the favicon", + "tags": [ + "Themes" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathThemeId" + } + ], + "post": { + "description": "Uploads and replaces the favicon for the theme", + "operationId": "uploadBrandThemeFavicon", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "description": "The file must be in PNG or ICO format and have a 1:1 ratio with a maximum dimension of 512 x 512", + "properties": { + "file": { + "format": "binary", + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + } + } + }, + "description": "favicon file" + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImageUploadResponse" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Upload the favicon", + "tags": [ + "Themes" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/themes/{themeId}/logo": { + "delete": { + "description": "Deletes a Theme logo. The theme will use the default Okta logo.", + "operationId": "deleteBrandThemeLogo", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Delete the logo", + "tags": [ + "Themes" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathThemeId" + } + ], + "post": { + "description": "Uploads and replaces the logo for the theme. The file must be in PNG, JPG, or GIF format and less than 100kB in size. For best results use landscape orientation, a transparent background, and a minimum size of 300px by 50px to prevent upscaling.", + "operationId": "uploadBrandThemeLogo", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "description": "The file must be in PNG, JPG, or GIF format and less than 100kB in size. For best results use landscape orientation, a transparent background, and a minimum size of 300px by 50px to prevent upscaling.", + "properties": { + "file": { + "format": "binary", + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + } + } + }, + "description": "logo file" + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImageUploadResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Upload the logo", + "tags": [ + "Themes" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/brands/{brandId}/well-known-uris": { + "get": { + "description": "Retrieves the content from each of the well-known URIs for a specified brand", + "operationId": "getAllWellKnownURIs", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Retrieve all URIs response": { + "$ref": "#/components/examples/WellKnownURIsRootResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/WellKnownURIsRoot" + } + } + }, + "description": "Successfully retrieved all the well-known URIs" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve all the well-known URIs", + "tags": [ + "AssociatedDomainCustomizations" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/queryExpandWellKnownUris" + } + ] + }, + "/api/v1/brands/{brandId}/well-known-uris/{path}": { + "get": { + "description": "Retrieves the well-known URI of a specific brand and well-known URI path", + "operationId": "getRootBrandWellKnownURI", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Retrieve well-known URI of a specific brand": { + "$ref": "#/components/examples/WellKnownURIRootResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/WellKnownURIObjectResponse" + } + } + }, + "description": "Successfully retrieved the well-known URI" + }, + "400": { + "content": { + "application/json": { + "examples": { + "Invalid path": { + "$ref": "#/components/examples/ErrorInvalidWellKnownPath" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the well-known URI of a specific brand", + "tags": [ + "AssociatedDomainCustomizations" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathWellKnownUriPath" + }, + { + "$ref": "#/components/parameters/queryExpandWellKnownUri" + } + ] + }, + "/api/v1/brands/{brandId}/well-known-uris/{path}/customized": { + "get": { + "description": "Retrieves the customized content of a well-known URI for a specific brand and well-known URI path", + "operationId": "getBrandWellKnownURI", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Retrieve the customized well-known URI": { + "$ref": "#/components/examples/WellKnownURIResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/WellKnownURIObjectResponse" + } + } + }, + "description": "Successfully retrieved the customized well-known URI content" + }, + "400": { + "content": { + "application/json": { + "examples": { + "Invalid path": { + "$ref": "#/components/examples/ErrorInvalidWellKnownPath" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.read" + ] + } + ], + "summary": "Retrieve the customized content of the specified well-known URI", + "tags": [ + "AssociatedDomainCustomizations" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBrandId" + }, + { + "$ref": "#/components/parameters/pathWellKnownUriPath" + } + ], + "put": { + "description": "Replaces the content of a customized well-known URI that you specify.\n\nThere are endpoint-specific format requirements when you update the content of a customized well-known URI. See [Customize associated domains](https://developer.okta.com/docs/guides/custom-well-known-uri/main/).", + "operationId": "replaceBrandWellKnownURI", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Update well-known URI request": { + "$ref": "#/components/examples/UpdateWellKnownURIRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/WellKnownURIRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Update well-known URI response": { + "$ref": "#/components/examples/WellKnownURIResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/WellKnownURIObjectResponse" + } + } + }, + "description": "Successfully updated the well-known URI of the specified path" + }, + "400": { + "content": { + "application/json": { + "examples": { + "Cannot update well-known URI for default brand": { + "$ref": "#/components/examples/CannotUpdateWellKnownUriForDefaultBrandError" + }, + "Invalid content type for apple-app-site-association and webauthn": { + "$ref": "#/components/examples/InvalidWellKnownJsonTypeError" + }, + "Invalid content type for assetlinks.json": { + "$ref": "#/components/examples/InvalidWellKnownArrayTypeError" + }, + "Invalid path": { + "$ref": "#/components/examples/ErrorInvalidWellKnownPath" + }, + "apple-app-site-association representation contains authsrv": { + "$ref": "#/components/examples/InvalidWellKnownAppleAppSiteRepresentationError" + }, + "size limit exceeded": { + "$ref": "#/components/examples/WellKnownRepresentationSizeLimitExceededError" + }, + "webauthn representation doesn't contain origins": { + "$ref": "#/components/examples/InvalidWellKnownWebauthnRepresentationError" + }, + "webauthn representation origins is not string array": { + "$ref": "#/components/examples/InvalidWellKnownWebauthnRepresentationOriginStringError" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.brands.manage" + ] + } + ], + "summary": "Replace the customized well-known URI of the specific path", + "tags": [ + "AssociatedDomainCustomizations" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/captchas": { + "get": { + "description": "Lists all CAPTCHA instances with pagination support. A subset of CAPTCHA instances can be returned that match a supported filter expression or query.", + "operationId": "listCaptchaInstances", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/CAPTCHAInstance" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.captchas.read" + ] + } + ], + "summary": "List all CAPTCHA instances", + "tags": [ + "CAPTCHA" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "post": { + "description": "Creates a new CAPTCHA instance. Currently, an org can only configure a single CAPTCHA instance.", + "operationId": "createCaptchaInstance", + "requestBody": { + "content": { + "application/json": { + "examples": { + "HCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceRequestHCaptcha" + }, + "ReCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceRequestReCaptcha" + } + }, + "schema": { + "$ref": "#/components/schemas/CAPTCHAInstance" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "HCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceResponseHCaptcha" + }, + "ReCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceResponseReCaptcha" + } + }, + "schema": { + "$ref": "#/components/schemas/CAPTCHAInstance" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + }, + "Error Limit of One CAPTCHA instance per org": { + "$ref": "#/components/examples/ErrorCAPTCHALimitOfOne" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.captchas.manage" + ] + } + ], + "summary": "Create a CAPTCHA instance", + "tags": [ + "CAPTCHA" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/captchas/{captchaId}": { + "delete": { + "description": "Deletes a specified CAPTCHA instance\n> **Note:** If your CAPTCHA instance is still associated with your org, the request fails. You must first update your Org-wide CAPTCHA settings to remove the CAPTCHA instance.", + "operationId": "deleteCaptchaInstance", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + }, + "Cannot remove CAPTCHA in use": { + "$ref": "#/components/examples/ErrorCAPTCHAOrgWideSetting" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden", + "headers": {} + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.captchas.manage" + ] + } + ], + "summary": "Delete a CAPTCHA instance", + "tags": [ + "CAPTCHA" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "get": { + "description": "Retrieves the properties of a specified CAPTCHA instance", + "operationId": "getCaptchaInstance", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "HCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceResponseHCaptcha" + }, + "ReCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceResponseReCaptcha" + } + }, + "schema": { + "$ref": "#/components/schemas/CAPTCHAInstance" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.captchas.read" + ] + } + ], + "summary": "Retrieve a CAPTCHA instance", + "tags": [ + "CAPTCHA" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathCaptchaId" + } + ], + "post": { + "description": "Partially updates the properties of a specified CAPTCHA instance", + "operationId": "updateCaptchaInstance", + "requestBody": { + "content": { + "application/json": { + "examples": { + "HCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceRequestHCaptcha" + }, + "ReCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceRequestReCaptcha" + } + }, + "schema": { + "$ref": "#/components/schemas/CAPTCHAInstance" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "HCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceResponseHCaptcha" + }, + "ReCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceResponseReCaptcha" + } + }, + "schema": { + "$ref": "#/components/schemas/CAPTCHAInstance" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.captchas.manage" + ] + } + ], + "summary": "Update a CAPTCHA instance", + "tags": [ + "CAPTCHA" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "put": { + "description": "Replaces the properties for a specified CAPTCHA instance", + "operationId": "replaceCaptchaInstance", + "requestBody": { + "content": { + "application/json": { + "examples": { + "HCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceRequestHCaptcha" + }, + "ReCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceRequestReCaptcha" + } + }, + "schema": { + "$ref": "#/components/schemas/CAPTCHAInstance" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "HCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceResponseHCaptcha" + }, + "ReCaptcha": { + "$ref": "#/components/examples/CAPTCHAInstanceResponseReCaptcha" + } + }, + "schema": { + "$ref": "#/components/schemas/CAPTCHAInstance" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.captchas.manage" + ] + } + ], + "summary": "Replace a CAPTCHA instance", + "tags": [ + "CAPTCHA" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/device-assurances": { + "get": { + "description": "Lists all device assurance policies", + "operationId": "listDeviceAssurancePolicies", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/DeviceAssurance" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.deviceAssurance.read" + ] + } + ], + "summary": "List all device assurance policies", + "tags": [ + "DeviceAssurance" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "post": { + "description": "Creates a new device assurance policy", + "operationId": "createDeviceAssurancePolicy", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Android": { + "$ref": "#/components/examples/DeviceAssuranceAndroidRequest" + }, + "AndroidWithAndroidDeviceTrustThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithAndroidDeviceTrustThirdPartySignalProvidersRequest" + }, + "AndroidWithCallerContext": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithCallerContextRequest" + }, + "AndroidWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithDevicePostureIdPThirdPartySignalProvidersRequest" + }, + "AndroidWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithDynamicVersionRequirementRequest" + }, + "AndroidWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithGracePeriodRequest" + }, + "ChromeOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithDevicePostureIdPThirdPartySignalProvidersRequest" + }, + "ChromeOSWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithDeviceTrustConnectorThirdPartySignalProvidersRequest" + }, + "ChromeOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithGracePeriodRequest" + }, + "MacOS": { + "$ref": "#/components/examples/DeviceAssuranceMacOSRequest" + }, + "MacOSWithDevicePostureChecks": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDevicePostureChecksRequest" + }, + "MacOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDevicePostureIdPThirdPartySignalProvidersRequest" + }, + "MacOSWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDeviceTrustConnectorThirdPartySignalProvidersRequest" + }, + "MacOSWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDynamicVersionRequirementRequest" + }, + "MacOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithGracePeriodRequest" + }, + "Windows": { + "$ref": "#/components/examples/DeviceAssuranceWindowsRequest" + }, + "WindowsWithDevicePostureChecks": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDevicePostureChecksRequest" + }, + "WindowsWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDevicePostureIdPThirdPartySignalProvidersRequest" + }, + "WindowsWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDeviceTrustConnectorThirdPartySignalProvidersRequest" + }, + "WindowsWithDynamicVersionRequirements": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDynamicVersionRequirementsRequest" + }, + "WindowsWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithGracePeriodRequest" + }, + "WindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionString": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionStringRequest" + }, + "WindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirementRequest" + }, + "iOS": { + "$ref": "#/components/examples/DeviceAssuranceIosRequest" + }, + "iOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceIosWithDevicePostureIdPSignalProvidersRequest" + }, + "iOSWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceIosWithDynamicVersionRequirementRequest" + }, + "iOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceIosWithGracePeriodRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/DeviceAssurance" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Android": { + "$ref": "#/components/examples/DeviceAssuranceAndroidResponse" + }, + "AndroidWithAndroidDeviceTrustThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithAndroidDeviceTrustThirdPartySignalProvidersResponse" + }, + "AndroidWithCallerContext": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithCallerContextResponse" + }, + "AndroidWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "AndroidWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithDynamicVersionRequirementResponse" + }, + "AndroidWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithGracePeriodResponse" + }, + "ChromeOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "ChromeOSWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithDeviceTrustConnectorThirdPartySignalProvidersResponse" + }, + "ChromeOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithGracePeriodResponse" + }, + "MacOS": { + "$ref": "#/components/examples/DeviceAssuranceMacOSResponse" + }, + "MacOSWithDevicePostureChecks": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDevicePostureChecksResponse" + }, + "MacOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "MacOSWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDeviceTrustConnectorThirdPartySignalProvidersResponse" + }, + "MacOSWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDynamicVersionRequirementResponse" + }, + "MacOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithGracePeriodResponse" + }, + "Windows": { + "$ref": "#/components/examples/DeviceAssuranceWindowsResponse" + }, + "WindowsWithDevicePostureChecks": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDevicePostureChecksResponse" + }, + "WindowsWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "WindowsWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDeviceTrustConnectorThirdPartySignalProvidersResponse" + }, + "WindowsWithDynamicVersionRequirements": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDynamicVersionRequirementsResponse" + }, + "WindowsWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithGracePeriodResponse" + }, + "WindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionString": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionStringResponse" + }, + "WindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirementResponse" + }, + "iOS": { + "$ref": "#/components/examples/DeviceAssuranceIosResponse" + }, + "iOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceIosWithDevicePostureIdPSignalProvidersResponse" + }, + "iOSWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceIosWithDynamicVersionRequirementResponse" + }, + "iOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceIosWithGracePeriodResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DeviceAssurance" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.deviceAssurance.manage" + ] + } + ], + "summary": "Create a device assurance policy", + "tags": [ + "DeviceAssurance" + ], + "x-codegen-request-body-name": "deviceAssurance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/device-assurances/{deviceAssuranceId}": { + "delete": { + "description": "Deletes a device assurance policy by `deviceAssuranceId`. If the device assurance policy is currently being used in the org Authentication Policies, the delete will not be allowed.", + "operationId": "deleteDeviceAssurancePolicy", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "409": { + "content": { + "application/json": { + "examples": { + "ErrorDeviceAssuranceInUse": { + "$ref": "#/components/examples/ErrorDeviceAssuranceInUse" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Conflict", + "headers": {} + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.deviceAssurance.manage" + ] + } + ], + "summary": "Delete a device assurance policy", + "tags": [ + "DeviceAssurance" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "get": { + "description": "Retrieves a device assurance policy by `deviceAssuranceId`", + "operationId": "getDeviceAssurancePolicy", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Android": { + "$ref": "#/components/examples/DeviceAssuranceAndroidResponse" + }, + "AndroidWithAndroidDeviceTrustThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithAndroidDeviceTrustThirdPartySignalProvidersResponse" + }, + "AndroidWithCallerContext": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithCallerContextResponse" + }, + "AndroidWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "AndroidWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithDynamicVersionRequirementResponse" + }, + "AndroidWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithGracePeriodResponse" + }, + "ChromeOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "ChromeOSWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithDeviceTrustConnectorThirdPartySignalProvidersResponse" + }, + "ChromeOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithGracePeriodResponse" + }, + "MacOS": { + "$ref": "#/components/examples/DeviceAssuranceMacOSResponse" + }, + "MacOSWithDevicePostureChecks": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDevicePostureChecksResponse" + }, + "MacOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "MacOSWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDeviceTrustConnectorThirdPartySignalProvidersResponse" + }, + "MacOSWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDynamicVersionRequirementResponse" + }, + "MacOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithGracePeriodResponse" + }, + "Windows": { + "$ref": "#/components/examples/DeviceAssuranceWindowsResponse" + }, + "WindowsWithDevicePostureChecks": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDevicePostureChecksResponse" + }, + "WindowsWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "WindowsWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDeviceTrustConnectorThirdPartySignalProvidersResponse" + }, + "WindowsWithDynamicVersionRequirements": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDynamicVersionRequirementsResponse" + }, + "WindowsWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithGracePeriodResponse" + }, + "WindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionString": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionStringResponse" + }, + "WindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirementResponse" + }, + "iOS": { + "$ref": "#/components/examples/DeviceAssuranceIosResponse" + }, + "iOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceIosWithDevicePostureIdPSignalProvidersResponse" + }, + "iOSWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceIosWithDynamicVersionRequirementResponse" + }, + "iOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceIosWithGracePeriodResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DeviceAssurance" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.deviceAssurance.read" + ] + } + ], + "summary": "Retrieve a device assurance policy", + "tags": [ + "DeviceAssurance" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceAssuranceId" + } + ], + "put": { + "description": "Replaces a device assurance policy by `deviceAssuranceId`", + "operationId": "replaceDeviceAssurancePolicy", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Android": { + "$ref": "#/components/examples/DeviceAssuranceAndroidRequest" + }, + "AndroidWithAndroidDeviceTrustThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithAndroidDeviceTrustThirdPartySignalProvidersRequest" + }, + "AndroidWithCallerContext": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithCallerContextRequest" + }, + "AndroidWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithDevicePostureIdPThirdPartySignalProvidersRequest" + }, + "AndroidWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithDynamicVersionRequirementRequest" + }, + "AndroidWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithGracePeriodRequest" + }, + "ChromeOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithDevicePostureIdPThirdPartySignalProvidersRequest" + }, + "ChromeOSWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithDeviceTrustConnectorThirdPartySignalProvidersRequest" + }, + "ChromeOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithGracePeriodRequest" + }, + "MacOS": { + "$ref": "#/components/examples/DeviceAssuranceMacOSRequest" + }, + "MacOSWithDevicePostureChecks": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDevicePostureChecksRequest" + }, + "MacOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDevicePostureIdPThirdPartySignalProvidersRequest" + }, + "MacOSWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDeviceTrustConnectorThirdPartySignalProvidersRequest" + }, + "MacOSWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDynamicVersionRequirementRequest" + }, + "MacOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithGracePeriodRequest" + }, + "Windows": { + "$ref": "#/components/examples/DeviceAssuranceWindowsRequest" + }, + "WindowsWithDevicePostureChecks": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDevicePostureChecksRequest" + }, + "WindowsWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDevicePostureIdPThirdPartySignalProvidersRequest" + }, + "WindowsWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDeviceTrustConnectorThirdPartySignalProvidersRequest" + }, + "WindowsWithDynamicVersionRequirements": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDynamicVersionRequirementsRequest" + }, + "WindowsWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithGracePeriodRequest" + }, + "WindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionString": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionStringRequest" + }, + "WindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirementRequest" + }, + "iOS": { + "$ref": "#/components/examples/DeviceAssuranceIosRequest" + }, + "iOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceIosWithDevicePostureIdPSignalProvidersRequest" + }, + "iOSWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceIosWithDynamicVersionRequirementRequest" + }, + "iOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceIosWithGracePeriodRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/DeviceAssurance" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Android": { + "$ref": "#/components/examples/DeviceAssuranceAndroidResponse" + }, + "AndroidWithAndroidDeviceTrustThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithAndroidDeviceTrustThirdPartySignalProvidersResponse" + }, + "AndroidWithCallerContext": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithCallerContextResponse" + }, + "AndroidWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "AndroidWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithDynamicVersionRequirementResponse" + }, + "AndroidWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceAndroidWithGracePeriodResponse" + }, + "ChromeOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "ChromeOSWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithDeviceTrustConnectorThirdPartySignalProvidersResponse" + }, + "ChromeOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceChromeOSWithGracePeriodResponse" + }, + "MacOS": { + "$ref": "#/components/examples/DeviceAssuranceMacOSResponse" + }, + "MacOSWithDevicePostureChecks": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDevicePostureChecksResponse" + }, + "MacOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "MacOSWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDeviceTrustConnectorThirdPartySignalProvidersResponse" + }, + "MacOSWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithDynamicVersionRequirementResponse" + }, + "MacOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceMacOSWithGracePeriodResponse" + }, + "Windows": { + "$ref": "#/components/examples/DeviceAssuranceWindowsResponse" + }, + "WindowsWithDevicePostureChecks": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDevicePostureChecksResponse" + }, + "WindowsWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDevicePostureIdPThirdPartySignalProvidersResponse" + }, + "WindowsWithDeviceTrustConnectorThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDeviceTrustConnectorThirdPartySignalProvidersResponse" + }, + "WindowsWithDynamicVersionRequirements": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithDynamicVersionRequirementsResponse" + }, + "WindowsWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithGracePeriodResponse" + }, + "WindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionString": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionStringResponse" + }, + "WindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceWindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirementResponse" + }, + "iOS": { + "$ref": "#/components/examples/DeviceAssuranceIosResponse" + }, + "iOSWithDevicePostureIdPThirdPartySignalProviders": { + "$ref": "#/components/examples/DeviceAssuranceIosWithDevicePostureIdPSignalProvidersResponse" + }, + "iOSWithDynamicVersionRequirement": { + "$ref": "#/components/examples/DeviceAssuranceIosWithDynamicVersionRequirementResponse" + }, + "iOSWithGracePeriod": { + "$ref": "#/components/examples/DeviceAssuranceIosWithGracePeriodResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DeviceAssurance" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.deviceAssurance.manage" + ] + } + ], + "summary": "Replace a device assurance policy", + "tags": [ + "DeviceAssurance" + ], + "x-codegen-request-body-name": "deviceAssurance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/device-integrations": { + "get": { + "description": "Lists all device integrations for your org. Examples include Device Posture Provider, Windows Security Center, Chrome Device Trust, OSQuery, and Android Device Trust.", + "operationId": "listDeviceIntegrations", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/DeviceIntegrations" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.deviceIntegrations.read" + ] + } + ], + "summary": "List all device integrations", + "tags": [ + "DeviceIntegrations" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/device-integrations/{deviceIntegrationId}": { + "get": { + "description": "Retrieves a device integration by `deviceIntegrationId`", + "operationId": "getDeviceIntegration", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AndroidZeroTrust": { + "$ref": "#/components/examples/DeviceIntegrationAndroidZeroTrustResponse" + }, + "ChromeDeviceTrustConnector": { + "$ref": "#/components/examples/DeviceIntegrationChromeDeviceTrustConnectorResponse" + }, + "CrowdStrike": { + "$ref": "#/components/examples/DeviceIntegrationCrowdStrikeResponse" + }, + "DevicePostureCheck": { + "$ref": "#/components/examples/DeviceIntegrationDevicePostureCheckResponse" + }, + "DevicePostureIdP": { + "$ref": "#/components/examples/DeviceIntegrationDevicePostureIdPResponse" + }, + "WindowsSecurityCenter": { + "$ref": "#/components/examples/DeviceIntegrationWindowsSecurityCenterResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DeviceIntegrations" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.deviceIntegrations.read" + ] + } + ], + "summary": "Retrieve a device integration", + "tags": [ + "DeviceIntegrations" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceIntegrationId" + } + ] + }, + "/api/v1/device-integrations/{deviceIntegrationId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceIntegrationId" + } + ], + "post": { + "description": "Activates a device integration and populates the related configurations by `deviceIntegrationId`", + "operationId": "activateDeviceIntegration", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AndroidZeroTrust": { + "$ref": "#/components/examples/DeviceIntegrationAndroidZeroTrustResponse" + }, + "ChromeDeviceTrustConnector": { + "$ref": "#/components/examples/DeviceIntegrationChromeDeviceTrustConnectorResponse" + }, + "DevicePostureCheck": { + "$ref": "#/components/examples/DeviceIntegrationDevicePostureCheckResponse" + }, + "DevicePostureIdP": { + "$ref": "#/components/examples/DeviceIntegrationDevicePostureIdPResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DeviceIntegrations" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.deviceIntegrations.manage" + ] + } + ], + "summary": "Activate a device integration", + "tags": [ + "DeviceIntegrations" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/device-integrations/{deviceIntegrationId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceIntegrationId" + } + ], + "post": { + "description": "Deactivates a device integration by `deviceIntegrationId`", + "operationId": "deactivateDeviceIntegration", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CrowdStrike": { + "$ref": "#/components/examples/DeviceIntegrationCrowdStrikeResponse" + }, + "WindowsSecurityCenter": { + "$ref": "#/components/examples/DeviceIntegrationWindowsSecurityCenterResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DeviceIntegrations" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.deviceIntegrations.manage" + ] + } + ], + "summary": "Deactivate a device integration", + "tags": [ + "DeviceIntegrations" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/device-posture-checks": { + "get": { + "description": "Lists all device posture checks", + "operationId": "listDevicePostureChecks", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/DevicePostureCheck" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devicePostureChecks.read" + ] + } + ], + "summary": "List all device posture checks", + "tags": [ + "DevicePostureCheck" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "post": { + "description": "Creates a device posture check", + "operationId": "createDevicePostureCheck", + "requestBody": { + "content": { + "application/json": { + "examples": { + "MacOS": { + "$ref": "#/components/examples/DevicePostureChecksMacOSRequest" + }, + "Windows": { + "$ref": "#/components/examples/DevicePostureChecksWindowsRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/DevicePostureCheck" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "MacOS": { + "$ref": "#/components/examples/DevicePostureChecksMacOSResponse" + }, + "Windows": { + "$ref": "#/components/examples/DevicePostureChecksWindowsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DevicePostureCheck" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devicePostureChecks.manage" + ] + } + ], + "summary": "Create a device posture check", + "tags": [ + "DevicePostureCheck" + ], + "x-codegen-request-body-name": "devicePostureCheck", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/device-posture-checks/default": { + "get": { + "description": "Lists all default device posture checks. Default device posture checks are defined by Okta. Their type will always be `BUILTIN`.", + "operationId": "listDefaultDevicePostureChecks", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/DevicePostureCheck" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devicePostureChecks.read" + ] + } + ], + "summary": "List all default device posture checks", + "tags": [ + "DevicePostureCheck" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/device-posture-checks/{postureCheckId}": { + "delete": { + "description": "Deletes a device posture check by `postureCheckId`. You can't delete the device posture check if it's used in a device assurance policy.", + "operationId": "deleteDevicePostureCheck", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "409": { + "content": { + "application/json": { + "examples": { + "ErrorDeviceCheckInUse": { + "$ref": "#/components/examples/ErrorDevicePostureCheckInUse" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Conflict", + "headers": {} + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devicePostureChecks.manage" + ] + } + ], + "summary": "Delete a device posture check", + "tags": [ + "DevicePostureCheck" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "get": { + "description": "Retrieves a device posture check by `postureCheckId`", + "operationId": "getDevicePostureCheck", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "MacOS": { + "$ref": "#/components/examples/DevicePostureChecksMacOSResponse" + }, + "Windows": { + "$ref": "#/components/examples/DevicePostureChecksWindowsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DevicePostureCheck" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devicePostureChecks.read" + ] + } + ], + "summary": "Retrieve a device posture check", + "tags": [ + "DevicePostureCheck" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPostureCheckId" + } + ], + "put": { + "description": "Replaces a device posture check by `postureCheckId`", + "operationId": "replaceDevicePostureCheck", + "requestBody": { + "content": { + "application/json": { + "examples": { + "MacOS": { + "$ref": "#/components/examples/DevicePostureChecksMacOSRequest" + }, + "Windows": { + "$ref": "#/components/examples/DevicePostureChecksWindowsRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/DevicePostureCheck" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "MacOS": { + "$ref": "#/components/examples/DevicePostureChecksMacOSResponse" + }, + "Windows": { + "$ref": "#/components/examples/DevicePostureChecksWindowsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DevicePostureCheck" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devicePostureChecks.manage" + ] + } + ], + "summary": "Replace a device posture check", + "tags": [ + "DevicePostureCheck" + ], + "x-codegen-request-body-name": "devicePostureCheck", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/devices": { + "get": { + "description": "Lists all devices with pagination support.\n\n>**Note:** To list all devices enrolled by a user, use the [List all devices endpoint in the User Resources API](/openapi/okta-management/management/userresources/listuserdevices).\n\nYou can return a subset of devices that match a supported search criteria using the `search` query parameter.\nSearches for devices based on the properties specified in the `search` parameter conforming SCIM filter specifications (case-insensitive). This data is eventually consistent. The API returns different results depending on specified queries in the request. Empty list is returned if no objects match `search` request.\n\n> **Note:** The `search` parameter results are sourced from an eventually consistent datasource and may not reflect the latest information.\n\nDon't use search results directly for record updates, as the data might be stale and therefore overwrite newer data, resulting in data loss.\n\nUse an `id` lookup for records that you update to ensure your results contain the latest data.\n\nThis operation requires [URL encoding](https://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1). For example, `search=profile.displayName eq \"Bob\"` is encoded as `search=profile.displayName%20eq%20%22Bob%22`.", + "operationId": "listDevices", + "parameters": [ + { + "in": "query", + "name": "after", + "schema": { + "description": "The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information.", + "example": "200u3des4afA47rYJu1d7", + "type": "string" + } + }, + { + "description": "A limit on the number of objects to return (recommend `20`)", + "in": "query", + "name": "limit", + "schema": { + "default": 200, + "example": 20, + "maximum": 200, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A SCIM filter expression that filters the results. Searches include all device `profile` properties and the device `id`, `status`, and `lastUpdated` properties.\n\nSearches for devices can be filtered by the contains (`co`) operator. You can only use `co` with these select device profile attributes: `profile.displayName`, `profile.serialNumber`, `profile.imei`, `profile.meid`, `profile.udid`, and `profile.sid`. See [Operators](https://developer.okta.com/docs/api/#operators).", + "examples": { + "FilterByDeviceDisplayName": { + "summary": "Filter by device display name", + "value": "profile.displayName eq \"Bob\"" + }, + "FilterByDeviceId": { + "summary": "Filter by device ID", + "value": "id eq \"guo4a5u7JHHhjXrMK0g4\"" + }, + "FilterByDevicePlatform": { + "summary": "Filter by device platform", + "value": "profile.platform eq \"WINDOWS\"" + }, + "FilterByDeviceStatus": { + "summary": "Filter by device status", + "value": "status eq \"ACTIVE\"" + }, + "FilterByLastUpdatedTime": { + "summary": "Filter by last updated time", + "value": "lastUpdated gt \"2024-12-23T00:00:00.000Z\"" + }, + "FilterBySID": { + "summary": "Filter by device security identifier (SID)", + "value": "profile.sid sw \"S-1\"" + } + }, + "in": "query", + "name": "search", + "schema": { + "example": "lastUpdated gt \"2019-06-01T09:00:00.000Z\"", + "type": "string" + } + }, + { + "description": "Includes associated user details and management status for the device in the `_embedded` attribute", + "examples": { + "UserFullDetails": { + "summary": "Get a detailed list of associated users", + "value": "user" + }, + "UserSummaries": { + "summary": "Get the list of associated user summaries", + "value": "userSummary" + } + }, + "in": "query", + "name": "expand", + "schema": { + "enum": [ + "user", + "userSummary" + ], + "example": "userSummary", + "type": "string", + "x-enumDescriptions": { + "user": "Lists full details for associated users", + "userSummary": "Lists summaries for associated users" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "APIDevicesResponseExample": { + "$ref": "#/components/examples/APIDevicesListAllResponse", + "type": "array" + }, + "APIDevicesResponseUserSummaryExample": { + "$ref": "#/components/examples/APIDevicesListAllUserSummaryResponse", + "type": "array" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/DeviceList" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devices.read" + ] + } + ], + "summary": "List all devices", + "tags": [ + "Device" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/devices/{deviceId}": { + "delete": { + "description": "Deletes (permanently) a device by `deviceId` if it has a status of `DEACTIVATED`. You can transition the device to `DEACTIVATED` status using the [Deactivate a Device](/openapi/okta-management/management/tags/device/other/deactivatedevice) endpoint.\nThis request is destructive and deletes all of the profile data related to the device. Once deleted, device data can't be recovered. However, reenrollment creates a new device record.\n> **Note:** Attempts to delete a device that isn't in a `DEACTIVATED` state raise an error.", + "operationId": "deleteDevice", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden", + "headers": {} + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devices.manage" + ] + } + ], + "summary": "Delete a device", + "tags": [ + "Device" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "get": { + "description": "Retrieves a device by `deviceId`", + "operationId": "getDevice", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "APIDevicesResponseExample": { + "$ref": "#/components/examples/DeviceResponse" + }, + "APIDevicesWithProvidersResponseExample": { + "$ref": "#/components/examples/DeviceWithProvidersResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DeviceWithProviders" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devices.read" + ] + } + ], + "summary": "Retrieve a device", + "tags": [ + "Device" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceId" + } + ] + }, + "/api/v1/devices/{deviceId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceId" + } + ], + "post": { + "description": "Activates a device by setting its status to `ACTIVE` by `deviceId`.\nActivated devices are used to create and delete device user links.", + "operationId": "activateDevice", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devices.manage" + ] + } + ], + "summary": "Activate a device", + "tags": [ + "Device" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/devices/{deviceId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceId" + } + ], + "post": { + "description": "Deactivates a device by setting its status to `DEACTIVATED` by `deviceId`.\nDeactivation causes a device to lose all device user links. Set the device status to `DEACTIVATED` before deleting it.\n> **Note:** When deactivating a Device, keep in mind the following:\n - Device deactivation is a destructive operation for device factors and client certificates. Device reenrollment using Okta Verify allows end users to set up new factors on the device.\n - Device deletion removes the device record from Okta. Reenrollment creates a new device record.", + "operationId": "deactivateDevice", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devices.manage" + ] + } + ], + "summary": "Deactivate a device", + "tags": [ + "Device" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/devices/{deviceId}/lifecycle/suspend": { + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceId" + } + ], + "post": { + "description": "Suspends a device by setting its status to `SUSPENDED`.\nUse suspended devices to create and delete device user links. You can only unsuspend or deactivate suspended devices.\n> **Note:** `SUSPENDED` status is meant to be temporary, so it isn't destructive.", + "operationId": "suspendDevice", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devices.manage" + ] + } + ], + "summary": "Suspend a Device", + "tags": [ + "Device" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/devices/{deviceId}/lifecycle/unsuspend": { + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceId" + } + ], + "post": { + "description": "Unsuspends a device by returning its `status` to `ACTIVE`.\n>**Note:** Only devices with a `SUSPENDED` status can be unsuspended.", + "operationId": "unsuspendDevice", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devices.manage" + ] + } + ], + "summary": "Unsuspend a Device", + "tags": [ + "Device" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/devices/{deviceId}/os-accounts": { + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceId" + } + ] + }, + "/api/v1/devices/{deviceId}/os-accounts/{osAccountId}": { + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceId" + }, + { + "$ref": "#/components/parameters/pathOsAccountId" + } + ] + }, + "/api/v1/devices/{deviceId}/users": { + "get": { + "description": "Lists all Users for a device by `deviceId`", + "operationId": "listDeviceUsers", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "APIDevicesListAllUsersResponseExample": { + "$ref": "#/components/examples/APIDevicesListAllUsersResponse", + "summary": "List all users for a specific device" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/DeviceUser" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.devices.read" + ] + } + ], + "summary": "List all users for a device", + "tags": [ + "Device" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathDeviceId" + } + ] + }, + "/api/v1/directories/{appInstanceId}/groups/modify": { + "parameters": [ + { + "$ref": "#/components/parameters/appInstanceId" + } + ], + "post": { + "description": "Updates an Active Directory or LDAP group membership directly in the Active Directory or LDAP server.\n\nYou can add or remove users from groups based on their identity and access requirements. This ensures that changes made to user access in Okta are reflected in AD or LDAP. When you use Okta Access Certifications to revoke a user's membership to an AD or LDAP group, the removal is reflected in AD or LDAP.\n\nSee [AD Bidirectional Group Management](https://help.okta.com/okta_help.htm?type=oie&id=ad-bidirectional-group-mgmt) and [LDAP Bidirectional Group Management](https://help.okta.com/okta_help.htm?type=oie&id=ldap-bidirectional-group-mgmt).", + "operationId": "updateGroupMembership", + "requestBody": { + "content": { + "application/json": { + "examples": { + "addADUserToGroup": { + "$ref": "#/components/examples/add-user-request" + }, + "addLdapUserToGroup": { + "$ref": "#/components/examples/add-ldap-user-request" + } + }, + "schema": { + "$ref": "#/components/schemas/AgentAction" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "examples": { + "APIValidationFailed": { + "$ref": "#/components/examples/ErrorApiValidationFailed" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "502": { + "$ref": "#/components/responses/Error502NoConnectedAgents" + }, + "504": { + "$ref": "#/components/responses/Error504AgentTimeOut" + } + }, + "security": [ + { + "oauth2": [ + "okta.directories.groups.manage" + ] + } + ], + "summary": "Update an external directory group membership", + "tags": [ + "DirectoriesIntegration" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/directories/{appInstanceId}/groups/{groupId}/query": { + "parameters": [ + { + "$ref": "#/components/parameters/adAppInstanceId" + }, + { + "$ref": "#/components/parameters/groupId" + } + ], + "post": { + "description": "Submits a query search on the on-premises agent to asynchronously fetch specific Active Directory (AD) attributes for a group.\nReturns a `resultId` that is used to poll for the results.", + "operationId": "submitGroupAttributeQuery", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupQueryRequest" + } + } + }, + "required": true + }, + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupQueryResponse" + } + } + }, + "description": "Accepted. Query initiated." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "502": { + "$ref": "#/components/responses/Error502NoConnectedAgents" + }, + "504": { + "$ref": "#/components/responses/Error504AgentTimeOut" + } + }, + "security": [ + { + "oauth2": [ + "okta.directories.groups.read" + ] + } + ], + "summary": "Submit a query for AD Group", + "tags": [ + "DirectoriesIntegration" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/directories/{appInstanceId}/groups/{groupId}/query/{resultId}": { + "get": { + "description": "Retrieves the results of the requested Active Directory (AD) group attributes using the `resultId` returned from the `POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query` call.\nIf the operation has expired or if the `resultId` is invalid, returns a `404` status.", + "operationId": "getGroupAttributeQueryResult", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupProfileResult" + } + } + }, + "description": "OK. Returns the group profile." + }, + "202": { + "description": "Accepted. Query is still in progress." + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + } + }, + "security": [ + { + "oauth2": [ + "okta.directories.groups.read" + ] + } + ], + "summary": "Retrieve the results of an AD group query", + "tags": [ + "DirectoriesIntegration" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/adAppInstanceId" + }, + { + "$ref": "#/components/parameters/groupId" + }, + { + "$ref": "#/components/parameters/queryResultId" + } + ] + }, + "/api/v1/domains": { + "get": { + "description": "Lists all verified custom domains for the org", + "operationId": "listCustomDomains", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DomainListResponse" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.domains.read" + ] + } + ], + "summary": "List all custom domains", + "tags": [ + "CustomDomain" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates your custom domain", + "operationId": "createCustomDomain", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DomainRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DomainResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.domains.manage" + ] + } + ], + "summary": "Create a custom domain", + "tags": [ + "CustomDomain" + ], + "x-codegen-request-body-name": "domain", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/domains/{domainId}": { + "delete": { + "description": "Deletes a custom domain by `domainId`", + "operationId": "deleteCustomDomain", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.domains.manage" + ] + } + ], + "summary": "Delete a custom domain", + "tags": [ + "CustomDomain" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a custom domain by `domainId`", + "operationId": "getCustomDomain", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DomainResponse" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.domains.read" + ] + } + ], + "summary": "Retrieve a custom domain", + "tags": [ + "CustomDomain" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathDomainId" + } + ], + "put": { + "description": "Replaces a custom domain's brand", + "operationId": "replaceCustomDomain", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateDomain" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DomainResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.domains.manage" + ] + } + ], + "summary": "Replace a custom domain's brand", + "tags": [ + "CustomDomain" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/domains/{domainId}/certificate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathDomainId" + } + ], + "put": { + "description": "Upserts (creates or renews) the `MANUAL` certificate for the custom domain\n\n> **Notes:**\n> * If the existing `certificateSourceType` is `OKTA_MANAGED`, this operation changes the source type to `MANUAL`. Okta no longer manages and renews certificates for this domain after you provide a user-managed certificate.\n> * Okta supports TLS certificates and private keys that are PEM-encoded and 2048, 3072, or 4096 bits. See the [Custom domain guide](https://developer.okta.com/docs/guides/custom-url-domain/main/) for more details.", + "operationId": "upsertCertificate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DomainCertificate" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.domains.manage" + ] + } + ], + "summary": "Upsert the custom domain's certificate", + "tags": [ + "CustomDomain" + ], + "x-codegen-request-body-name": "certificate", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/domains/{domainId}/verify": { + "parameters": [ + { + "$ref": "#/components/parameters/pathDomainId" + } + ], + "post": { + "description": "Verifies the custom domain and validity of DNS records by `domainId`. Verify your custom domain to confirm that you own or control the domain and that you have properly configured the required DNS records. Furthermore, if the `certificateSourceType` in the domain is `OKTA_MANAGED`, then an attempt is made to obtain and install a certificate. After a certificate is obtained and installed by Okta, Okta manages the certificate including certificate renewal.\n\nVerify your custom domain after you've [created it](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/CustomDomain/#tag/CustomDomain/operation/createCustomDomain) and after you've added your DNS records to your domain provider. Okta doesn't verify your domain automatically. You must use the API to verify your custom domain if you change your DNS records or if you encounter issues with domain validation.\n\n> **Note:** DNS record changes can take time to propagate. If you recently updated your DNS records, you may need to wait before verifying your custom domain. If you encounter issues with domain verification, double-check your DNS records and ensure that they're correctly configured. See [Update your DNS records](https://developer.okta.com/docs/guides/custom-url-domain/main/#update-your-dns-txt).", + "operationId": "verifyDomain", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DomainResponse" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.domains.manage" + ] + } + ], + "summary": "Verify a custom domain", + "tags": [ + "CustomDomain" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/dr/failback": { + "post": { + "description": "Starts the failback of your org", + "operationId": "startOrgFailback", + "requestBody": { + "content": { + "application/json": { + "examples": { + "example1": { + "summary": "A sample Okta domain to failback", + "value": { + "domains": [ + "yourOktaDomain.okta.com" + ] + } + }, + "example2": { + "summary": "An empty object", + "value": {} + } + }, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/FailbackRequestSchema" + }, + { + "$ref": "#/components/schemas/EmptyRequestSchema" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + } + } + }, + "description": "The request body is optional. You can specify a domain to failback, an empty object (`{}`), or no payload.", + "required": false + }, + "responses": { + "200": { + "$ref": "#/components/responses/FailbackResponse" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + }, + "500": { + "$ref": "#/components/responses/ErrorInternalServer500" + } + }, + "security": [ + { + "oauth2": [ + "okta.dr.manage" + ] + } + ], + "servers": [ + { + "url": "https://drapp.yourOrgSubDomain.okta.com" + } + ], + "summary": "Start the failback of your org", + "tags": [ + "DisasterRecovery" + ], + "x-okta-lifecycle": { + "lifecycle": "EA" + } + } + }, + "/api/v1/dr/failover": { + "post": { + "description": "Starts the failover of your org", + "operationId": "startOrgFailover", + "requestBody": { + "content": { + "application/json": { + "examples": { + "example1": { + "summary": "A sample Okta domain to failover", + "value": { + "domains": [ + "yourOktaDomain.okta.com" + ] + } + }, + "example2": { + "summary": "An empty object", + "value": {} + } + }, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/FailoverRequestSchema" + }, + { + "$ref": "#/components/schemas/EmptyRequestSchema" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + } + } + }, + "description": "The request body is optional. You can specify a domain to failover, an empty object (`{}`), or no payload.", + "required": false + }, + "responses": { + "200": { + "$ref": "#/components/responses/FailoverResponse" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + }, + "500": { + "$ref": "#/components/responses/ErrorInternalServer500" + } + }, + "security": [ + { + "oauth2": [ + "okta.dr.manage" + ] + } + ], + "servers": [ + { + "url": "https://drapp.yourOrgSubDomain.okta.com" + } + ], + "summary": "Start the failover of your org", + "tags": [ + "DisasterRecovery" + ], + "x-okta-lifecycle": { + "lifecycle": "EA" + } + } + }, + "/api/v1/dr/status": { + "get": { + "description": "Retrieves the failover or failback status for all the domains for your org", + "operationId": "getDRStatus", + "responses": { + "200": { + "$ref": "#/components/responses/DRStatusResponse" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + }, + "500": { + "$ref": "#/components/responses/ErrorInternalServer500" + } + }, + "security": [ + { + "oauth2": [ + "okta.dr.read" + ] + } + ], + "servers": [ + { + "url": "https://drapp.yourOrgSubDomain.okta.com" + } + ], + "summary": "Retrieve the disaster recovery status for all domains", + "tags": [ + "DisasterRecovery" + ], + "x-okta-lifecycle": { + "lifecycle": "EA" + } + } + }, + "/api/v1/dr/status/{domain}": { + "get": { + "description": "Retrieves the failover or failback status for the domain specified in the request path", + "operationId": "getDRStatusForDomain", + "responses": { + "200": { + "$ref": "#/components/responses/DRStatusResponse" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + }, + "500": { + "$ref": "#/components/responses/ErrorInternalServer500" + } + }, + "security": [ + { + "oauth2": [ + "okta.dr.read" + ] + } + ], + "servers": [ + { + "url": "https://drapp.yourOktaDomain.okta.com" + } + ], + "summary": "Retrieve the disaster recovery status for a domain", + "tags": [ + "DisasterRecovery" + ], + "x-okta-lifecycle": { + "lifecycle": "EA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/domain" + } + ] + }, + "/api/v1/email-domains": { + "get": { + "description": "Lists all the Email Domains in your org", + "operationId": "listEmailDomains", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "List email domain response": { + "$ref": "#/components/examples/EmailDomainResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/EmailDomainResponseWithEmbedded" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailDomains.read" + ] + } + ], + "summary": "List all email domains", + "tags": [ + "EmailDomain" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/queryExpandEmailDomain" + } + ], + "post": { + "description": "Creates an Email Domain in your org", + "operationId": "createEmailDomain", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Create email domain request": { + "$ref": "#/components/examples/CreateEmailDomainRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailDomain" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Create email domain response": { + "$ref": "#/components/examples/EmailDomainResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailDomainResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "409": { + "content": { + "application/json": { + "examples": { + "Email domain already exists": { + "$ref": "#/components/examples/ErrorEmailDomainAlreadyExists" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Conflict" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailDomains.manage" + ] + } + ], + "summary": "Create an email domain", + "tags": [ + "EmailDomain" + ], + "x-codegen-request-body-name": "emailDomain", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/email-domains/{emailDomainId}": { + "delete": { + "description": "Deletes an Email Domain by `emailDomainId`", + "operationId": "deleteEmailDomain", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "examples": { + "Email domain in use": { + "$ref": "#/components/examples/ErrorEmailDomainInUse" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Unable to delete custom email domain due to mail provider specific restrictions" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailDomains.manage" + ] + } + ], + "summary": "Delete an email domain", + "tags": [ + "EmailDomain" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an Email Domain by `emailDomainId`", + "operationId": "getEmailDomain", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Retrieve email domain response": { + "$ref": "#/components/examples/EmailDomainResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailDomainResponseWithEmbedded" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailDomains.read" + ] + } + ], + "summary": "Retrieve an email domain", + "tags": [ + "EmailDomain" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathEmailDomainId" + }, + { + "$ref": "#/components/parameters/queryExpandEmailDomain" + } + ], + "put": { + "description": "Replaces associated username and sender display name by `emailDomainId`", + "operationId": "replaceEmailDomain", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Update email domain request": { + "$ref": "#/components/examples/UpdateEmailDomainRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UpdateEmailDomain" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Update email domain response": { + "$ref": "#/components/examples/UpdatedEmailDomainResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailDomainResponse" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailDomains.manage" + ] + } + ], + "summary": "Replace an email domain", + "tags": [ + "EmailDomain" + ], + "x-codegen-request-body-name": "updateEmailDomain", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/email-domains/{emailDomainId}/verify": { + "parameters": [ + { + "$ref": "#/components/parameters/pathEmailDomainId" + } + ], + "post": { + "description": "Verifies an Email Domain by `emailDomainId`", + "operationId": "verifyEmailDomain", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Verified email domain response": { + "$ref": "#/components/examples/VerifiedEmailDomainResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailDomainResponse" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "examples": { + "Email domain could not be verified": { + "$ref": "#/components/examples/ErrorEmailDomainNotVerified" + }, + "Email domain invalid status": { + "$ref": "#/components/examples/ErrorEmailDomainInvalidStatus" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Email domain could not be verified by mail provider" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailDomains.manage" + ] + } + ], + "summary": "Verify an email domain", + "tags": [ + "EmailDomain" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/email-servers": { + "get": { + "description": "Lists all the enrolled custom SMTP server configurations", + "operationId": "listEmailServers", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "BasicSMTP": { + "$ref": "#/components/examples/ListBasicSMTPServer" + }, + "OAuthClientCredentials": { + "$ref": "#/components/examples/ListOAuthClientCredentialsServer" + }, + "OAuthJWT": { + "$ref": "#/components/examples/ListOAuthJWTServer" + } + }, + "schema": { + "$ref": "#/components/schemas/EmailServerListResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailServers.read" + ] + } + ], + "summary": "List all enrolled SMTP servers", + "tags": [ + "EmailServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a custom email SMTP server configuration for your org.\n\nFor more information about configuring the OAuth 2.0 authentication methods, see [Custom email providers with OAuth 2.0](https://developer.okta.com/docs/guides/custom-smtp/main/).", + "operationId": "createEmailServer", + "requestBody": { + "content": { + "application/json": { + "examples": { + "BasicSMTP": { + "$ref": "#/components/examples/BasicSMTPRequest" + }, + "OAuthClientCredentials": { + "$ref": "#/components/examples/OAuthClientCredentialsRequest" + }, + "OAuthJWT": { + "$ref": "#/components/examples/OAuthJWTRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/BaseEmailServerCreate" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "BasicSMTP": { + "$ref": "#/components/examples/BasicSMTPResponse" + }, + "OAuthClientCredentials": { + "$ref": "#/components/examples/OAuthClientCredentialsResponse" + }, + "OAuthJWT": { + "$ref": "#/components/examples/OAuthJWTResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/BaseEmailServer" + } + } + }, + "description": "Successfully enrolled server credentials" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailServers.manage" + ] + } + ], + "summary": "Create a custom SMTP server", + "tags": [ + "EmailServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/email-servers/{emailServerId}": { + "delete": { + "description": "Deletes the specified custom SMTP server configuration", + "operationId": "deleteEmailServer", + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailServers.manage" + ] + } + ], + "summary": "Delete an SMTP server configuration", + "tags": [ + "EmailServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves the specified custom SMTP server configuration", + "operationId": "getEmailServer", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OAuthClientCredentialsResponse": { + "$ref": "#/components/examples/OAuthClientCredentialsResponse" + }, + "OAuthJWTResponse": { + "$ref": "#/components/examples/OAuthJWTResponse" + }, + "SMTPServerResponse": { + "$ref": "#/components/examples/BasicSMTPResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/BaseEmailServer" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailServers.read" + ] + } + ], + "summary": "Retrieve an SMTP server configuration", + "tags": [ + "EmailServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathEmailServerId" + } + ], + "patch": { + "description": "Updates the specified custom SMTP server configuration\n\n> **Note:** When you update an SMTP server configuration that uses OAuth 2.0 authentication, the [`authType`](#components/schemas/BaseEmailServer/properties/authType) property is required in the request body.", + "operationId": "updateEmailServer", + "requestBody": { + "content": { + "application/json": { + "examples": { + "BasicSMTP": { + "$ref": "#/components/examples/BasicSMTPPatchRequest" + }, + "OAuthClientCredentials": { + "$ref": "#/components/examples/OAuthClientCredentialsPatchRequest" + }, + "OAuthJWT": { + "$ref": "#/components/examples/OAuthJWTPatchRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/BaseEmailServer" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "BasicSMTP": { + "$ref": "#/components/examples/BasicSMTPPatchResponse" + }, + "OAuthClientCredentials": { + "$ref": "#/components/examples/OAuthClientCredentialsPatchResponse" + }, + "OAuthJWT": { + "$ref": "#/components/examples/OAuthJWTPatchResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/BaseEmailServer" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailServers.manage" + ] + } + ], + "summary": "Update an SMTP server configuration", + "tags": [ + "EmailServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/email-servers/{emailServerId}/test": { + "parameters": [ + { + "$ref": "#/components/parameters/pathEmailServerId" + } + ], + "post": { + "description": "Tests the specified custom SMTP server configuration", + "operationId": "testEmailServer", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EmailTestAddresses" + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.emailServers.manage" + ] + } + ], + "summary": "Test an SMTP server configuration", + "tags": [ + "EmailServer" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/eventHooks": { + "get": { + "description": "Lists all event hooks", + "operationId": "listEventHooks", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "RetrieveAllEventHooks": { + "$ref": "#/components/examples/RetrieveAllEventHooks" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/EventHook" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.eventHooks.read" + ] + } + ], + "summary": "List all event hooks", + "tags": [ + "EventHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new event hook for your organization in `ACTIVE` status. You pass an event hook object in the JSON payload\nof your request. That object represents the set of required information about the event hook you're registering, including:\n * The URI of your external service\n * The [events](https://developer.okta.com/docs/reference/api/event-types/) in Okta you want to subscribe to\n * An optional event hook filter that can reduce the number of event hook calls. This is a self-service Early Access (EA) feature.\n See [Create an event hook filter](https://developer.okta.com/docs/concepts/event-hooks/#create-an-event-hook-filter).\n\n Additionally, you can specify a secret API key for Okta to pass to your external service endpoint for security verification. Note that the API key you set here is unrelated to the Okta API token\nyou must supply when making calls to Okta APIs. Optionally, you can specify extra headers that Okta passes to your external\nservice with each call.\nYour external service must use a valid HTTPS endpoint.", + "operationId": "createEventHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateAnEventHook": { + "$ref": "#/components/examples/CreateAnEventHook" + }, + "CreateAnEventHookWithFilter": { + "$ref": "#/components/examples/CreateAnEventHookWithFilter" + } + }, + "schema": { + "$ref": "#/components/schemas/EventHook" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CreateAnEventHook": { + "$ref": "#/components/examples/RetrieveAnEventHook" + }, + "CreateAnEventHookWithFilter": { + "$ref": "#/components/examples/RetrieveAnEventHookWithFilter" + } + }, + "schema": { + "$ref": "#/components/schemas/EventHook" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.eventHooks.manage" + ] + } + ], + "summary": "Create an event hook", + "tags": [ + "EventHook" + ], + "x-codegen-request-body-name": "eventHook", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/eventHooks/{eventHookId}": { + "delete": { + "description": "Deletes the event hook that matches the provided `id`. After deletion, the event hook is unrecoverable.\nAs a safety precaution, you can only delete event hooks with a status of `INACTIVE`.", + "operationId": "deleteEventHook", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.eventHooks.manage" + ] + } + ], + "summary": "Delete an event hook", + "tags": [ + "EventHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an event hook", + "operationId": "getEventHook", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "RetrieveAnEventHook": { + "$ref": "#/components/examples/RetrieveAnEventHook" + } + }, + "schema": { + "$ref": "#/components/schemas/EventHook" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.eventHooks.read" + ] + } + ], + "summary": "Retrieve an event hook", + "tags": [ + "EventHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathEventHookId" + } + ], + "put": { + "description": "Replaces an event hook. Okta validates the new properties before replacing the existing values.\nSome event hook properties are immutable and can't be updated. Refer to the parameter description in the request body schema.\n\n>**Note:** Updating the `channel` property requires you to verify the hook again.", + "operationId": "replaceEventHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ReplaceAnEventHook": { + "$ref": "#/components/examples/ReplaceAnEventHookWithFilter" + } + }, + "schema": { + "$ref": "#/components/schemas/EventHook" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ReplaceAnEventHook": { + "$ref": "#/components/examples/RetrieveAnEventHookWithFilter" + } + }, + "schema": { + "$ref": "#/components/schemas/EventHook" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.eventHooks.manage" + ] + } + ], + "summary": "Replace an event hook", + "tags": [ + "EventHook" + ], + "x-codegen-request-body-name": "eventHook", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/eventHooks/{eventHookId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathEventHookId" + } + ], + "post": { + "description": "Activates the event hook that matches the provided `id`", + "operationId": "activateEventHook", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ActivateAnEventHook": { + "$ref": "#/components/examples/RetrieveAnEventHook" + } + }, + "schema": { + "$ref": "#/components/schemas/EventHook" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.eventHooks.manage" + ] + } + ], + "summary": "Activate an event hook", + "tags": [ + "EventHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/eventHooks/{eventHookId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathEventHookId" + } + ], + "post": { + "description": "Deactivates the event hook that matches the provided `id`", + "operationId": "deactivateEventHook", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "DeactivateAnEventHook": { + "$ref": "#/components/examples/RetrieveADeactivatedEventHook" + } + }, + "schema": { + "$ref": "#/components/schemas/EventHook" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.eventHooks.manage" + ] + } + ], + "summary": "Deactivate an event hook", + "tags": [ + "EventHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/eventHooks/{eventHookId}/lifecycle/verify": { + "parameters": [ + { + "$ref": "#/components/parameters/pathEventHookId" + } + ], + "post": { + "description": "Verifies that the event hook matches the provided `eventHookId`. To verify ownership, your endpoint must send information back to Okta in JSON format. See [Event hooks](https://developer.okta.com/docs/concepts/event-hooks/#one-time-verification-request).\n\nOnly `ACTIVE` and `VERIFIED` event hooks can receive events from Okta.\n\nIf a response is not received within 3 seconds, the outbound request times out. One retry is attempted after a timeout or error response.\nIf a successful response still isn't received, this operation returns a 400 error with more information about the failure.", + "operationId": "verifyEventHook", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "VerifyAnEventHook": { + "$ref": "#/components/examples/RetrieveAnEventHook" + } + }, + "schema": { + "$ref": "#/components/schemas/EventHook" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.eventHooks.manage" + ] + } + ], + "summary": "Verify an event hook", + "tags": [ + "EventHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/features": { + "get": { + "description": "Lists all self-service features for your org", + "operationId": "listFeatures", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "FeaturesList": { + "$ref": "#/components/examples/ListFeaturesResponse", + "summary": "List all self-service features for your org" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/Feature" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.features.read" + ] + } + ], + "summary": "List all features", + "tags": [ + "Feature" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/features/{featureId}": { + "get": { + "description": "Retrieves a feature by ID", + "operationId": "getFeature", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "FeaturesRetrieve": { + "$ref": "#/components/examples/RetrieveFeaturesResponse", + "summary": "Retrieve a feature by ID" + } + }, + "schema": { + "$ref": "#/components/schemas/Feature" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.features.read" + ] + } + ], + "summary": "Retrieve a feature", + "tags": [ + "Feature" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathFeatureId" + } + ] + }, + "/api/v1/features/{featureId}/dependencies": { + "get": { + "description": "Lists all feature dependencies for a specified feature.\n\nA feature's dependencies are the features that it requires to be enabled in order for itself to be enabled.", + "operationId": "listFeatureDependencies", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "FeaturesDependenciesList": { + "$ref": "#/components/examples/ListFeatureDependenciesResponse", + "summary": "List all dependencies" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/Feature" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.features.read" + ] + } + ], + "summary": "List all dependencies", + "tags": [ + "Feature" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathFeatureId" + } + ] + }, + "/api/v1/features/{featureId}/dependents": { + "get": { + "description": "Lists all feature dependents for the specified feature.\n\nA feature's dependents are the features that need to be disabled in order for the feature itself to be disabled.", + "operationId": "listFeatureDependents", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "FeaturesDependentsList": { + "$ref": "#/components/examples/ListFeatureDependentsResponse", + "summary": "List all feature dependents for the specified feature" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/Feature" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.features.read" + ] + } + ], + "summary": "List all dependents", + "tags": [ + "Feature" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathFeatureId" + } + ] + }, + "/api/v1/features/{featureId}/{lifecycle}": { + "parameters": [ + { + "$ref": "#/components/parameters/pathFeatureId" + }, + { + "$ref": "#/components/parameters/pathLifecycle" + } + ], + "post": { + "description": "Updates a feature's lifecycle status. Use this endpoint to enable or disable a feature for your org.\n\nUse the `mode=force` parameter to override dependency restrictions for a particular feature. Normally, you can't enable a feature if it has one or more dependencies that aren't enabled.\n\nWhen you use the `mode=force` parameter while enabling a feature, Okta first tries to enable any disabled features that this feature may have as dependencies. If you don't pass the `mode=force` parameter and the feature has dependencies that need to be enabled before the feature is enabled, a 400 error is returned.\n\nWhen you use the `mode=force` parameter while disabling a feature, Okta first tries to disable any enabled features that this feature may have as dependents. If you don't pass the `mode=force` parameter and the feature has dependents that need to be disabled before the feature is disabled, a 400 error is returned.\n\nThe following chart shows the different state transitions for a feature.\n\n<img alt=\"Example\" src=\"https://developer.okta.com/docs/api/images/features/update-ssfeat-flowchart.png\" width=\"1000\"/>", + "operationId": "updateFeatureLifecycle", + "parameters": [ + { + "description": "Indicates if you want to force enable or disable a feature. Supported value is `force`.", + "in": "query", + "name": "mode", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "FeaturesUpdate": { + "$ref": "#/components/examples/UpdateFeatureLifecycleResponse", + "summary": "Update the feature lifecycle status" + } + }, + "schema": { + "$ref": "#/components/schemas/Feature" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.features.manage" + ] + } + ], + "summary": "Update a feature lifecycle", + "tags": [ + "Feature" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/first-party-app-settings/{appName}": { + "get": { + "description": "Retrieves the settings for an Okta app (also known as an Okta first-party app)", + "operationId": "getFirstPartyAppSettings", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "exampleSettings": { + "$ref": "#/components/examples/AdminConsoleSettingsExample" + } + }, + "schema": { + "$ref": "#/components/schemas/AdminConsoleSettings" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.read" + ] + } + ], + "summary": "Retrieve the Okta application settings", + "tags": [ + "OktaApplicationSettings" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathFirstPartyAppName" + } + ], + "put": { + "description": "Replaces the settings for an Okta app (also known as an Okta first-party app)", + "operationId": "replaceFirstPartyAppSettings", + "requestBody": { + "content": { + "application/json": { + "examples": { + "exampleSettings": { + "$ref": "#/components/examples/AdminConsoleSettingsExample" + } + }, + "schema": { + "$ref": "#/components/schemas/AdminConsoleSettings" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "exampleSettings": { + "$ref": "#/components/examples/AdminConsoleSettingsExample" + } + }, + "schema": { + "$ref": "#/components/schemas/AdminConsoleSettings" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.apps.manage" + ] + } + ], + "summary": "Replace the Okta application settings", + "tags": [ + "OktaApplicationSettings" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups": { + "get": { + "description": "Lists all groups with pagination support.\n\n> **Note:** To list all groups belonging to a member, use the [List all groups endpoint in the User Resources API](/openapi/okta-management/management/tags/userresources/other/listusergroups).\n\nThe number of groups returned depends on the specified [`limit`](/openapi/okta-management/management/group/listgroups#group/listgroups/t=request&in=query&path=limit), if you have a search, filter, and/or query parameter set, and if that parameter is not null. We recommend using a limit less than or equal to 200.\n\nA subset of groups can be returned that match a supported filter expression, query, or search criteria.\n\n> **Note:** The `search` parameter results are sourced from an eventually consistent datasource and may not reflect the latest information.", + "operationId": "listGroups", + "parameters": [ + { + "description": "Searches for groups with a supported [filtering](https://developer.okta.com/docs/api/#filter) expression for all properties except for `_embedded`, `_links`, and `objectClass`. Okta recommends this query parameter because it provides the largest range of search options and optimal performance.\n\nThis operation supports [pagination](https://developer.okta.com/docs/api/#pagination).\n\nThe `search` string requires [URL encoding](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). For example, `search=type eq \"OKTA_GROUP\"` is encoded as `search=type+eq+%22OKTA_GROUP%22`.\n\nThis operation searches many properties:\n\n* Any group profile attribute, including imported app group profile attributes.\n* The top-level properties: `id`, `created`, `lastMembershipUpdated`, `lastUpdated`, and `type`.\n* The [source](/openapi/okta-management/management/group/listgroups#group/listgroups/t=response&c=200&path=_links/source) of groups with type of `APP_GROUP`, accessed as `source.id`.\n\nYou can also use the `sortBy` and `sortOrder` parameters.\n\nSearches for groups can be filtered by the following operators: `sw`, `eq`, and `co`. You can only use `co` with these select profile attributes: `profile.name` and `profile.description`. See [Operators](https://developer.okta.com/docs/api/#operators).", + "examples": { + "searchById": { + "description": "Search for groups with the specified ID (00gak46y5hydV6NdM0g4)", + "summary": "Search by ID", + "value": "id eq \"00gak46y5hydV6NdM0g4\"" + }, + "searchByIdTypeAndCreationDate": { + "description": "List groups of type APP_GROUP that were created before 01/01/2014 and whose source app has the ID 0oa2v0el0gP90aqjJ0g7", + "summary": "Search with multiple criteria", + "value": "type eq \"APP_GROUP\" and (created lt \"2014-01-01T00:00:00.000Z\" and source.id eq \"0oa2v0el0gP90aqjJ0g7\")" + }, + "searchByLastMembershipUpdatedAfterDate": { + "description": "Search for groups whose memberships were last updated after 01/01/2024", + "summary": "Search by last updated membership timestamp", + "value": "lastMembershipUpdated gt \"2024-01-01T00:00:00.000Z\"" + }, + "searchByProfileName": { + "description": "Search for groups that have a group profile name of West Coast users", + "summary": "Search by name", + "value": "profile.name eq \"West Coast users\"" + }, + "searchBySamAccountName": { + "description": "Search for groups whose samAccountName profile attribute starts with \"West Coast\"", + "summary": "Search using an operator", + "value": "profile.samAccountName sw \"West Coast\"" + }, + "searchBySourceId": { + "description": "Search for groups that have the source app with the specified source ID (0oa2v0el0gP90aqjJ0g7)", + "summary": "Search by source ID", + "value": "source.id eq \"0oa2v0el0gP90aqjJ0g7\"" + }, + "searchByType": { + "description": "Search for groups that have a type of APP_GROUP", + "summary": "Search by type", + "value": "type eq \"APP_GROUP\"" + } + }, + "in": "query", + "name": "search", + "schema": { + "type": "string" + } + }, + { + "description": "Filter expression for groups. See [Filter](https://developer.okta.com/docs/api/#filter).\n\nFiltering supports the following limited number of properties: `id`, `type`, `lastUpdated`, and `lastMembershipUpdated`.\n\n> **Note:** All filters must be [URL encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). For example, `filter=lastUpdated gt \"2013-06-01T00:00:00.000Z\"` is encoded as `filter=lastUpdated%20gt%20%222013-06-01T00:00:00.000Z%22`. See [Special characters](https://developer.okta.com/docs/api/#special-characters).", + "examples": { + "filterById": { + "description": "Filter group with a specific ID (00g1emaKYZTWRYYRRTSK)", + "summary": "Filter by ID", + "value": "id eq \"00g1emaKYZTWRYYRRTSK\"" + }, + "filterByType": { + "description": "Filter groups that are of the type OKTA_GROUP", + "summary": "Filter by type", + "value": "type eq \"OKTA_GROUP\"" + }, + "filterByTypeAndProfileLastUpdatedAfterDate": { + "description": "Filter groups that are OKTA_GROUP type with profile updated after 11/11/2016", + "summary": "Filter by type and last updated date", + "value": "type eq \"OKTA_GROUP\" and lastUpdated gt \"2016-11-11T00:00:00.000Z\"" + }, + "filterByTypeAndProfileOrMembershipUpdatedBeforeDate": { + "description": "Filter groups that are OKTA_GROUP type, with profiles or memberships updated before 11/11/2015", + "summary": "Filter by multiple criteria", + "value": "type eq \"OKTA_GROUP\" and (lastUpdated lt \"2015-11-11T00:00:00.000Z\" or lastMembershipUpdated lt \"2015-11-11T00:00:00.000Z\")" + } + }, + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Finds a group that matches the `name` property.\n> **Note:** Paging and searching are currently mutually exclusive. You can't page a query. The default limit for a query is 300 results. Query is intended for an auto-complete picker use case where users refine their search string to constrain the results.", + "in": "query", + "name": "q", + "schema": { + "example": "West&limit=10", + "type": "string" + } + }, + { + "description": "Specifies the pagination cursor for the next page of groups. The `after` cursor should be treated as an opaque value and obtained through the next link relation. See [Pagination](https://developer.okta.com/docs/api/#pagination).", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of group results in a page.\n\nOkta recommends using a specific value other than the default or maximum. If your request times out, retry your request with a smaller `limit` and [page the results](https://developer.okta.com/docs/api/#pagination).\n\nThe Okta default `Everyone` group isn't returned for users with a group admin role.", + "in": "query", + "name": "limit", + "schema": { + "format": "int32", + "maximum": 10000, + "type": "integer" + } + }, + { + "description": "If specified, additional metadata is included in the response. Possible values are `stats` and `app`. This additional metadata is listed in the [`_embedded`](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/addGroup!c=200&path=_embedded&t=response) property of the response.\n\n> **Note:** You can use the `stats` value to return the number of users within a group. This is listed as the `_embedded.stats.usersCount` value in the response. See this [Knowledge Base article](https://support.okta.com/help/s/article/Is-there-an-API-that-returns-the-number-of-users-in-a-group?language=en_US) for more information and an example.", + "in": "query", + "name": "expand", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the field to sort by (for search queries only). `sortBy` can be any single property, for example `sortBy=profile.name`. Groups with the same value for the `sortBy` property are ordered by `id`'. Use with `sortOrder` to control the order of results.", + "in": "query", + "name": "sortBy", + "schema": { + "example": "lastUpdated", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/querySortOrder" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListGroupsExample": { + "$ref": "#/components/examples/list-groups-examples" + }, + "ListGroupsFilterExample": { + "$ref": "#/components/examples/list-groups-filter" + }, + "ListGroupsSearchExample": { + "$ref": "#/components/examples/list-groups-search" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/Group" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.read" + ] + } + ], + "summary": "List all groups", + "tags": [ + "Group" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Adds a new group with the `OKTA_GROUP` type to your org.\n> **Note:** App import operations are responsible for syncing groups with `APP_GROUP` type such as Active Directory groups. See\n[About groups](https://help.okta.com/okta_help.htm?id=Directory_Groups) in the help documentation.", + "operationId": "addGroup", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "profile": { + "$ref": "#/components/schemas/OktaUserGroupProfile" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GroupExample": { + "$ref": "#/components/examples/group-example" + } + }, + "schema": { + "$ref": "#/components/schemas/Group" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Add a group", + "tags": [ + "Group" + ], + "x-codegen-request-body-name": "group", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/rules": { + "get": { + "description": "Lists all group rules for your org", + "operationId": "listGroupRules", + "parameters": [ + { + "description": "Specifies the number of rule results in a page", + "in": "query", + "name": "limit", + "schema": { + "default": 50, + "format": "int32", + "maximum": 200, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Specifies the pagination cursor for the next page of rules", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the keyword to search rules for", + "in": "query", + "name": "search", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/queryExpandGroupIdToGroupNameMap" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListGroupRulesExample": { + "$ref": "#/components/examples/list-group-rules-example" + }, + "ListGroupRulesExampleWithExpand": { + "$ref": "#/components/examples/list-group-rules-with-expand-parameter" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/GroupRule" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.read" + ] + } + ], + "summary": "List all group rules", + "tags": [ + "GroupRule" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a group rule to dynamically add users to the specified group if they match the condition.\n> **Note:** Group rules are created with the status set to `'INACTIVE'`.", + "operationId": "createGroupRule", + "requestBody": { + "content": { + "application/json": { + "examples": { + "GroupRuleExample": { + "$ref": "#/components/examples/create-group-rule-request-example" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateGroupRuleRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GroupRuleExample": { + "$ref": "#/components/examples/group-rule-example" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupRule" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Create a group rule", + "tags": [ + "GroupRule" + ], + "x-codegen-request-body-name": "groupRule", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/rules/{groupRuleId}": { + "delete": { + "description": "Deletes a specific group rule by `groupRuleId`", + "operationId": "deleteGroupRule", + "parameters": [ + { + "description": "If set to `true`, removes users from groups assigned by this rule", + "in": "query", + "name": "removeUsers", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "202": { + "content": {}, + "description": "Accepted" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Delete a group rule", + "tags": [ + "GroupRule" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a specific group rule by ID from your org", + "operationId": "getGroupRule", + "parameters": [ + { + "$ref": "#/components/parameters/queryExpandGroupIdToGroupNameMap" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GroupRuleExample": { + "$ref": "#/components/examples/group-rule-example" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupRule" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.read" + ] + } + ], + "summary": "Retrieve a group rule", + "tags": [ + "GroupRule" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupRuleId" + } + ], + "put": { + "description": "Replaces a group rule\n> **Notes:** You can only update rules with a group whose status is set to `INACTIVE`.\n>\n> You currently can't update the `actions` section.", + "operationId": "replaceGroupRule", + "requestBody": { + "content": { + "application/json": { + "examples": { + "GroupRuleExample": { + "$ref": "#/components/examples/group-rule-example" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupRule" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupRule" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Replace a group rule", + "tags": [ + "GroupRule" + ], + "x-codegen-request-body-name": "groupRule", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/rules/{groupRuleId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupRuleId" + } + ], + "post": { + "description": "Activates a specific group rule by ID from your org", + "operationId": "activateGroupRule", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Activate a group rule", + "tags": [ + "GroupRule" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/rules/{groupRuleId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupRuleId" + } + ], + "post": { + "description": "Deactivates a specific group rule by ID from your org", + "operationId": "deactivateGroupRule", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Deactivate a group rule", + "tags": [ + "GroupRule" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/{groupId}": { + "delete": { + "description": "Deletes a group of the `OKTA_GROUP` or `APP_GROUP` type from your org.\n> **Note:** You can't remove groups of type `APP_GROUP` if they are used in a group push mapping.", + "operationId": "deleteGroup", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Delete a group", + "tags": [ + "Group" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a specific group by `id` from your org", + "operationId": "getGroup", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GroupExample": { + "$ref": "#/components/examples/group-example" + } + }, + "schema": { + "$ref": "#/components/schemas/Group" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.read" + ] + } + ], + "summary": "Retrieve a group", + "tags": [ + "Group" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + } + ], + "put": { + "description": "Replaces the profile for a group of `OKTA_GROUP` type from your org.\n> **Note :** You only can modify profiles for groups of the `OKTA_GROUP` type.\n>\n> App imports are responsible for updating profiles for groups of the `APP_GROUP` type, such as Active Directory groups.", + "operationId": "replaceGroup", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "profile": { + "$ref": "#/components/schemas/OktaUserGroupProfile" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GroupExample": { + "$ref": "#/components/examples/group-example" + } + }, + "schema": { + "$ref": "#/components/schemas/Group" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Replace a group", + "tags": [ + "Group" + ], + "x-codegen-request-body-name": "group", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/{groupId}/apps": { + "get": { + "description": "Lists all apps that are assigned to a group. See [Application Groups API](/openapi/okta-management/management/tags/applicationgroups/).", + "operationId": "listAssignedApplicationsForGroup", + "parameters": [ + { + "description": "Specifies the pagination cursor for the next page of apps", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of app results for a page", + "in": "query", + "name": "limit", + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAppsExample": { + "$ref": "#/components/examples/list-apps-example" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/Application" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.read" + ] + } + ], + "summary": "List all assigned apps", + "tags": [ + "Group" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + } + ] + }, + "/api/v1/groups/{groupId}/owners": { + "get": { + "description": "Lists all owners for a specific group", + "operationId": "listGroupOwners", + "parameters": [ + { + "description": "SCIM filter expression for group owners. Allows you to filter owners by type.", + "in": "query", + "name": "search", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the pagination cursor for the next page of owners", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of owner results in a page", + "in": "query", + "name": "limit", + "schema": { + "default": 1000, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListsMultipleOwnersOfaGroup": { + "$ref": "#/components/examples/ListsOwnersMultipleResponse" + }, + "ListsOneOwnerOfaGroup": { + "$ref": "#/components/examples/ListsOwnerOneResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/GroupOwner" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.read" + ] + } + ], + "summary": "List all group owners", + "tags": [ + "GroupOwner" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + } + ], + "post": { + "description": "Assigns a group owner", + "operationId": "assignGroupOwner", + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "AssignAGroupOwner": { + "$ref": "#/components/examples/AssignGroupOwnerRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/AssignGroupOwnerRequestBody" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "AssignAGroupOwner": { + "$ref": "#/components/examples/AssignGroupOwnerResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupOwner" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Assign a group owner", + "tags": [ + "GroupOwner" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/{groupId}/owners/{ownerId}": { + "delete": { + "description": "Deletes a group owner from a specific group", + "operationId": "deleteGroupOwner", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Delete a group owner", + "tags": [ + "GroupOwner" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + }, + { + "$ref": "#/components/parameters/pathOwnerId" + } + ] + }, + "/api/v1/groups/{groupId}/roles": { + "get": { + "description": "Lists all assigned roles of a group by `groupId`", + "operationId": "listGroupAssignedRoles", + "parameters": [ + { + "$ref": "#/components/parameters/pathQueryRoleExpand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Custom roles": { + "$ref": "#/components/examples/CustomRolesListResponseGroup" + }, + "IAM-Based standard roles": { + "$ref": "#/components/examples/IAMStandardRolesListResponseGroup" + }, + "Standard roles": { + "$ref": "#/components/examples/StandardRolesListResponseGroup" + } + }, + "schema": { + "description": "List of role assignments", + "items": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/CustomRole", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/CustomRole", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRole", + "APP_ADMIN": "#/components/schemas/StandardRole", + "CUSTOM": "#/components/schemas/CustomRole", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRole", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRole", + "MOBILE_ADMIN": "#/components/schemas/StandardRole", + "ORG_ADMIN": "#/components/schemas/StandardRole", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRole", + "REPORT_ADMIN": "#/components/schemas/StandardRole", + "SUPER_ADMIN": "#/components/schemas/StandardRole", + "USER_ADMIN": "#/components/schemas/StandardRole", + "WORKFLOWS_ADMIN": "#/components/schemas/CustomRole" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRole" + }, + { + "$ref": "#/components/schemas/CustomRole" + } + ] + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all group role assignments", + "tags": [ + "RoleAssignmentBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + } + ], + "post": { + "description": "Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a group.\n\nYou can also assign a custom role to a group, but the preferred method to assign a custom role to a group is to create a binding between the custom role, the resource set, and the group. See [Create a role resource set binding](/openapi/okta-management/management/roledresourcesetbinding/createresourcesetbinding).\n\n> **Notes:**\n> * The request payload is different for standard and custom role assignments.\n> * For IAM-based standard role assignments, use the request payload for standard roles. However, the response payload for IAM-based role assignments is similar to the custom role's assignment response.", + "operationId": "assignRoleToGroup", + "parameters": [ + { + "description": "Grants the group third-party admin status when set to `true`", + "in": "query", + "name": "disableNotifications", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "APP_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "CUSTOM": "#/components/schemas/CustomRoleAssignmentSchema", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "ORG_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "REPORT_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "SUPER_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "USER_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "WORKFLOWS_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRoleAssignmentSchema" + }, + { + "$ref": "#/components/schemas/CustomRoleAssignmentSchema" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Custom roles": { + "$ref": "#/components/examples/CreateCustomRoleResponseGroup" + }, + "IAM-based standard roles": { + "$ref": "#/components/examples/CreateIAMStandardRoleResponseGroup" + }, + "Standard roles": { + "$ref": "#/components/examples/CreateStandardRoleAssignmentResponseGroup" + } + }, + "schema": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/CustomRole", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/CustomRole", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRole", + "APP_ADMIN": "#/components/schemas/StandardRole", + "CUSTOM": "#/components/schemas/CustomRole", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRole", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRole", + "ORG_ADMIN": "#/components/schemas/StandardRole", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRole", + "REPORT_ADMIN": "#/components/schemas/StandardRole", + "SUPER_ADMIN": "#/components/schemas/StandardRole", + "USER_ADMIN": "#/components/schemas/StandardRole", + "WORKFLOWS_ADMIN": "#/components/schemas/CustomRole" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRole" + }, + { + "$ref": "#/components/schemas/CustomRole" + } + ] + } + } + }, + "description": "Success" + }, + "201": { + "content": {}, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign a role to a group", + "tags": [ + "RoleAssignmentBGroup" + ], + "x-codegen-request-body-name": "assignRoleRequest", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/{groupId}/roles/{roleAssignmentId}": { + "delete": { + "description": "Unassigns a role assignment (identified by `roleAssignmentId`) from a group (identified by the `groupId`)", + "operationId": "unassignRoleFromGroup", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign a group role", + "tags": [ + "RoleAssignmentBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a role assigned to a group (identified by the `groupId`). The `roleAssignmentId` is the unique identifier for either a standard role group assignment object or a custom role resource set binding object.", + "operationId": "getGroupAssignedRole", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Custom roles": { + "$ref": "#/components/examples/CreateCustomRoleResponseGroup" + }, + "IAM-based standard roles": { + "$ref": "#/components/examples/CreateIAMStandardRoleResponseGroup" + }, + "Standard roles": { + "$ref": "#/components/examples/CreateStandardRoleAssignmentResponseGroup" + } + }, + "schema": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/CustomRole", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/CustomRole", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRole", + "APP_ADMIN": "#/components/schemas/StandardRole", + "CUSTOM": "#/components/schemas/CustomRole", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRole", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRole", + "ORG_ADMIN": "#/components/schemas/StandardRole", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRole", + "REPORT_ADMIN": "#/components/schemas/StandardRole", + "SUPER_ADMIN": "#/components/schemas/StandardRole", + "USER_ADMIN": "#/components/schemas/StandardRole", + "WORKFLOWS_ADMIN": "#/components/schemas/CustomRole" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRole" + }, + { + "$ref": "#/components/schemas/CustomRole" + } + ] + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a group role assignment", + "tags": [ + "RoleAssignmentBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + } + ] + }, + "/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps": { + "get": { + "description": "Lists all app targets for an `APP_ADMIN` role assignment to a group. The response includes a list of OIN-cataloged apps or app instances. The response payload for an app instance contains the `id` property, but an OIN-cataloged app doesn't.", + "operationId": "listApplicationTargetsForApplicationAdministratorRoleForGroup", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/CatalogApplication" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all group role app targets", + "tags": [ + "RoleBTargetBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + } + ] + }, + "/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}": { + "delete": { + "description": "Unassigns an OIN app target from an `APP_ADMIN` role assignment to a group\n\n> **Note:** You can't remove the last app target from a role assignment.\n> If you need a role assignment that applies to all apps, delete the `APP_ADMIN` role assignment with the target and create another one. See [Unassign a group role](/openapi/okta-management/management/roleassignmentbgroup/unassignrolefromgroup).\n", + "operationId": "unassignAppTargetToAdminRoleForGroup", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign a group role app target", + "tags": [ + "RoleBTargetBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathAppName" + } + ], + "put": { + "description": "Assigns an OIN app target to an `APP_ADMIN` role assignment to a group. When you assign the first OIN app target, you reduce the scope of the role assignment. The role no longer applies to all app targets, but applies only to the specified target. An OIN app target that's assigned to the role overrides any existing instance targets of the OIN app. For example, if a user is assigned to administer a specific Facebook instance, a successful request to add an OIN app with `facebook` for `appName` makes that user the administrator for all Facebook instances.", + "operationId": "assignAppTargetToAdminRoleForGroup", + "responses": { + "200": { + "content": {}, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign a group role app target", + "tags": [ + "RoleBTargetBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}": { + "delete": { + "description": "Unassigns an app instance target from an `APP_ADMIN` role assignment to a group\n\n> **Note:** You can't remove the last app instance target from a role assignment.\n> If you need a role assignment that applies to all apps, delete the `APP_ADMIN` role assignment with the target and create another one. See [Unassign a group role](/openapi/okta-management/management/roleassignmentbgroup/unassignrolefromgroup).", + "operationId": "unassignAppInstanceTargetToAppAdminRoleForGroup", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign a group role app instance target", + "tags": [ + "RoleBTargetBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathAppName" + }, + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "put": { + "description": "Assigns an app instance target to an `APP_ADMIN` role assignment to a group. When you assign the first OIN app or app instance target, you reduce the scope of the role assignment.\nThe role no longer applies to all app targets, but applies only to the specified target.\n\n> **Note:** You can target a mixture of both OIN app and app instance targets, but you can't assign permissions to manage all instances of an OIN app and then assign a subset of permissions to the same app.\n> For example, you can't specify that an admin has access to manage all instances of the Salesforce app and then also manage specific configurations of the Salesforce app.", + "operationId": "assignAppInstanceTargetToAppAdminRoleForGroup", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign a group role app instance target", + "tags": [ + "RoleBTargetBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups": { + "get": { + "description": "Lists all group targets for a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a group.\nIf the role isn't scoped to specific group targets, Okta returns an empty array `[]`.", + "operationId": "listGroupTargetsForGroupRole", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Group" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all group role group targets", + "tags": [ + "RoleBTargetBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + } + ] + }, + "/api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups/{targetGroupId}": { + "delete": { + "description": "Unassigns a group target from a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a group.", + "operationId": "unassignGroupTargetFromGroupAdminRole", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign a group role group target", + "tags": [ + "RoleBTargetBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathTargetGroupId" + } + ], + "put": { + "description": "Assigns a group target to a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a group.\nWhen you assign the first group target, you reduce the scope of the role assignment. The role no longer applies to all targets but applies only to the specified target.", + "operationId": "assignGroupTargetToGroupAdminRole", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign a group role group target", + "tags": [ + "RoleBTargetBGroup" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/{groupId}/users": { + "get": { + "description": "Lists all users that are a member of a group.\nThe default user limit is set to a very high number due to historical reasons that are no longer valid for most orgs. This will change in a future version of this API. The recommended page limit is now `limit=200`.", + "operationId": "listGroupUsers", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "description": "Specifies the number of user results in a page", + "in": "query", + "name": "limit", + "schema": { + "default": 1000, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListMemberUserResponse": { + "$ref": "#/components/examples/ListUsersResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/User" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.read" + ] + } + ], + "summary": "List all member users", + "tags": [ + "Group" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + } + ] + }, + "/api/v1/groups/{groupId}/users/{userId}": { + "delete": { + "description": "Unassigns a user from a group with the `OKTA_GROUP` type.\n> **Note:** You only can modify memberships for groups of the `OKTA_GROUP` type.\n>\n> App imports are responsible for managing group memberships for groups of the `APP_GROUP` type, such as Active Directory groups.", + "operationId": "unassignUserFromGroup", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Unassign a user from a group", + "tags": [ + "Group" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + }, + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "put": { + "description": "Assigns a user to a group with the `OKTA_GROUP` type.\n> **Note:** You only can modify memberships for groups of the `OKTA_GROUP` type. App imports are responsible for managing group memberships for groups of the `APP_GROUP` type, such as Active Directory groups.", + "operationId": "assignUserToGroup", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.groups.manage" + ] + } + ], + "summary": "Assign a user to a group", + "tags": [ + "Group" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/groups/{groupId}/users/{userId}/group-rules": { + "parameters": [ + { + "$ref": "#/components/parameters/pathGroupId" + }, + { + "$ref": "#/components/parameters/pathUserId" + } + ] + }, + "/api/v1/hook-keys": { + "get": { + "description": "Lists all keys", + "operationId": "listHookKeys", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ResponseExample": { + "$ref": "#/components/examples/ListAllKeysResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/HookKey" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.read" + ] + } + ], + "summary": "List all keys", + "tags": [ + "HookKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a key for use with other parts of the application, such as inline hooks\n\n> **Note:** Use the key name to access this key for inline hook operations.\n\nThe total number of keys that you can create in an Okta org is limited to 50.\n\n The response is a [Key object](https://developer.okta.com/docs/reference/api/hook-keys/#key-object) that represents the\n key that you create. The `id` property in the response serves as the unique ID for the key, which you can specify when\n invoking other CRUD operations. The `keyId` provided in the response is the alias of the public key that you can use to get\n details of the public key data in a separate call.\n\n> **Note:** The keyId is the alias of the public key that you can use to retrieve the public key.", + "operationId": "createHookKey", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KeyRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ResponseExample": { + "$ref": "#/components/examples/CreateHookKeyResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DetailedHookKeyInstance" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.manage" + ] + } + ], + "summary": "Create a key", + "tags": [ + "HookKey" + ], + "x-codegen-request-body-name": "keyRequest", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/hook-keys/public/{keyId}": { + "get": { + "description": "Retrieves a public key by `keyId`\n\n>**Note:** keyId is the alias of the public key.", + "operationId": "getPublicKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ResponseExample": { + "$ref": "#/components/examples/RetrievePublicKeyResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/_embedded" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.read" + ] + } + ], + "summary": "Retrieve a public key", + "tags": [ + "HookKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPublicKeyId" + } + ] + }, + "/api/v1/hook-keys/{id}": { + "delete": { + "description": "Deletes a key by `id`. After being deleted, the key is unrecoverable.\n\nAs a safety precaution, only keys that aren't being used are eligible for deletion.\n", + "operationId": "deleteHookKey", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.manage" + ] + } + ], + "summary": "Delete a key", + "tags": [ + "HookKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves the public portion of the Key object using the `id` parameter\n\n>**Note:** The `?expand=publickey` query parameter optionally returns the full object including the details of the public key in the response body's `_embedded` property.", + "operationId": "getHookKey", + "parameters": [ + { + "description": "A valid key ID", + "in": "path", + "name": "id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ResponseExample": { + "$ref": "#/components/examples/RetrieveKeyResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/HookKey" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.read" + ] + } + ], + "summary": "Retrieve a key by ID", + "tags": [ + "HookKey" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathHookKeyId" + } + ], + "put": { + "description": "Replaces a key by `id`\n\nThis request replaces existing properties after passing validation.\n\n> **Note:** The only parameter that you can update is the name of the key, which must be unique at all times.", + "operationId": "replaceHookKey", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KeyRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ResponseExample": { + "$ref": "#/components/examples/ReplaceKeyResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/DetailedHookKeyInstance" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.manage" + ] + } + ], + "summary": "Replace a key", + "tags": [ + "HookKey" + ], + "x-codegen-request-body-name": "keyRequest", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/assignees/users": { + "get": { + "description": "Lists all users with role assignments", + "operationId": "listUsersWithRoleAssignments", + "parameters": [ + { + "description": "Specifies the pagination cursor for the next page of targets", + "in": "query", + "name": "after", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of results returned. Defaults to `100`.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 100, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "User List": { + "$ref": "#/components/examples/RoleAssignedUsersResponseExample" + } + }, + "schema": { + "$ref": "#/components/schemas/RoleAssignedUsers" + } + } + }, + "description": "Success" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all users with role assignments", + "tags": [ + "RoleAssignmentAUser" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/governance/bundles": { + "get": { + "description": "Lists all governance bundles for the Admin Console in your org", + "operationId": "listGovernanceBundles", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GovernanceBundlesResponse": { + "$ref": "#/components/examples/GovernanceBundlesResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/GovernanceBundlesResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all governance bundles", + "tags": [ + "GovernanceBundle" + ] + }, + "post": { + "description": "Creates a governance bundle of entitlements for the Admin Console", + "operationId": "createGovernanceBundle", + "requestBody": { + "content": { + "application/json": { + "examples": { + "GovernanceBundleCreateRequestCustomRole": { + "$ref": "#/components/examples/GovernanceBundleCreateRequestCustomRole" + }, + "GovernanceBundleCreateRequestScopedStandardRole": { + "$ref": "#/components/examples/GovernanceBundleCreateRequestScopedStandardRole" + }, + "GovernanceBundleCreateRequestStandardRole": { + "$ref": "#/components/examples/GovernanceBundleCreateRequestStandardRole" + } + }, + "schema": { + "$ref": "#/components/schemas/GovernanceBundleCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GovernanceBundleCreateRequestStandardRole": { + "$ref": "#/components/examples/GovernanceBundle" + } + }, + "schema": { + "$ref": "#/components/schemas/GovernanceBundle" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Create a governance bundle", + "tags": [ + "GovernanceBundle" + ] + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "/api/v1/iam/governance/bundles/{bundleId}": { + "delete": { + "description": "Deletes an Admin Console governance bundle", + "operationId": "deleteGovernanceBundle", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Delete a governance bundle", + "tags": [ + "GovernanceBundle" + ] + }, + "get": { + "description": "Retrieves a governance bundle for the Admin Console", + "operationId": "getGovernanceBundle", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GovernanceBundle": { + "$ref": "#/components/examples/GovernanceBundle" + } + }, + "schema": { + "$ref": "#/components/schemas/GovernanceBundle" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a governance bundle", + "tags": [ + "GovernanceBundle" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBundleId" + } + ], + "put": { + "description": "Replaces the properties of a governance bundle for the Admin Console", + "operationId": "replaceGovernanceBundle", + "requestBody": { + "content": { + "application/json": { + "examples": { + "GovernanceBundleUpdateRequestCustomRole": { + "$ref": "#/components/examples/GovernanceBundleUpdateRequestCustomRole" + }, + "GovernanceBundleUpdateRequestScopedStandardRole": { + "$ref": "#/components/examples/GovernanceBundleUpdateRequestScopedStandardRole" + }, + "GovernanceBundleUpdateRequestStandardRole": { + "$ref": "#/components/examples/GovernanceBundleUpdateRequestStandardRole" + } + }, + "schema": { + "$ref": "#/components/schemas/GovernanceBundleUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GovernanceBundle": { + "$ref": "#/components/examples/GovernanceBundle" + } + }, + "schema": { + "$ref": "#/components/schemas/GovernanceBundle" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Replace a governance bundle", + "tags": [ + "GovernanceBundle" + ] + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "/api/v1/iam/governance/bundles/{bundleId}/entitlements": { + "get": { + "description": "Lists all entitlements specific to a governance bundle", + "operationId": "listBundleEntitlements", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "BundleEntitlementsResponse": { + "$ref": "#/components/examples/BundleEntitlementsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/BundleEntitlementsResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all entitlements for a governance bundle", + "tags": [ + "GovernanceBundle" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBundleId" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "/api/v1/iam/governance/bundles/{bundleId}/entitlements/{entitlementId}/values": { + "get": { + "description": "Lists all entitlement values that are specific to a governance bundle entitlement", + "operationId": "listBundleEntitlementValues", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "EntitlementValuesResponse": { + "$ref": "#/components/examples/EntitlementValuesResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/EntitlementValuesResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all values for a governance bundle entitlement", + "tags": [ + "GovernanceBundle" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathBundleId" + }, + { + "$ref": "#/components/parameters/pathEntitlementId" + } + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "/api/v1/iam/governance/optIn": { + "get": { + "description": "Retrieves the entitlement management opt-in status for the Admin Console", + "operationId": "getOptInStatus", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OptInStatusResponse": { + "$ref": "#/components/examples/OptInStatusResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OptInStatusResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve the Admin Console opt-in status", + "tags": [ + "GovernanceBundle" + ] + }, + "post": { + "description": "Opts in the Admin Console to entitlement management", + "operationId": "optIn", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OptInStatusResponse": { + "$ref": "#/components/examples/OptInStatusResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OptInStatusResponse" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Opt in the Admin Console to entitlement management", + "tags": [ + "GovernanceBundle" + ] + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "/api/v1/iam/governance/optOut": { + "post": { + "description": "Opts out the Admin Console from entitlement management", + "operationId": "optOut", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OptOutStatusResponse": { + "$ref": "#/components/examples/OptOutStatusResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OptInStatusResponse" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Opt out the Admin Console from entitlement management", + "tags": [ + "GovernanceBundle" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/resource-sets": { + "get": { + "description": "Lists all resource sets with pagination support", + "operationId": "listResourceSets", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSets" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all resource sets", + "tags": [ + "RoleCResourceSet" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new resource set. See [Supported resources](/openapi/okta-management/guides/roles/#supported-resources).\n\n> **Note:** The maximum number of `resources` allowed in a resource set object is 1000. Resources are identified by either an Okta Resource Name (ORN) or by a REST URL format. See [Okta Resource Name](/openapi/okta-management/guides/roles/#okta-resource-name-orn).", + "operationId": "createResourceSet", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Example Request": { + "$ref": "#/components/examples/ResourceSetRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateResourceSetRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSet" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Create a resource set", + "tags": [ + "RoleCResourceSet" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/resource-sets/{resourceSetIdOrLabel}": { + "delete": { + "description": "Deletes a resource set by `resourceSetIdOrLabel`", + "operationId": "deleteResourceSet", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden", + "headers": {} + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Delete a resource set", + "tags": [ + "RoleCResourceSet" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a resource set by `resourceSetIdOrLabel`", + "operationId": "getResourceSet", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSet" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a resource set", + "tags": [ + "RoleCResourceSet" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathResourceSetIdOrLabel" + } + ], + "put": { + "description": "Replaces the label and description of a resource set. See [Supported resources](/openapi/okta-management/guides/roles/#supported-resources).", + "operationId": "replaceResourceSet", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Example Request": { + "$ref": "#/components/examples/ReplaceResourceSetRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSet" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Replace a resource set", + "tags": [ + "RoleCResourceSet" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings": { + "get": { + "description": "Lists all bindings for a resource set with pagination support.\n\nThe returned `roles` array contains the roles for each binding associated with the specified resource set. If there are more than 100 bindings for the specified resource set, `links.next` provides the resource with pagination for the next list of bindings.", + "operationId": "listBindings", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetBindingsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetBindings" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all role resource set bindings", + "tags": [ + "RoleDResourceSetBinding" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathResourceSetIdOrLabel" + } + ], + "post": { + "description": "Creates a binding for the resource set, custom role, and members (users or groups)\n\n> **Note:** If you use a custom role with permissions that don't apply to the resources in the resource set, it doesn't affect the admin role. For example,\n the `okta.users.userprofile.manage` permission gives the admin no privileges if it's granted to a resource set that only includes `https://{yourOktaDomain}/api/v1/groups/{targetGroupId}`\n resources. If you want the admin to be able to manage the users within the group, the resource set must include the corresponding `https://{yourOktaDomain}/api/v1/groups/{targetGroupId}/users` resource.", + "operationId": "createResourceSetBinding", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Example Request": { + "$ref": "#/components/examples/ResourceSetBindingCreateRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetBindingCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetBindingResponseExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetBindingEditResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Create a role resource set binding", + "tags": [ + "RoleDResourceSetBinding" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}": { + "delete": { + "description": "Deletes a binding of a role (identified by `roleIdOrLabel`) and a resource set (identified by `resourceSetIdOrLabel`)", + "operationId": "deleteBinding", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden", + "headers": {} + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Delete a role resource set binding", + "tags": [ + "RoleDResourceSetBinding" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves the binding of a role (identified by `roleIdOrLabel`) for a resource set (identified by `resourceSetIdOrLabel`)", + "operationId": "getBinding", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetBindingResponseWithIdExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetBindingResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a role resource set binding", + "tags": [ + "RoleDResourceSetBinding" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathResourceSetIdOrLabel" + }, + { + "$ref": "#/components/parameters/pathRoleIdOrLabel" + } + ] + }, + "/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members": { + "get": { + "description": "Lists all members of a role resource set binding with pagination support", + "operationId": "listMembersOfBinding", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetBindingMembersResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetBindingMembers" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all role resource set binding members", + "tags": [ + "RoleDResourceSetBindingMember" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathResourceSetIdOrLabel" + }, + { + "$ref": "#/components/parameters/pathRoleIdOrLabel" + } + ], + "patch": { + "description": "Adds more members to a role resource set binding", + "operationId": "addMembersToBinding", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Example Request": { + "$ref": "#/components/examples/ResourceSetBindingAddMembersRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetBindingAddMembersRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetBindingResponseExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetBindingEditResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Add more role resource set binding members", + "tags": [ + "RoleDResourceSetBindingMember" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members/{memberId}": { + "delete": { + "description": "Unassigns a member (identified by `memberId`) from a role resource set binding", + "operationId": "unassignMemberFromBinding", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden", + "headers": {} + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign a role resource set binding member", + "tags": [ + "RoleDResourceSetBindingMember" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a member (identified by `memberId`) that belongs to a role resource set binding", + "operationId": "getMemberOfBinding", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetBindingMemberResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetBindingMember" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a role resource set binding member", + "tags": [ + "RoleDResourceSetBindingMember" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathResourceSetIdOrLabel" + }, + { + "$ref": "#/components/parameters/pathRoleIdOrLabel" + }, + { + "$ref": "#/components/parameters/pathMemberId" + } + ] + }, + "/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources": { + "get": { + "description": "Lists all resources for the resource set", + "operationId": "listResourceSetResources", + "parameters": [ + { + "description": "Specifies the pagination cursor for the next page of targets", + "in": "query", + "name": "after", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of results returned. Defaults to `100`.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 100, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetResourcesResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetResources" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all resource set resources", + "tags": [ + "RoleCResourceSetResource" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathResourceSetIdOrLabel" + } + ], + "patch": { + "description": "Adds more resources to a resource set", + "operationId": "addResourceSetResources", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Example Request": { + "$ref": "#/components/examples/ResourceSetResourcePatchRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetResourcePatchRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSet" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Add more resources to a resource set", + "tags": [ + "RoleCResourceSetResource" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Adds a resource with conditions for a resource set", + "operationId": "addResourceSetResource", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ConditionExample": { + "$ref": "#/components/examples/ResourceSetResourcePostRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetResourcePostRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ConditionExample": { + "$ref": "#/components/examples/ResourceSetResourceResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetResource" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Add a resource set resource with conditions", + "tags": [ + "RoleCResourceSetResource" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}": { + "delete": { + "description": "Deletes a resource (identified by `resourceId`) from a resource set", + "operationId": "deleteResourceSetResource", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden", + "headers": {} + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Delete a resource set resource", + "tags": [ + "RoleCResourceSetResource" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a resource identified by `resourceId` in a resource set", + "operationId": "getResourceSetResource", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetResourceResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetResource" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a resource set resource", + "tags": [ + "RoleCResourceSetResource" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathResourceSetIdOrLabel" + }, + { + "$ref": "#/components/parameters/pathResourceId" + } + ], + "put": { + "description": "Replaces the conditions of a resource identified by `resourceId` in a resource set", + "operationId": "replaceResourceSetResource", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Example Request": { + "$ref": "#/components/examples/ResourceSetResourcePutRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetResourcePutRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/ResourceSetResourceResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResourceSetResource" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Replace the resource set resource conditions", + "tags": [ + "RoleCResourceSetResource" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/roles": { + "get": { + "description": "Lists all custom roles with pagination support", + "operationId": "listRoles", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/RolesResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IamRoles" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all custom roles", + "tags": [ + "RoleECustom" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a custom role", + "operationId": "createRole", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Example Request": { + "$ref": "#/components/examples/RoleRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateIamRoleRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/RoleResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IamRole" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Create a custom role", + "tags": [ + "RoleECustom" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/roles/{roleIdOrLabel}": { + "delete": { + "description": "Deletes a custom role by `roleIdOrLabel`", + "operationId": "deleteRole", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden", + "headers": {} + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Delete a custom role", + "tags": [ + "RoleECustom" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a role by `roleIdOrLabel`", + "operationId": "getRole", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/RoleResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IamRole" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a role", + "tags": [ + "RoleECustom" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathRoleIdOrLabel" + } + ], + "put": { + "description": "Replaces the label and description for a custom role by `roleIdOrLabel`", + "operationId": "replaceRole", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Example Request": { + "$ref": "#/components/examples/ReplaceRoleRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UpdateIamRoleRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/RoleResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IamRole" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Replace a custom role", + "tags": [ + "RoleECustom" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/iam/roles/{roleIdOrLabel}/permissions": { + "get": { + "description": "Lists all permissions for a custom role by `roleIdOrLabel`", + "operationId": "listRolePermissions", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/PermissionsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Permissions" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all custom role permissions", + "tags": [ + "RoleECustomPermission" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathRoleIdOrLabel" + } + ] + }, + "/api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}": { + "delete": { + "description": "Deletes a permission (identified by `permissionType`) from a custom role", + "operationId": "deleteRolePermission", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden", + "headers": {} + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Delete a custom role permission", + "tags": [ + "RoleECustomPermission" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a permission (identified by `permissionType`) for a custom role", + "operationId": "getRolePermission", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response with conditions": { + "$ref": "#/components/examples/PermissionResponseWithConditions" + }, + "Example Response without conditions": { + "$ref": "#/components/examples/PermissionResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Permission" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a custom role permission", + "tags": [ + "RoleECustomPermission" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathRoleIdOrLabel" + }, + { + "$ref": "#/components/parameters/pathPermissionType" + } + ], + "post": { + "description": "Creates a permission (specified by `permissionType`) for a custom role", + "operationId": "createRolePermission", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Example Request with exclude": { + "$ref": "#/components/examples/CreateUpdateIamRolePermissionRequestExampleWithExclude" + }, + "Example Request with include": { + "$ref": "#/components/examples/CreateUpdateIamRolePermissionRequestExampleWithInclude" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateUpdateIamRolePermissionRequest" + } + } + }, + "required": false, + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Create a custom role permission", + "tags": [ + "RoleECustomPermission" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces a permission (specified by `permissionType`) for a custom role", + "operationId": "replaceRolePermission", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Example Request with exclude": { + "$ref": "#/components/examples/CreateUpdateIamRolePermissionRequestExampleWithExclude" + }, + "Example Request with include": { + "$ref": "#/components/examples/CreateUpdateIamRolePermissionRequestExampleWithInclude" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateUpdateIamRolePermissionRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/PermissionResponseWithConditions" + } + }, + "schema": { + "$ref": "#/components/schemas/Permission" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Replace a custom role permission", + "tags": [ + "RoleECustomPermission" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/groups": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + } + ], + "post": { + "description": "Creates a group in an identity source for the given identity source instance", + "operationId": "createIdentitySourceGroups", + "requestBody": { + "content": { + "application/json": { + "examples": { + "createGroupsPayload": { + "$ref": "#/components/examples/GroupsPayload" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupsRequestSchema" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "group": { + "$ref": "#/components/examples/GroupsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupsResponseSchema" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Create an identity source group", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}": { + "delete": { + "description": "Deletes a group in an identity source for a given identity source ID and group ID", + "operationId": "deleteIdentitySourceGroup", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Delete an identity source group", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a group from an identity source for a given identity source ID and group ID or external ID", + "operationId": "getIdentitySourceGroup", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "group": { + "$ref": "#/components/examples/GroupsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupsResponseSchema" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.read" + ] + } + ], + "summary": "Retrieve an identity source group", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceGroupOrExternalId" + } + ], + "post": { + "description": "Updates a group to an identity source for the given identity source instance and group ID", + "operationId": "updateIdentitySourceGroups", + "requestBody": { + "content": { + "application/json": { + "examples": { + "createGroupsPayload": { + "$ref": "#/components/examples/GroupsPayload" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupsRequestSchema" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "group": { + "$ref": "#/components/examples/GroupsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupsResponseSchema" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Update an identity source group", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership": { + "get": { + "description": "Retrieves the group memberships for the given identity source group in the given identity source instance", + "operationId": "getIdentitySourceGroupMemberships", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "description": "Specifies the number of group membership results in a page. Okta recommends using a specific value other than the default or maximum.\nIf your request times out, retry your request with a smaller `limit` and [page the results](https://developer.okta.com/docs/api/#pagination).", + "in": "query", + "name": "limit", + "schema": { + "format": "int32", + "maximum": 1000, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "groupMembershipsResponse": { + "$ref": "#/components/examples/GroupMemberships" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupMembershipsResponseSchema" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.read" + ] + } + ], + "summary": "Retrieve the memberships for the given identity source group", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceGroupOrExternalId" + } + ], + "post": { + "description": "Creates the group memberships for the given identity source group", + "operationId": "createIdentitySourceGroupsMemberships", + "requestBody": { + "content": { + "application/json": { + "examples": { + "createGroupsPayload": { + "$ref": "#/components/examples/MembershipPayload" + } + }, + "schema": { + "$ref": "#/components/schemas/MembershipRequestSchema" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Create the memberships for the given identity source group", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership/{memberExternalId}": { + "delete": { + "description": "Deletes group memberships for the specified identity source group using member external IDs", + "operationId": "deleteIdentitySourceGroupMemberships", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Delete the memberships for the specified identity source group", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceGroupOrExternalId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceMemberExternalId" + } + ] + }, + "/api/v1/identity-sources/{identitySourceId}/sessions": { + "get": { + "description": "Lists all identity source sessions for the given identity source instance", + "operationId": "listIdentitySourceSessions", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "sessionsList": { + "$ref": "#/components/examples/ListSessionsResponseForGetSessions" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/IdentitySourceSession" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.read" + ] + } + ], + "summary": "List all identity source sessions", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + } + ], + "post": { + "description": "Creates an identity source session for the given identity source instance", + "operationId": "createIdentitySourceSession", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "session": { + "$ref": "#/components/examples/GetSessionResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentitySourceSession" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Create an identity source session", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}": { + "delete": { + "description": "Deletes an identity source session for a given identity source ID and session Id", + "operationId": "deleteIdentitySourceSession", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Delete an identity source session", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an identity source session for a given identity source ID and session ID", + "operationId": "getIdentitySourceSession", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "session": { + "$ref": "#/components/examples/GetSessionResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentitySourceSession" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.read" + ] + } + ], + "summary": "Retrieve an identity source session", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceSessionId" + } + ] + }, + "/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-delete": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceSessionId" + } + ], + "post": { + "description": "Uploads external IDs of entities that need to be deleted in Okta from the identity source for the given session", + "operationId": "uploadIdentitySourceDataForDelete", + "requestBody": { + "content": { + "application/json": { + "examples": { + "bulkDeletePayload": { + "$ref": "#/components/examples/bulkDeletePayload" + } + }, + "schema": { + "$ref": "#/components/schemas/BulkDeleteRequestBody" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Upload the data to be deleted in Okta", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-group-memberships-delete": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceSessionId" + } + ], + "post": { + "description": "Uploads the group memberships that need to be deleted in Okta from the identity source for the given session", + "operationId": "uploadIdentitySourceGroupMembershipsForDelete", + "requestBody": { + "content": { + "application/json": { + "examples": { + "bulkGroupMembershipsDeletePayload": { + "$ref": "#/components/examples/bulkGroupMembershipsDeletePayload" + } + }, + "schema": { + "$ref": "#/components/schemas/BulkGroupMembershipsDeleteRequestBody" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Upload the group memberships to be deleted in Okta", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-group-memberships-upsert": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceSessionId" + } + ], + "post": { + "description": "Uploads the group memberships that need to be inserted or updated in Okta from the identity source for the given session", + "operationId": "uploadIdentitySourceGroupMembershipsForUpsert", + "requestBody": { + "content": { + "application/json": { + "examples": { + "bulkGroupMembershipsUpsertPayload": { + "$ref": "#/components/examples/bulkGroupMembershipsUpsertPayload" + } + }, + "schema": { + "$ref": "#/components/schemas/BulkGroupMembershipsUpsertRequestBody" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Upload the group memberships to be upserted in Okta", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-groups-delete": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceSessionId" + } + ], + "post": { + "description": "Uploads external IDs of groups that need to be deleted in Okta from the identity source for the given session", + "operationId": "uploadIdentitySourceGroupsDataForDelete", + "requestBody": { + "content": { + "application/json": { + "examples": { + "bulkGroupDeletePayload": { + "$ref": "#/components/examples/bulkGroupDeletePayload" + } + }, + "schema": { + "$ref": "#/components/schemas/BulkGroupDeleteRequestBody" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Upload the group external IDs to be deleted in Okta", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-groups-upsert": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceSessionId" + } + ], + "post": { + "description": "Uploads the group profiles without memberships that need to be inserted or updated in Okta from the identity source for the given session", + "operationId": "uploadIdentitySourceGroupsForUpsert", + "requestBody": { + "content": { + "application/json": { + "examples": { + "bulkGroupUpsertPayload": { + "$ref": "#/components/examples/bulkGroupUpsertPayload" + } + }, + "schema": { + "$ref": "#/components/schemas/BulkGroupUpsertRequestBody" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Upload the group profiles without memberships to be upserted in Okta", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-upsert": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceSessionId" + } + ], + "post": { + "description": "Uploads entities that need to be inserted or updated in Okta from the identity source for the given session", + "operationId": "uploadIdentitySourceDataForUpsert", + "requestBody": { + "content": { + "application/json": { + "examples": { + "bulkUpsertPayload": { + "$ref": "#/components/examples/bulkUpsertPayload" + } + }, + "schema": { + "$ref": "#/components/schemas/BulkUpsertRequestBody" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Upload the data to be upserted in Okta", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/start-import": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathIdentitySourceSessionId" + } + ], + "post": { + "description": "Starts the import from the identity source described by the uploaded bulk operations", + "operationId": "startImportFromIdentitySource", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "triggeredSession": { + "$ref": "#/components/examples/TriggerSessionResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentitySourceSession" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Start the import from the identity source", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/users": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + } + ], + "post": { + "description": "Creates a user in an identity source for the given identity source instance", + "operationId": "createIdentitySourceUser", + "requestBody": { + "content": { + "application/json": { + "examples": { + "userCreatePayload": { + "$ref": "#/components/examples/UserPayload" + } + }, + "schema": { + "$ref": "#/components/schemas/UserRequestSchema" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Create an identity source user", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/identity-sources/{identitySourceId}/users/{externalId}": { + "delete": { + "description": "Deletes a user in an identity source for the given identity source instance and external ID", + "operationId": "deleteIdentitySourceUser", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Delete an identity source user", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a user by external ID in an identity source for the given identity source instance", + "operationId": "getIdentitySourceUser", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "userResponse": { + "$ref": "#/components/examples/UserResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserResponseSchema" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.read" + ] + } + ], + "summary": "Retrieve an identity source user", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdentitySourceId" + }, + { + "$ref": "#/components/parameters/pathExternalUserId" + } + ], + "patch": { + "description": "Updates a user to an identity source for the given identity source instance and external ID", + "operationId": "updateIdentitySourceUsers", + "requestBody": { + "content": { + "application/json": { + "examples": { + "userCreatePayload": { + "$ref": "#/components/examples/UserUpdatePayload" + } + }, + "schema": { + "$ref": "#/components/schemas/UsersUpdateRequestSchema" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "userResponse": { + "$ref": "#/components/examples/UserUpdateResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserResponseSchema" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Update an identity source user", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces an existing user for the given identity source instance and external ID", + "operationId": "replaceExistingIdentitySourceUser", + "requestBody": { + "content": { + "application/json": { + "examples": { + "userReplacePayload": { + "$ref": "#/components/examples/UserReplacePayload" + } + }, + "schema": { + "$ref": "#/components/schemas/UserRequestSchema" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "userResponse": { + "$ref": "#/components/examples/UserReplaceResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserResponseSchema" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.identitySources.manage" + ] + } + ], + "summary": "Replace an existing identity source user", + "tags": [ + "IdentitySource" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps": { + "get": { + "description": "Lists all identity provider (IdP) integrations with pagination. A subset of IdPs can be returned that match a supported filter expression or query.", + "operationId": "listIdentityProviders", + "parameters": [ + { + "description": "Searches the `name` property of IdPs for matching value", + "example": "Example SAML", + "in": "query", + "name": "q", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + }, + { + "description": "Filters IdPs by `type`", + "in": "query", + "name": "type", + "schema": { + "$ref": "#/components/schemas/IdentityProviderType" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "MultipleIdPsResponse": { + "$ref": "#/components/examples/MultipleIdPsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/IdentityProvider" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "List all IdPs", + "tags": [ + "IdentityProvider" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new identity provider (IdP) integration.\n\n#### SAML 2.0 IdP\n\nYou must first add the IdP's signature certificate to the IdP key store before you can add a SAML 2.0 IdP with a `kid` credential reference.\n\nDon't use `fromURI` to automatically redirect a user to a particular app after successfully authenticating with a third-party IdP. Instead, use SAML deep links. Using `fromURI` isn't tested or supported. For more information about using deep links when signing users in using an SP-initiated flow, see [Understanding SP-Initiated Login flow](https://developer.okta.com/docs/concepts/saml/#understanding-sp-initiated-login-flow).\n\nUse SAML deep links to automatically redirect the user to an app after successfully authenticating with a third-party IdP. To use deep links, assemble these three parts into a URL:\n\n* SP ACS URL<br>\nFor example: `https://${yourOktaDomain}/sso/saml2/:idpId`\n* The app to which the user is automatically redirected after successfully authenticating with the IdP <br>\nFor example: `/app/:app-location/:appId/sso/saml`\n* Optionally, if the app is an outbound SAML app, you can specify the `relayState` passed to it.<br>\nFor example: `?RelayState=:anyUrlEncodedValue`\n\nThe deep link for the above three parts is:<br>\n`https://${yourOktaDomain}/sso/saml2/:idpId/app/:app-location/:appId/sso/saml?RelayState=:anyUrlEncodedValue`\n\n#### Smart Card X509 IdP\n\nYou must first add the IdP's server certificate to the IdP key store before you can add a Smart Card `X509` IdP with a `kid` credential reference.\nYou need to upload the whole trust chain as a single key using the [Key Store API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProviderKeys/#tag/IdentityProviderKeys/operation/createIdentityProviderKey).\nDepending on the information stored in the smart card, select the proper [template](https://developer.okta.com/docs/reference/okta-expression-language/#idp-user-profile) `idpuser.subjectAltNameEmail` or `idpuser.subjectAltNameUpn`.\n\n#### Identity verification vendors as identity providers\n\nIdentity verification (IDV) vendors work like IdPs, with a few key differences. IDV vendors verify your user's identities by requiring them to submit a proof of identity. There are many ways to verify user identities. For example, a proof of identity can be a selfie to determine liveliness or it can be requiring users to submit a photo of their driver's license and matching that information with a database.\n\nThere are three IDV vendors (Persona, CLEAR Verified, and Incode) with specific configuration settings and another IDV vendor type (Custom IDV) that lets you create a custom IDV vendor, using a [standardized IDV process](https://developer.okta.com/docs/guides/idv-integration/main/). You can configure each of the IDV vendors as IdPs in your org by creating an account with the vendor, and then creating an IdP integration. Control how the IDVs verify your users by using [Okta account management policy rules](https://developer.okta.com/docs/guides/okta-account-management-policy/main/).\n\n* [Persona](https://withpersona.com/)\n\n* [CLEAR Verified](https://www.clearme.com/)\n\n* [Incode](https://incode.com/)\n\n* [Custom IDV](https://help.okta.com/okta_help.htm?type=oie&id=idp-add-custom-idv-vendor)", + "operationId": "createIdentityProvider", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateAppleIdPRequest": { + "$ref": "#/components/examples/CreateAppleIdPRequest" + }, + "CreateCLEARIDVRequest": { + "$ref": "#/components/examples/CreateCLEARIDVRequest" + }, + "CreateCustomIDVRequest": { + "$ref": "#/components/examples/CreateCustomIDVRequest" + }, + "CreateFacebookIdPRequest": { + "$ref": "#/components/examples/CreateFacebookIdPRequest" + }, + "CreateGenericOidcIdPRequest": { + "$ref": "#/components/examples/CreateGenericOidcIdPRequest" + }, + "CreateGoogleIdPRequest": { + "$ref": "#/components/examples/CreateGoogleIdPRequest" + }, + "CreateIncodeIDVRequest": { + "$ref": "#/components/examples/CreateIncodeIDVRequest" + }, + "CreateMicrosoftIdPRequest": { + "$ref": "#/components/examples/CreateMicrosoftIdPRequest" + }, + "CreateOktaIntegrationIdPRequest": { + "$ref": "#/components/examples/CreateOktaIntegrationIdPRequest" + }, + "CreatePersonaIDVRequest": { + "$ref": "#/components/examples/CreatePersonaIDVRequest" + }, + "CreateSamlIdPRequest": { + "$ref": "#/components/examples/CreateSamlIdPRequest" + }, + "CreateSmartCardIdPRequest": { + "$ref": "#/components/examples/CreateSmartCardIdPRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + }, + "description": "IdP settings", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CreateAppleIdPResponse": { + "$ref": "#/components/examples/AppleIdPResponse" + }, + "CreateCLEARIDVResponse": { + "$ref": "#/components/examples/CLEARIDVResponse" + }, + "CreateCustomIDVResponse": { + "$ref": "#/components/examples/CustomIDVResponse" + }, + "CreateFacebookIdPResponse": { + "$ref": "#/components/examples/FacebookIdPResponse" + }, + "CreateGenericOidcIdpResponse": { + "$ref": "#/components/examples/GenericOidcIdpResponse" + }, + "CreateGoogleIdPResponse": { + "$ref": "#/components/examples/GoogleIdPResponse" + }, + "CreateIncodeIDVResponse": { + "$ref": "#/components/examples/IncodeIDVResponse" + }, + "CreateMicrosoftIdPResponse": { + "$ref": "#/components/examples/MicrosoftIdPResponse" + }, + "CreatePersonaIDVResponse": { + "$ref": "#/components/examples/PersonaIDVResponse" + }, + "CreateSamlIdPResponse": { + "$ref": "#/components/examples/SamlIdPResponse" + }, + "CreateSmartCardIdPResponse": { + "$ref": "#/components/examples/SmartCardIdPResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Create an IdP", + "tags": [ + "IdentityProvider" + ], + "x-codegen-request-body-name": "identityProvider", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/credentials/keys": { + "get": { + "description": "Lists all identity provider (IdP) key credentials", + "operationId": "listIdentityProviderKeys", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListIdPKeyCredentialsResponse": { + "$ref": "#/components/examples/MultipleIdPKeyCredentialsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/IdPKeyCredential" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "List all IdP key credentials", + "tags": [ + "IdentityProviderKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new X.509 certificate credential in the identity provider (IdP) key store\n> **Note:** RSA-based certificates are supported for all IdP types. Okta currently supports EC-based certificates only for the `X509` IdP type. For EC-based certificates we support only P-256, P-384, and P-521 curves.", + "operationId": "createIdentityProviderKey", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdPCertificateCredential" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "IdPKeyCredentialResponse": { + "$ref": "#/components/examples/IdPKeyCredentialResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPKeyCredential" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Create an IdP key credential", + "tags": [ + "IdentityProviderKeys" + ], + "x-codegen-request-body-name": "jsonWebKey", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/credentials/keys/{kid}": { + "delete": { + "description": "Deletes a specific identity provider (IdP) key credential by `kid` if it isn't currently being used by an active or inactive IdP", + "operationId": "deleteIdentityProviderKey", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Delete an IdP key credential", + "tags": [ + "IdentityProviderKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a specific identity provider (IdP) key credential by `kid`", + "operationId": "getIdentityProviderKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "IdPKeyCredentialResponse": { + "$ref": "#/components/examples/IdPKeyCredentialResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPKeyCredential" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "Retrieve an IdP key credential", + "tags": [ + "IdentityProviderKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathKid" + } + ], + "put": { + "description": "Replaces an identity provider (IdP) key credential by `kid`", + "operationId": "replaceIdentityProviderKey", + "requestBody": { + "content": { + "application/json": { + "examples": { + "IdPKeyCredentialRequest": { + "$ref": "#/components/examples/IdPKeyCredentialRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPKeyCredential" + } + } + }, + "description": "Updated IdP key credential", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "IdPKeyCredentialResponse": { + "$ref": "#/components/examples/IdPKeyCredentialResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPKeyCredential" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Replace an IdP key credential", + "tags": [ + "IdentityProviderKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/{idpId}": { + "delete": { + "description": "Deletes an identity provider (IdP) integration by `idpId`\n* All existing IdP users are unlinked with the highest order profile source taking precedence for each IdP user.\n* Unlinked users keep their existing authentication provider such as `FEDERATION` or `SOCIAL`.", + "operationId": "deleteIdentityProvider", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Delete an IdP", + "tags": [ + "IdentityProvider" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an identity provider (IdP) integration by `idpId`", + "operationId": "getIdentityProvider", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GenericOidcIdpResponse": { + "$ref": "#/components/examples/GenericOidcIdpResponse" + }, + "SamlIdPResponse": { + "$ref": "#/components/examples/SamlIdPResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "Retrieve an IdP", + "tags": [ + "IdentityProvider" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + } + ], + "put": { + "description": "Replaces an identity provider (IdP) integration by `idpId`", + "operationId": "replaceIdentityProvider", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ReplaceIdPRequest": { + "$ref": "#/components/examples/ReplaceIdPRequestResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + }, + "description": "Updated configuration for the IdP", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ReplaceIdPResponse": { + "$ref": "#/components/examples/ReplaceIdPRequestResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Replace an IdP", + "tags": [ + "IdentityProvider" + ], + "x-codegen-request-body-name": "identityProvider", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/{idpId}/credentials/csrs": { + "get": { + "description": "Lists all certificate signing requests (CSRs) for an identity provider (IdP)", + "operationId": "listCsrsForIdentityProvider", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "MultipleIdPCsrsResponse": { + "$ref": "#/components/examples/MultipleIdPCsrsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/IdPCsr" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "List all certificate signing requests", + "tags": [ + "IdentityProviderSigningKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + } + ], + "post": { + "description": "Generates a new key pair and returns a certificate signing request (CSR) for it\n> **Note:** The private key isn't listed in the [signing key credentials for the identity provider (IdP)](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProviderSigningKeys/#tag/IdentityProviderSigningKeys/operation/listIdentityProviderSigningKeys) until it's published.", + "operationId": "generateCsrForIdentityProvider", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CsrMetadata" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "CsrJsonResponse": { + "$ref": "#/components/examples/CsrJsonResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPCsr" + } + }, + "application/pkcs10": { + "examples": { + "CsrPkcs10Response": { + "$ref": "#/components/examples/CsrPkcs10Response" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPCsrPkcs10" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Generate a certificate signing request", + "tags": [ + "IdentityProviderSigningKeys" + ], + "x-codegen-request-body-name": "metadata", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}": { + "delete": { + "description": "Revokes a certificate signing request (CSR) and deletes the key pair from the identity provider (IdP)", + "operationId": "revokeCsrForIdentityProvider", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Revoke a certificate signing request", + "tags": [ + "IdentityProviderSigningKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a specific certificate signing request (CSR) by `id`", + "operationId": "getCsrForIdentityProvider", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CsrJsonResponse": { + "$ref": "#/components/examples/CsrJsonResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPCsr" + } + }, + "application/pkcs10": { + "examples": { + "CsrPkcs10Response": { + "$ref": "#/components/examples/CsrPkcs10Response" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPCsrPkcs10" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "Retrieve a certificate signing request", + "tags": [ + "IdentityProviderSigningKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + }, + { + "$ref": "#/components/parameters/pathIdpCsrId" + } + ] + }, + "/api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}/lifecycle/publish": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + }, + { + "$ref": "#/components/parameters/pathIdpCsrId" + } + ], + "post": { + "description": "Publishes the certificate signing request (CSR) with a signed X.509 certificate and adds it into the signing key credentials for the identity provider (IdP)\n> **Notes:**\n> * Publishing a certificate completes the lifecycle of the CSR, and it's no longer accessible.\n> * If the validity period of the certificate is less than 90 days, a 400 error response is returned.", + "operationId": "publishCsrForIdentityProvider", + "requestBody": { + "content": { + "application/pkix-cert": { + "schema": { + "description": "X.509 certificate in `DER` format.\nThe client can either post in binary or Base64URL-encoded. If the post is Base64URL-encoded, set the `Content-Transfer-Encoding` header to `base64`.", + "example": "MIIFgjCCA2qgAwIBAgICEAcwDQYJKoZIhvcNAQELBQAwXjELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMQ0wCwYDVQQKDARPa3RhMQwwCgYDVQQLDANFbmcxDTALBgNVBAMMBFJvb3QwHhcNMTcwMzI3MjEyMDQ3WhcNMTgwNDA2MjEyMDQ3WjB4MQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzETMBEGA1UECgwKT2t0YSwgSW5jLjEQMA4GA1UECwwHSmFua3lDbzEVMBMGA1UEAwwMSWRQIElzc3VlciA3MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmkC6yAJVvFwUlmM9gKjb2d+YK5qHFt+mXSsbjWKKs4EfNm+BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL/q7n0f/SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH+bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQIDAQABo4IBLjCCASowCQYDVR0TBAIwADARBglghkgBhvhCAQEEBAMCBkAwMwYJYIZIAYb4QgENBCYWJE9wZW5TU0wgR2VuZXJhdGVkIFNlcnZlciBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQUVqJukDmyENw/2pTApbxc/HRKbngwgZAGA1UdIwSBiDCBhYAUFx245ZZXqWTTbARfMlFWN77L9EahYqRgMF4xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJDQTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEMMAoGA1UECwwDRW5nMQ0wCwYDVQQDDARSb290ggkAlIfpwZjO5o8wDgYDVR0PAQH/BAQDAgWgMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUAA4ICAQCcoBSRtY+9cJY00hLvq6AloYZcdn/kUQupfmyz4n3lKE3wV2FB0swKnK0QDi8iNuQJFdag/19vDHC4/LhoSuv1Q+KXM61pPZVRXXPyC1+e7Y6hj93tEI5HcqLPcDRH1AIG2l8tE7LBn+MQB5Vh6oxjG2IdoWxg6abMfISU+MauPWql4vMDUWo9iNShAo44Z5fd+nuz+hlAinU9Xn9Jf2QsfKvcbMRq7iuqgkabgdmObmWb9KK0Vm7TDkxCH0pB0onPr6epVUP8Obg/pT1Oj/1hOLbfR8CHHWdAWzUBGGvp2TIy2A8LUaEoFnwkxZfdL7Bnd0RH/ClBtAjzLOxmUo7NbZmEnYCcD5pZz7BdZI0db/eBXFqfOlA88rEe+9Sv+NndIq0/WNIIsJi2RgjJnxsxvB5MjhhzmItpFIUl5yqoO3C9jcCp6HDBJxtCGbvAr5ALPn5RCJeBIr67WpAiTd7L3Ebu9SQZlXnoHX8kP04EA6ylR3W0EFbh7KUtq8M2H2vo0wjMj7ysl/3tT7cEZ97s1ygO5iJx3GfMDyrDhtLXSBJ20uSxTJeptRw8SDiwTqunIh1WyKlcQz1WGauSbW4eXdj/r9KYMJ3qMMkdP/9THQUtTcOYx51r8RV9pdzqF2HPnZZNziBa+wXJZHEWp70NyoakNthgYwtypqiDHs2f3Q==", + "format": "binary", + "type": "string", + "x-okta-operationId": "publishBinaryDerCertForIdentityProvider" + } + }, + "application/x-pem-file": { + "schema": { + "description": "X.509 certificate in `PEM` format", + "example": "@certificate.pem", + "format": "binary", + "type": "string", + "x-okta-operationId": "publishBinaryPemCertForIdentityProvider" + } + }, + "application/x-x509-ca-cert": { + "schema": { + "description": "X.509 certificate in `CER` format.\nThe client can either post in binary or Base64URL-encoded. If the post is Base64URL-encoded, set the `Content-Transfer-Encoding` header to `base64`.", + "example": "@certificate.cer", + "format": "binary", + "type": "string", + "x-okta-operationId": "publishBinaryCerCertForIdentityProvider" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdPKeyCredential" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Publish a certificate signing request", + "tags": [ + "IdentityProviderSigningKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/{idpId}/credentials/keys": { + "get": { + "description": "Lists all signing key credentials for an identity provider (IdP)", + "operationId": "listIdentityProviderSigningKeys", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "MultipleIdPSigningKeyCredentialsResponse": { + "$ref": "#/components/examples/MultipleIdPSigningKeyCredentialsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/IdPKeyCredential" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "List all signing key credentials for IdP", + "tags": [ + "IdentityProviderSigningKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + } + ] + }, + "/api/v1/idps/{idpId}/credentials/keys/active": { + "get": { + "description": "Lists the active signing key credential for an identity provider (IdP)", + "operationId": "listActiveIdentityProviderSigningKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ActiveIdPSigningKeyCredentialResponse": { + "$ref": "#/components/examples/ActiveIdPSigningKeyCredentialResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/IdPKeyCredential" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "204": { + "content": {}, + "description": "No Content" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "List the active signing key credential for IdP", + "tags": [ + "IdentityProviderSigningKeys" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + } + ] + }, + "/api/v1/idps/{idpId}/credentials/keys/generate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + } + ], + "post": { + "description": "Generates a new X.509 certificate for an identity provider (IdP) signing key credential to be used for signing assertions sent to the IdP. IdP signing keys are read-only.\n> **Note:** To update an IdP with the newly generated key credential, [update your IdP](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider) using the returned key's `kid` in the [signing credential](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider!path=protocol/0/credentials/signing/kid&t=request).", + "operationId": "generateIdentityProviderSigningKey", + "parameters": [ + { + "description": "expiry of the IdP key credential", + "in": "query", + "name": "validityYears", + "required": true, + "schema": { + "format": "int32", + "maximum": 10, + "minimum": 2, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "IdPSigningKeyCredentialResponse": { + "$ref": "#/components/examples/IdPSigningKeyCredentialResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPKeyCredential" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Generate a new signing key credential for IdP", + "tags": [ + "IdentityProviderSigningKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/{idpId}/credentials/keys/{kid}": { + "get": { + "description": "Retrieves a specific identity provider (IdP) key credential by `kid`", + "operationId": "getIdentityProviderSigningKey", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "IdPSigningKeyCredentialResponse": { + "$ref": "#/components/examples/IdPSigningKeyCredentialResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPKeyCredential" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "Retrieve a signing key credential for IdP", + "tags": [ + "IdentityProviderSigningKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + }, + { + "$ref": "#/components/parameters/pathKid" + } + ] + }, + "/api/v1/idps/{idpId}/credentials/keys/{kid}/clone": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + }, + { + "$ref": "#/components/parameters/pathKid" + } + ], + "post": { + "description": "Clones an X.509 certificate for an identity provider (IdP) signing key credential from a source IdP to target IdP\n> **Caution:** Sharing certificates isn't a recommended security practice.\n\n> **Note:** If the key is already present in the list of key credentials for the target IdP, you receive a 400 error response.", + "operationId": "cloneIdentityProviderKey", + "parameters": [ + { + "description": "`id` of the target IdP", + "in": "query", + "name": "targetIdpId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "IdPSigningKeyCredentialResponse": { + "$ref": "#/components/examples/IdPSigningKeyCredentialResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdPKeyCredential" + } + } + }, + "description": "Created" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Clone a signing key credential for IdP", + "tags": [ + "IdentityProviderSigningKeys" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/{idpId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + } + ], + "post": { + "description": "Activates an inactive identity provider (IdP)", + "operationId": "activateIdentityProvider", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ActivateIdPResponse": { + "$ref": "#/components/examples/ActivateIdPResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Activate an IdP", + "tags": [ + "IdentityProvider" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/{idpId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + } + ], + "post": { + "description": "Deactivates an active identity provider (IdP)", + "operationId": "deactivateIdentityProvider", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "DeactivateIdPResponse": { + "$ref": "#/components/examples/DeactivateIdPResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Deactivate an IdP", + "tags": [ + "IdentityProvider" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/{idpId}/users": { + "get": { + "description": "Lists all the users linked to an identity provider (IdP)", + "operationId": "listIdentityProviderApplicationUsers", + "parameters": [ + { + "$ref": "#/components/parameters/queryFilter" + }, + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + }, + { + "description": "Expand user data", + "in": "query", + "name": "expand", + "schema": { + "example": "user", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListIdPUsersResponse": { + "$ref": "#/components/examples/ListIdPUsersResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/IdentityProviderApplicationUser" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "List all users for IdP", + "tags": [ + "IdentityProviderUsers" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + } + ] + }, + "/api/v1/idps/{idpId}/users/{userId}": { + "delete": { + "description": "Unlinks the Okta user and the identity provider (IdP) user. The next time the user federates into Okta through this IdP, they have to re-link their account according to the account link policy.", + "operationId": "unlinkUserFromIdentityProvider", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.manage" + ] + } + ], + "summary": "Unlink a user from IdP", + "tags": [ + "IdentityProviderUsers" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a linked identity provider (IdP) user by ID", + "operationId": "getIdentityProviderApplicationUser", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "IdPAppUserResponse": { + "$ref": "#/components/examples/IdPAppUserResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentityProviderApplicationUser" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "Retrieve a user for IdP", + "tags": [ + "IdentityProviderUsers" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + }, + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "post": { + "description": "Links an Okta user to an existing SAML or social identity provider (IdP).\n\nThe SAML IdP must have `honorPersistentNameId` set to `true` to use this API.\nThe [Name Identifier Format](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider!path=protocol/0/settings&t=request) of the incoming assertion must be `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`.", + "operationId": "linkUserToIdentityProvider", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserIdentityProviderLinkRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "LinkIdPAppUserResponse": { + "$ref": "#/components/examples/LinkIdPAppUserResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/IdentityProviderApplicationUser" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Link a user to IdP", + "tags": [ + "IdentityProviderUsers" + ], + "x-codegen-request-body-name": "userIdentityProviderLinkRequest", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/idps/{idpId}/users/{userId}/credentials/tokens": { + "get": { + "description": "Lists the tokens minted by the social authentication provider when the user authenticates with Okta via Social Auth.\n\nOkta doesn't import all the user information from a social provider. If the app needs information that isn't imported, it can get the user token from this endpoint. Then the app can make an API call to the social provider with the token to request the additional information.", + "operationId": "listSocialAuthTokens", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "SocialAuthTokensResponse": { + "$ref": "#/components/examples/SocialAuthTokensResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/SocialAuthToken" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.idps.read" + ] + } + ], + "summary": "List all tokens from OIDC IdP", + "tags": [ + "IdentityProviderUsers" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathIdpId" + }, + { + "$ref": "#/components/parameters/pathUserId" + } + ] + }, + "/api/v1/inlineHooks": { + "get": { + "description": "Lists all inline hooks or all inline hooks of a specific type.\n\nWhen listing a specific inline hook, you need to specify its type. The following types are currently supported:\n | Type Value | Name |\n |------------------------------------|----------------------------------------------------------------|\n | `com.okta.import.transform` | [User import inline hook](/openapi/okta-management/management/management/inlinehook/createuserimportinlinehook) |\n | `com.okta.oauth2.tokens.transform` | [Token inline hook](/openapi/okta-management/management/management/inlinehook/createtokeninlinehook) |\n | `com.okta.saml.tokens.transform` | [SAML assertion inline hook](/openapi/okta-management/management/management/inlinehook/createsamlassertioninlinehook) |\n | `com.okta.telephony.provider` | [Telephony inline hook](/openapi/okta-management/management/management/inlinehook/createtelephonyinlinehook) |\n | `com.okta.user.credential.password.import` | [Password import inline hook](openapi/okta-management/management/management/inlinehook/createpasswordimportinlinehook)|\n | `com.okta.user.pre-registration` | [Registration inline hook](/openapi/okta-management/management/management/inlinehook/create-registration-hook) |", + "operationId": "listInlineHooks", + "parameters": [ + { + "$ref": "#/components/parameters/inlineHookType" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "InlineHooktMgmtListAllexample": { + "$ref": "#/components/examples/InlineHooktMgmtListAllexample" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/InlineHook" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.read" + ] + } + ], + "summary": "List all inline hooks", + "tags": [ + "InlineHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates an inline hook\n\nThis endpoint creates an inline hook for your org in an `ACTIVE` status. You need to pass an inline hooks object in the JSON payload of your request.\nThat object represents the set of required information about the inline hook that you're registering, including:\n\n* The URI of your external service endpoint\n* The type of inline hook you're registering\n* The type of authentication you're registering\n\nThere are two authentication options that you can configure for your inline hook: HTTP headers and OAuth 2.0 tokens.\n\nHTTP headers let you specify a secret API key that you want Okta to pass to your external service endpoint (so that your external service can check for its presence as a security measure).\n\n>**Note:** The API key that you set here is unrelated to the Okta API token you must supply when making calls to Okta APIs.\n\nYou can also optionally specify extra headers that you want Okta to pass to your external service with each call.\n\nTo configure HTTP header authentication, see parameters for the `config` object.\n\nOAuth 2.0 tokens provide enhanced security between Okta and your external service. You can configure these tokens for the following types—client secret and private key.\n\n>**Note:** Your external service's endpoint needs to be a valid HTTPS endpoint. The URI you specify should always begin with `https://`.\n\nThe total number of inline hooks that you can create in an Okta org is limited to 50, which is a combined total for any combination of inline hook types.", + "operationId": "createInlineHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateInlineHookHTTP": { + "$ref": "#/components/examples/InlineHookMgmtCreateHTTPRequest" + }, + "CreateInlineHookOAuthClientSecret": { + "$ref": "#/components/examples/InlineHookMgmtCreateOAuthClientSecretRequest" + }, + "CreateInlineHookOAuthPrivateKey": { + "$ref": "#/components/examples/InlineHookMgmtCreateOAuthPrivateKeyRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/InlineHookCreate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CreateInlineHookHTTP": { + "$ref": "#/components/examples/InlineHookMgmtCreateHTTPResponse" + }, + "CreateInlineHookOAuthClientSecret": { + "$ref": "#/components/examples/InlineHookMgmtCreateOAuthClientSecretResponse" + }, + "CreateInlineHookOAuthPrivateKey": { + "$ref": "#/components/examples/InlineHookMgmtCreateOAuthPrivateKeyResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/InlineHookCreateResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.manage" + ] + } + ], + "summary": "Create an inline hook", + "tags": [ + "InlineHook" + ], + "x-codegen-request-body-name": "inlineHookCreate", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/inlineHooks/{inlineHookId}": { + "delete": { + "description": "Deletes an inline hook by `inlineHookId`. After it's deleted, the inline hook is unrecoverable. As a safety precaution, only inline hooks with a status of `INACTIVE` are eligible for deletion.", + "operationId": "deleteInlineHook", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.manage" + ] + } + ], + "summary": "Delete an inline hook", + "tags": [ + "InlineHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an inline hook by `inlineHookId`", + "operationId": "getInlineHook", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "InlineHookHTTP": { + "$ref": "#/components/examples/InlineHookMgmtHTTPexample" + }, + "InlineHookOAuthClientSecret": { + "$ref": "#/components/examples/InlineHookMgmtOAuthCSPexample" + }, + "InlineHookOAuthPrivateKey": { + "$ref": "#/components/examples/InlineHookMgmtOauthPKJexample" + } + }, + "schema": { + "$ref": "#/components/schemas/InlineHook" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.read" + ] + } + ], + "summary": "Retrieve an inline hook", + "tags": [ + "InlineHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathInlineHookId" + } + ], + "post": { + "description": "Updates an inline hook by `inlineHookId`", + "operationId": "updateInlineHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UpdateInlineHookHTTP": { + "$ref": "#/components/examples/InlineHookMgmtPutHTTPRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/InlineHookReplace" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UpdateInlineHookHTTP": { + "$ref": "#/components/examples/InlineHookMgmtPutResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/InlineHook" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.manage" + ] + } + ], + "summary": "Update an inline hook", + "tags": [ + "InlineHook" + ], + "x-codegen-request-body-name": "inlineHook", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces an inline hook by `inlineHookId`. The submitted inline hook properties replace the existing properties after passing validation.\n\n>**Note:** Some properties are immutable and can't be updated.", + "operationId": "replaceInlineHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UpdateInlineHookHTTP": { + "$ref": "#/components/examples/InlineHookMgmtPutHTTPRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/InlineHookReplace" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UpdateInlineHookHTTP": { + "$ref": "#/components/examples/InlineHookMgmtPutResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/InlineHook" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.manage" + ] + } + ], + "summary": "Replace an inline hook", + "tags": [ + "InlineHook" + ], + "x-codegen-request-body-name": "inlineHook", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/inlineHooks/{inlineHookId}/execute": { + "parameters": [ + { + "$ref": "#/components/parameters/pathInlineHookId" + } + ], + "post": { + "description": "Executes the inline hook that matches the provided `inlineHookId` by using the request body as the input. This inline hook sends the provided\ndata through the `channel` object and returns a response if it matches the correct data contract. Otherwise it returns an error. You need to\nconstruct a JSON payload that matches the payloads that Okta would send to your external service for this inline hook type.\n\nA timeout of three seconds is enforced on all outbound requests, with one retry in the event of a timeout or an error response from the remote system.\nIf a successful response isn't received after the request, a 400 error is returned with more information about what failed.\n\n>**Note:** This execution endpoint isn't tied to any other functionality in Okta, and you should only use it for testing purposes.", + "operationId": "executeInlineHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "PasswordImportPayloadExample": { + "$ref": "#/components/examples/PasswordImportPayloadExample" + }, + "ProfileEnrollmentRequest": { + "$ref": "#/components/examples/ProfileEnrollmentRequest" + }, + "SAMLPayloadExample": { + "$ref": "#/components/examples/SAMLPayLoadExample" + }, + "TelephonyPayloadExample": { + "$ref": "#/components/examples/TelephonyPayloadExample" + }, + "TokenPayLoadExample": { + "$ref": "#/components/examples/TokenPayLoadExample" + }, + "UserImportPayloadExample": { + "$ref": "#/components/examples/UserImportPayloadExample" + } + }, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/PasswordImportRequestExecute" + }, + { + "$ref": "#/components/schemas/TelephonyRequestExecute" + }, + { + "$ref": "#/components/schemas/RegistrationInlineHookRequest" + }, + { + "$ref": "#/components/schemas/TokenRequest" + }, + { + "$ref": "#/components/schemas/SAMLPayloadExecute" + }, + { + "$ref": "#/components/schemas/UserImportRequestExecute" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "PasswordImportPayloadExample": { + "$ref": "#/components/examples/PasswordImportVerifiedResponse" + }, + "ProfileEnrollmentRequest": { + "$ref": "#/components/examples/ProfileEnrollmentResponse" + }, + "SAMLPayloadExample": { + "$ref": "#/components/examples/SAMLHookResponseExample" + }, + "TelephonyPayloadExample": { + "$ref": "#/components/examples/TelephonySuccessResponse" + }, + "TokenPayLoadExample": { + "$ref": "#/components/examples/TokenHookResponse" + }, + "UserImportPayloadExample": { + "$ref": "#/components/examples/UserImportChangeAppUserProfileExample" + } + }, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/PasswordImportResponse" + }, + { + "$ref": "#/components/schemas/TelephonyResponse" + }, + { + "$ref": "#/components/schemas/RegistrationInlineHookResponse" + }, + { + "$ref": "#/components/schemas/TokenHookResponse" + }, + { + "$ref": "#/components/schemas/SAMLHookResponse" + }, + { + "$ref": "#/components/schemas/UserImportResponse" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.manage" + ] + } + ], + "summary": "Execute an inline hook", + "tags": [ + "InlineHook" + ], + "x-codegen-request-body-name": "payloadData", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/inlineHooks/{inlineHookId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathInlineHookId" + } + ], + "post": { + "description": "Activates the inline hook by `inlineHookId`", + "operationId": "activateInlineHook", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ActivateAnInlineHook": { + "$ref": "#/components/examples/InlineHookMgmtOAuthCSPexample" + } + }, + "schema": { + "$ref": "#/components/schemas/InlineHook" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.manage" + ] + } + ], + "summary": "Activate an inline hook", + "tags": [ + "InlineHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathInlineHookId" + } + ], + "post": { + "description": "Deactivates the inline hook by `inlineHookId`", + "operationId": "deactivateInlineHook", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "DeactivateAnInlineHook": { + "$ref": "#/components/examples/InlineHookMgmtHTTPexampleDeactivate" + } + }, + "schema": { + "$ref": "#/components/schemas/InlineHook" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.inlineHooks.manage" + ] + } + ], + "summary": "Deactivate an inline hook", + "tags": [ + "InlineHook" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/logStreams": { + "get": { + "description": "Lists all log stream objects in your org. You can request a paginated list or a subset of log streams that match a supported filter expression.", + "operationId": "listLogStreams", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + }, + { + "description": "An expression that [filters](/#filter) the returned objects. You can only use the `eq` operator on either the `status` or `type` properties in the filter expression.", + "in": "query", + "name": "filter", + "schema": { + "example": "type eq \"aws_eventbridge\"", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ExampleGetAllResponse": { + "$ref": "#/components/examples/LogStreamGetAllResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/LogStream" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.logStreams.read" + ] + } + ], + "summary": "List all log streams", + "tags": [ + "LogStream" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new log stream object", + "operationId": "createLogStream", + "requestBody": { + "content": { + "application/json": { + "examples": { + "LogStreamPostRequestExample": { + "$ref": "#/components/examples/LogStreamPostRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/LogStream" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "LogStreamPostResponseExample": { + "$ref": "#/components/examples/LogStreamPostResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/LogStream" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.logStreams.manage" + ] + } + ], + "summary": "Create a log stream", + "tags": [ + "LogStream" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/logStreams/{logStreamId}": { + "delete": { + "description": "Deletes a log stream object from your org by ID", + "operationId": "deleteLogStream", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden", + "headers": {} + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.logStreams.manage" + ] + } + ], + "summary": "Delete a log stream", + "tags": [ + "LogStream" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a log stream object by ID", + "operationId": "getLogStream", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "LogStreamGetRequestExample": { + "$ref": "#/components/examples/LogStreamPostResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/LogStream" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.logStreams.read" + ] + } + ], + "summary": "Retrieve a log stream", + "tags": [ + "LogStream" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathLogStreamId" + } + ], + "put": { + "description": "Replaces the log stream object properties for a given ID.\n\nThis operation is typically used to update the configuration of a log stream.\nDepending on the type of log stream you want to update, certain properties can't be modified after the log stream is initially created.\nUse the [Retrieve the log stream schema for the schema type](/openapi/okta-management/management/schema/getlogstreamschema) request to determine which properties you can update for the specific log stream type.\nLog stream properties with the `\"writeOnce\" : true` attribute can't be updated after creation.\nYou must still specify these `writeOnce` properties in the request body with the original values in the PUT request.\n\n> **Note:** You don't have to specify properties that have both the `\"writeOnce\": true` and the `\"writeOnly\": true` attributes in the PUT request body. These property values are ignored even if you add them in the PUT request body.", + "operationId": "replaceLogStream", + "requestBody": { + "content": { + "application/json": { + "examples": { + "LogStreamPutRequestExample": { + "$ref": "#/components/examples/LogStreamPutRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/LogStreamPutSchema" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "LogStreamPostResponseExample": { + "$ref": "#/components/examples/LogStreamPutResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/LogStream" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.logStreams.manage" + ] + } + ], + "summary": "Replace a log stream", + "tags": [ + "LogStream" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/logStreams/{logStreamId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathLogStreamId" + } + ], + "post": { + "description": "Activates a log stream by `logStreamId`", + "operationId": "activateLogStream", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "LogStreamActivateResponseExample": { + "$ref": "#/components/examples/LogStreamActivateResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/LogStream" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.logStreams.manage" + ] + } + ], + "summary": "Activate a log stream", + "tags": [ + "LogStream" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/logStreams/{logStreamId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathLogStreamId" + } + ], + "post": { + "description": "Deactivates a log stream by `logStreamId`", + "operationId": "deactivateLogStream", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "LogStreamDeactivateResponseExample": { + "$ref": "#/components/examples/LogStreamDeactivateResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/LogStream" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.logStreams.manage" + ] + } + ], + "summary": "Deactivate a log stream", + "tags": [ + "LogStream" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/logs": { + "get": { + "description": "Lists all System Log events\n\nSee [System Log query](https://developer.okta.com/docs/reference/system-log-query/) for further details and examples, and [System Log filters and search](https://help.okta.com/okta_help.htm?type=oie&id=csh-syslog-filters) for common use cases.\n\nBy default, 100 System Log events are returned. If there are more events, see the [header link](https://developer.okta.com/docs/api/#link-header) for the `next` link,\nor increase the number of returned objects using the `limit` parameter.\n\n>**Note:** The value of the `clientSecret` property in the System Log is secured by a hashing function, and isn't the value used during authentication.", + "operationId": "listLogEvents", + "parameters": [ + { + "description": "Filters the lower time bound of the log events `published` property for bounded queries or persistence time for polling queries", + "in": "query", + "name": "since", + "schema": { + "default": "7 days prior to until", + "format": "ISO 8601 compliant timestamp", + "type": "string" + } + }, + { + "description": "Filters the upper time bound of the log events `published` property for bounded queries or persistence time for polling queries.", + "in": "query", + "name": "until", + "schema": { + "default": "current time", + "format": "ISO 8601 compliant timestamp", + "type": "string" + } + }, + { + "description": "Retrieves the next page of results. Okta returns a link in the HTTP Header (`rel=next`) that includes the after query parameter", + "in": "query", + "name": "after", + "schema": { + "format": "Opaque token", + "type": "string" + } + }, + { + "description": "Filter expression that filters the results. All operators except [ ] are supported. See [Filter](https://developer.okta.com/docs/api/#filter) and [Operators](https://developer.okta.com/docs/api/#operators).", + "in": "query", + "name": "filter", + "schema": { + "format": "SCIM Filter expression", + "type": "string" + } + }, + { + "description": "Filters log events results by one or more case insensitive keywords.", + "in": "query", + "name": "q", + "schema": { + "format": "URL encoded string. Max length is 40 characters per keyword, with a maximum of 10 keyword filters per query (before encoding)", + "type": "string" + } + }, + { + "description": "Sets the number of results that are returned in the response", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "format": "Integer between 0 and 1000", + "type": "integer" + } + }, + { + "description": "The order of the returned events that are sorted by the `published` property", + "in": "query", + "name": "sortOrder", + "schema": { + "default": "ASCENDING", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListLogs": { + "$ref": "#/components/examples/ListLogs" + }, + "ListLogsWithAdditionalSecurityContext": { + "$ref": "#/components/examples/ListLogsWithAdditionalSecurityContext" + }, + "LogTargetChangeDetails": { + "$ref": "#/components/examples/LogTargetChangeDetails" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/LogEvent" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.logs.read" + ] + } + ], + "summary": "List all System Log events", + "tags": [ + "SystemLog" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/mappings": { + "get": { + "description": "Lists all profile mappings in your org with [pagination](https://developer.okta.com/docs/api/#pagination). You can return a subset of profile mappings that match a supported `sourceId` and/or `targetId`.\n\nThe results are [paginated](/#pagination) according to the `limit` parameter. If there are multiple pages of results, the Link header contains a `next` link that you should treat as an opaque value (follow it, don't parse it). See [Link Header](https://developer.okta.com/docs/api/#link-header).\n\nThe response is a collection of profile mappings that include a subset of the profile mapping object's parameters. The profile mapping object describes\nthe properties mapping between an Okta user and an app user profile using [JSON Schema Draft 4](https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-04).", + "operationId": "listProfileMappings", + "parameters": [ + { + "description": "Mapping `id` that specifies the pagination cursor for the next page of mappings", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of results per page\n> **Note:** If you encounter timeout errors with larger values, reduce the limit (for example, `50`) and use pagination with the `after` parameter to retrieve the results.", + "in": "query", + "name": "limit", + "schema": { + "default": 20, + "format": "int32", + "maximum": 200, + "type": "integer" + } + }, + { + "description": "The user type or app instance ID that acts as the source of expressions in a mapping. If this parameter is included, all returned mappings have this as their `source.id`.", + "in": "query", + "name": "sourceId", + "schema": { + "type": "string" + } + }, + { + "description": "The user type or app instance ID that acts as the target of expressions in a mapping. If this parameter is included, all returned mappings have this as their `target.id`.", + "in": "query", + "name": "targetId", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "MappingList": { + "$ref": "#/components/examples/ListMappingsResponse", + "summary": "List all profile mappings response" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/ListProfileMappings" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.profileMappings.read" + ] + } + ], + "summary": "List all profile mappings", + "tags": [ + "ProfileMapping" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/mappings/{mappingId}": { + "get": { + "description": "Retrieves a single profile mapping referenced by its ID", + "operationId": "getProfileMapping", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "MappingRetrieve": { + "$ref": "#/components/examples/RetrieveMappingsResponse", + "summary": "Retrieve a single profile mapping" + } + }, + "schema": { + "$ref": "#/components/schemas/ProfileMapping" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.profileMappings.read" + ] + } + ], + "summary": "Retrieve a profile mapping", + "tags": [ + "ProfileMapping" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathMappingId" + } + ], + "post": { + "description": "Updates an existing profile mapping by adding, updating, or removing one or many property mappings", + "operationId": "updateProfileMapping", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Addpropertymapping": { + "$ref": "#/components/examples/AddMappingBody" + }, + "Removepropertymapping": { + "$ref": "#/components/examples/RemoveMappingBody" + }, + "Updatepropertymapping": { + "$ref": "#/components/examples/UpdateMappingBody" + } + }, + "schema": { + "$ref": "#/components/schemas/ProfileMappingRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Addpropertymapping": { + "$ref": "#/components/examples/AddMappingResponse", + "summary": "Update an existing profile mapping by adding one or more properties" + }, + "Removepropertymapping": { + "$ref": "#/components/examples/RemoveMappingResponse", + "summary": "Update an existing profile mapping by removing one or more properties" + }, + "Updatepropertymapping": { + "$ref": "#/components/examples/UpdateMappingResponse", + "summary": "Update an existing profile mapping by updating one or more properties" + } + }, + "schema": { + "$ref": "#/components/schemas/ProfileMapping" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.profileMappings.manage" + ] + } + ], + "summary": "Update a profile mapping", + "tags": [ + "ProfileMapping" + ], + "x-codegen-request-body-name": "profileMapping", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/meta/layouts/apps/{appName}": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppName" + } + ] + }, + "/api/v1/meta/layouts/apps/{appName}/sections/{section}/{operation}": { + "parameters": [ + { + "$ref": "#/components/parameters/pathAppName" + }, + { + "$ref": "#/components/parameters/pathSection" + }, + { + "$ref": "#/components/parameters/pathOperation" + } + ] + }, + "/api/v1/meta/schemas/apps/{appId}/default": { + "get": { + "description": "Retrieves the default schema for an app user.\n\nThe [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to apps. All users assigned to a given app use the same app user schema. Therefore, unlike the user schema operations, the app user schema operations all specify `default` and don't accept a schema ID.", + "operationId": "getApplicationUserSchema", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Response with a subset of properties for brevity": { + "$ref": "#/components/examples/DefaultAppUserSchemaResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserSchema" + } + } + }, + "description": "successful operation" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.schemas.read" + ] + } + ], + "summary": "Retrieve the default app user schema for an app", + "tags": [ + "Schema" + ], + "x-okta-iam-admin-roles": [ + "API_ACCESS_MANAGEMENT_ADMIN", + "READ_ONLY_ADMIN", + "MOBILE_ADMIN", + "ORG_ADMIN", + "APP_ADMIN" + ], + "x-okta-iam-permissions": [ + "okta.apps.read", + "okta.apps.manage" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "post": { + "description": "Updates the app user schema. This updates, adds, or removes one or more custom profile properties or the nullability of a base property in the app user schema for an app. Changing a base property's nullability (for example, the value of its `required` field) is allowed only if it is nullable in the default predefined schema for the app.\n\n> **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update.\n\nThe [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to apps. All users assigned to a given app use the same app user schema. Therefore, unlike the user schema operations, the app user schema operations all specify `default` and don't accept a schema ID.", + "operationId": "updateApplicationUserProfile", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Add a custom property to the app user schema": { + "$ref": "#/components/examples/AppUserSchemaAddRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UserSchema" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Response with a subset of properties for brevity": { + "$ref": "#/components/examples/AppUserSchemaResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserSchema" + } + } + }, + "description": "successful operation" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.schemas.manage" + ] + } + ], + "summary": "Update the app user profile schema for an app", + "tags": [ + "Schema" + ], + "x-codegen-request-body-name": "body", + "x-okta-iam-admin-roles": [ + "API_ACCESS_MANAGEMENT_ADMIN", + "APP_ADMIN" + ], + "x-okta-iam-permissions": [ + "okta.apps.manage" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/meta/schemas/group/default": { + "get": { + "description": "Retrieves the group schema\n\nThe [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify `default` and don't accept a schema ID.", + "operationId": "getGroupSchema", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Response with a subset of properties for brevity": { + "$ref": "#/components/examples/GroupSchemaResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupSchema" + } + } + }, + "description": "successful operation" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.schemas.read" + ] + } + ], + "summary": "Retrieve the default group schema", + "tags": [ + "Schema" + ], + "x-okta-iam-admin-roles": [ + "API_ACCESS_MANAGEMENT_ADMIN", + "APP_ADMIN", + "ORG_ADMIN" + ], + "x-okta-iam-permissions": [ + "okta.apps.manage" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Updates the group profile schema. This updates, adds, or removes one or more custom profile properties in a group schema. Currently Okta does not support changing base group profile properties.\n\n> **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update.\n\nThe [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify `default` and don't accept a schema ID.", + "operationId": "updateGroupSchema", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Add a custom property to the group schema": { + "$ref": "#/components/examples/GroupSchemaAddRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupSchema" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "Response with a subset of properties for brevity": { + "$ref": "#/components/examples/GroupSchemaResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/GroupSchema" + } + } + }, + "description": "successful operation" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.schemas.manage" + ] + } + ], + "summary": "Update the group profile schema", + "tags": [ + "Schema" + ], + "x-okta-iam-admin-roles": [ + "API_ACCESS_MANAGEMENT_ADMIN", + "APP_ADMIN", + "ORG_ADMIN" + ], + "x-okta-iam-permissions": [ + "okta.apps.manage" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/meta/schemas/logStream": { + "get": { + "description": "Lists the schema for all log stream types visible for this org", + "operationId": "listLogStreamSchemas", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "All log stream schemas for your org": { + "$ref": "#/components/examples/LogStreamSchemaList" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/LogStreamSchema" + }, + "type": "array" + } + } + }, + "description": "successful operation" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.logStreams.read" + ] + } + ], + "summary": "List the log stream schemas", + "tags": [ + "Schema" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/meta/schemas/logStream/{logStreamType}": { + "get": { + "description": "Retrieves the schema for a log stream type. The `logStreamType` element in the URL specifies the log stream type, which is either `aws_eventbridge` or `splunk_cloud_logstreaming`. Use the `aws_eventbridge` literal to retrieve the AWS EventBridge type schema, and use the `splunk_cloud_logstreaming` literal retrieve the Splunk Cloud type schema.", + "operationId": "getLogStreamSchema", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Schema for type `aws_eventbridge`": { + "$ref": "#/components/examples/LogStreamSchemaAws" + }, + "Schema for type `splunk_cloud_logstreaming`": { + "$ref": "#/components/examples/LogStreamSchemaSplunk" + } + }, + "schema": { + "$ref": "#/components/schemas/LogStreamSchema" + } + } + }, + "description": "successful operation" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.logStreams.read" + ] + } + ], + "summary": "Retrieve the log stream schema for the schema type", + "tags": [ + "Schema" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathLogStreamType" + } + ] + }, + "/api/v1/meta/schemas/user/linkedObjects": { + "get": { + "description": "Lists all Linked Object definitions", + "operationId": "listLinkedObjectDefinitions", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListLinkedObjectsEx": { + "$ref": "#/components/examples/ListLinkedObjects" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/LinkedObject" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.linkedObjects.read" + ] + } + ], + "summary": "List all linked object definitions", + "tags": [ + "LinkedObject" + ], + "x-okta-iam-admin-roles": [ + "API_ACCESS_MANAGEMENT_ADMIN", + "APP_ADMIN", + "ORG_ADMIN" + ], + "x-okta-iam-permissions": [ + "okta.apps.manage" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a Linked Object definition", + "operationId": "createLinkedObjectDefinition", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateLinkedObjectRequestEx": { + "$ref": "#/components/examples/CreateLinkedObjectRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/LinkedObject" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "CreateLinkedObjectResponseEx": { + "$ref": "#/components/examples/CreateLinkedObjectResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/LinkedObject" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "409": { + "content": { + "application/json": { + "examples": { + "ErrorInvalidLinkedObjectDefEx": { + "$ref": "#/components/examples/ErrorInvalidLinkedObjectDef" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Conflict" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.linkedObjects.manage" + ] + } + ], + "summary": "Create a linked object definition", + "tags": [ + "LinkedObject" + ], + "x-codegen-request-body-name": "linkedObject", + "x-okta-iam-admin-roles": [ + "API_ACCESS_MANAGEMENT_ADMIN", + "APP_ADMIN", + "ORG_ADMIN" + ], + "x-okta-iam-permissions": [ + "okta.apps.manage" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}": { + "delete": { + "description": "Deletes the Linked Object definition specified by either the `primary` or `associated` name. The entire definition is removed, regardless of which name that you specify.", + "operationId": "deleteLinkedObjectDefinition", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.linkedObjects.manage" + ] + } + ], + "summary": "Delete a linked object definition", + "tags": [ + "LinkedObject" + ], + "x-okta-iam-admin-roles": [ + "API_ACCESS_MANAGEMENT_ADMIN", + "APP_ADMIN", + "ORG_ADMIN" + ], + "x-okta-iam-permissions": [ + "okta.apps.manage" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a Linked Object definition", + "operationId": "getLinkedObjectDefinition", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CreateLinkedObjectResponseEx": { + "$ref": "#/components/examples/CreateLinkedObjectResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/LinkedObject" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.linkedObjects.read" + ] + } + ], + "summary": "Retrieve a linked object definition", + "tags": [ + "LinkedObject" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathLinkedObjectName" + } + ] + }, + "/api/v1/meta/schemas/user/{schemaId}": { + "get": { + "description": "Retrieves the schema for a user type", + "operationId": "getUserSchema", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Response using default with a subset of properties for brevity": { + "$ref": "#/components/examples/UserSchemaDefaultResponse" + }, + "Response with a subset of properties for brevity": { + "$ref": "#/components/examples/UserSchemaResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserSchema" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.schemas.read" + ] + } + ], + "summary": "Retrieve a user schema", + "tags": [ + "Schema" + ], + "x-okta-iam-admin-roles": [ + "API_ACCESS_MANAGEMENT_ADMIN", + "APP_ADMIN", + "ORG_ADMIN" + ], + "x-okta-iam-permissions": [ + "okta.apps.manage" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathSchemaId" + } + ], + "post": { + "description": "Updates a user schema. Use this request to update, add, or remove one or more profile properties in a user schema. If you specify `default` for the `schemaId`, updates will apply to the default user type.\n\nUnlike custom user profile properties, limited changes are allowed to base user profile properties (permissions, nullability of the `firstName` and `lastName` properties, or pattern for `login`).\nYou can't remove a property from the default schema if it's being referenced as a [`matchAttribute`](/openapi/okta-management/management/tags/identityprovider/other/createidentityprovider#other/createidentityprovider/t=request&path=policy/subject/matchattribute) in `SAML2` IdPs.\nCurrently, all validation of SAML assertions are only performed against the default user type.\n\n> **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update.", + "operationId": "updateUserProfile", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Add a custom property to the user schema": { + "$ref": "#/components/examples/UserSchemaAddRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UserSchema" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Response with a subset of properties for brevity": { + "$ref": "#/components/examples/UserSchemaResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserSchema" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.schemas.manage" + ] + } + ], + "summary": "Update a user schema", + "tags": [ + "Schema" + ], + "x-codegen-request-body-name": "userSchema", + "x-okta-iam-admin-roles": [ + "API_ACCESS_MANAGEMENT_ADMIN", + "ORG_ADMIN", + "APP_ADMIN" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/meta/types/user": { + "get": { + "description": "Lists all user types in your org", + "operationId": "listUserTypes", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListsAllUserTypes": { + "$ref": "#/components/examples/ListsAllUserTypes" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/UserType" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.userTypes.read" + ] + } + ], + "summary": "List all user types", + "tags": [ + "UserType" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new user type. Okta automatically creates a `default` user type for your org. You may add up to nine additional user types.\n> **Note**: New user types are based on the current default schema template. Modifications to this schema do not automatically propagate to previously created user types.", + "operationId": "createUserType", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateUserRequest": { + "$ref": "#/components/examples/CreateUserRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UserType" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CreateUserResponse": { + "$ref": "#/components/examples/CreateUserResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserType" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.userTypes.manage" + ] + } + ], + "summary": "Create a user type", + "tags": [ + "UserType" + ], + "x-codegen-request-body-name": "userType", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/meta/types/user/{typeId}": { + "delete": { + "description": "Deletes a user type permanently.\n> **Note**: You can't delete the default user type or a user type that is currently assigned to users.", + "operationId": "deleteUserType", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.userTypes.manage" + ] + } + ], + "summary": "Delete a user type", + "tags": [ + "UserType" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a user type by ID. Use `default` to fetch the default user type.", + "operationId": "getUserType", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GetUserResponse": { + "$ref": "#/components/examples/GetUserResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserType" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.userTypes.read" + ] + } + ], + "summary": "Retrieve a user type", + "tags": [ + "UserType" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathTypeId" + } + ], + "post": { + "description": "Updates an existing user type. This operation is a partial update.\n> **Note**: You can only update the `displayName` and `description` elements. The `name` of an existing user type can't be changed.", + "operationId": "updateUserType", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UpdateUserTypePostRequest": { + "$ref": "#/components/examples/UpdateUserTypePostRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UserTypePostRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UpdateUserTypePutRequest": { + "$ref": "#/components/examples/UpdateUserTypePostResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserType" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.userTypes.manage" + ] + } + ], + "summary": "Update a user type", + "tags": [ + "UserType" + ], + "x-codegen-request-body-name": "userType", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces an existing user type. This operation is a full update.\n> **Note**: The `name` of an existing user type can't be changed, but must be part of the request body. You can only replace the `displayName` and `description` elements.", + "operationId": "replaceUserType", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ReplaceUserTypePutRequest": { + "$ref": "#/components/examples/ReplaceUserTypePutRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UserTypePutRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ReplaceUserTypePutResponse": { + "$ref": "#/components/examples/ReplaceUserTypePutResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserType" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.userTypes.manage" + ] + } + ], + "summary": "Replace a user type", + "tags": [ + "UserType" + ], + "x-codegen-request-body-name": "userType", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/meta/uischemas": { + "get": { + "description": "Lists all UI Schemas in your org", + "operationId": "listUISchemas", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UIISchemaList": { + "$ref": "#/components/examples/ListUISchemaResponse", + "summary": "Lists all UI schemas response" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/UISchemasResponseObject" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.uischemas.read" + ] + } + ], + "summary": "List all UI schemas", + "tags": [ + "UISchema" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "post": { + "description": "Creates an input for an enrollment form", + "operationId": "createUISchema", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UISchemaCreate": { + "$ref": "#/components/examples/CreateUISchemaBody" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateUISchema" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UISchemaCreate": { + "$ref": "#/components/examples/CreateUISchemaResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UISchemasResponseObject" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.uischemas.manage" + ] + } + ], + "summary": "Create a UI schema", + "tags": [ + "UISchema" + ], + "x-codegen-request-body-name": "uischemabody", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/meta/uischemas/{id}": { + "delete": { + "description": "Deletes a UI Schema by `id`", + "operationId": "deleteUISchemas", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.uischemas.manage" + ] + } + ], + "summary": "Delete a UI schema", + "tags": [ + "UISchema" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "get": { + "description": "Retrieves a UI Schema by `id`", + "operationId": "getUISchema", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UISchemaRetrieve": { + "$ref": "#/components/examples/RetrieveUISchemaResponse", + "summary": "Retrieves a UI schema response" + } + }, + "schema": { + "$ref": "#/components/schemas/UISchemasResponseObject" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.uischemas.read" + ] + } + ], + "summary": "Retrieve a UI schema", + "tags": [ + "UISchema" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/UISchemaId" + } + ], + "put": { + "description": "Replaces a UI Schema by `id`", + "operationId": "replaceUISchemas", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UISchemaPUT": { + "$ref": "#/components/examples/CreateUISchemaBody" + } + }, + "schema": { + "$ref": "#/components/schemas/UpdateUISchema" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UISchemaUpdate": { + "$ref": "#/components/examples/CreateUISchemaResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UISchemasResponseObject" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.uischemas.manage" + ] + } + ], + "summary": "Replace a UI schema", + "tags": [ + "UISchema" + ], + "x-codegen-request-body-name": "updateUISchemaBody", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/org": { + "get": { + "description": "Retrieves the Org General Settings", + "operationId": "getOrgSettings", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "example-1": { + "$ref": "#/components/examples/OrgSettingResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgSetting" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "Retrieve the Org general settings", + "tags": [ + "OrgSettingGeneral" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Updates partial Org General Settings", + "operationId": "updateOrgSettings", + "requestBody": { + "content": { + "application/json": { + "examples": { + "example-1": { + "$ref": "#/components/examples/UpdateOrgSettingEx" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgSetting" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "example-1": { + "$ref": "#/components/examples/OrgSettingResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgSetting" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Update the Org general settings", + "tags": [ + "OrgSettingGeneral" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces the Org General Settings for your Okta org", + "operationId": "replaceOrgSettings", + "requestBody": { + "content": { + "application/json": { + "examples": { + "example-1": { + "$ref": "#/components/examples/UpdateOrgSettingEx" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgSetting" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "example-1": { + "$ref": "#/components/examples/OrgSettingResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgSetting" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Replace the Org general settings", + "tags": [ + "OrgSettingGeneral" + ], + "x-codegen-request-body-name": "orgSetting", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/captcha": { + "delete": { + "description": "Deletes the CAPTCHA settings object for your organization", + "operationId": "deleteOrgCaptchaSettings", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.captchas.manage" + ] + } + ], + "summary": "Delete the org-wide CAPTCHA settings", + "tags": [ + "CAPTCHA" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "get": { + "description": "Retrieves the CAPTCHA settings object for your organization\n> **Note**: If the current organization hasn't configured CAPTCHA Settings, the request returns an empty object.", + "operationId": "getOrgCaptchaSettings", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "configured": { + "$ref": "#/components/examples/OrgCAPTCHASettingsConfigured" + }, + "empty": { + "$ref": "#/components/examples/OrgCAPTCHASettingsEmpty" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgCAPTCHASettings" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.captchas.read" + ] + } + ], + "summary": "Retrieve the org-wide CAPTCHA settings", + "tags": [ + "CAPTCHA" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "put": { + "description": "Replaces the CAPTCHA settings object for your organization\n> **Note**: You can disable CAPTCHA for your organization by setting `captchaId` and `enabledPages` to `null`.", + "operationId": "replacesOrgCaptchaSettings", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Disable": { + "$ref": "#/components/examples/OrgCAPTCHASettingsDisable" + }, + "Update": { + "$ref": "#/components/examples/OrgCAPTCHASettingsUpdate" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgCAPTCHASettings" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Disable": { + "$ref": "#/components/examples/OrgCAPTCHASettingsDisabled" + }, + "Update": { + "$ref": "#/components/examples/OrgCAPTCHASettingsUpdated" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgCAPTCHASettings" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "examples": { + "NoDisable": { + "$ref": "#/components/examples/ErrorCAPTCHAOrgWideSettingNull" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request", + "headers": {} + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.captchas.manage" + ] + } + ], + "summary": "Replace the org-wide CAPTCHA settings", + "tags": [ + "CAPTCHA" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/org/contacts": { + "get": { + "description": "Lists all org contact types for your Okta org", + "operationId": "listOrgContactTypes", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "orgContactTypeEx": { + "$ref": "#/components/examples/orgContactTypeResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OrgContactTypeObj" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "List all org contact types", + "tags": [ + "OrgSettingContact" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/contacts/{contactType}": { + "get": { + "description": "Retrieves the ID and the user resource associated with the specified contact type", + "operationId": "getOrgContactUser", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "contactTypeUserEx": { + "$ref": "#/components/examples/orgContactUserResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgContactUser" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "Retrieve the contact type user", + "tags": [ + "OrgSettingContact" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathContactType" + } + ], + "put": { + "description": "Replaces the user associated with the specified contact type", + "operationId": "replaceOrgContactUser", + "requestBody": { + "content": { + "application/json": { + "examples": { + "contactTypeUserEx": { + "summary": "Contact user", + "value": { + "userId": "00ux3u0ujW1r5AfZC1d7" + } + } + }, + "schema": { + "$ref": "#/components/schemas/OrgContactUser" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "contactTypeUserEx": { + "$ref": "#/components/examples/orgContactUserResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgContactUser" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Replace the contact type user", + "tags": [ + "OrgSettingContact" + ], + "x-codegen-request-body-name": "orgContactUser", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/email/bounces/remove-list": { + "post": { + "description": "Removes emails from an email service bounce list.\n\nThe emails submitted in this operation are removed from the bounce list by an asynchronous job.\nAny email address that passes validation is accepted for the removal process, even if there are other email addresses in the request that failed validation.\n\n> **Note:** If there are validation errors for all email addresses, a `200 OK` HTTP status is still returned.\n", + "operationId": "bulkRemoveEmailAddressBounces", + "requestBody": { + "content": { + "application/json": { + "examples": { + "example-1": { + "summary": "Request example", + "value": { + "emailAddresses": [ + "name@company.com", + "unknown.email@okta.com", + "name@okta@com" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/BouncesRemoveListObj" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "example-1": { + "summary": "Response example", + "value": { + "errors": [ + { + "emailAddress": "unknown.email@okta.com", + "reason": "This email address does not belong to any user in your organization." + }, + { + "emailAddress": "name@okta@com", + "reason": "Invalid email address. The provided email address failed validation against RFC 3696." + } + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/BouncesRemoveListResult" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Remove bounced emails", + "tags": [ + "EmailCustomization" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/factors/yubikey_token/tokens": { + "get": { + "description": "Lists all YubiKey OTP tokens", + "operationId": "listYubikeyOtpTokens", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListYubikeyOptTokensResponse": { + "$ref": "#/components/examples/ListYubikeyOptTokensResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/UserFactorYubikeyOtpToken" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all YubiKey OTP tokens", + "tags": [ + "UserFactor" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "description": "Specifies the pagination cursor for the next page of tokens", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Embeds the [user](/openapi/okta-management/management/tags/user) resource if the YubiKey token is assigned to a user and `expand` is set to `user`", + "in": "query", + "name": "expand", + "schema": { + "type": "string" + } + }, + { + "description": "The expression used to filter tokens", + "in": "query", + "name": "filter", + "schema": { + "enum": [ + "profile.email", + "profile.serial", + "activated", + "user.id", + "created", + "status", + "lastVerified" + ], + "type": "string" + } + }, + { + "description": "Returns tokens in a CSV to download instead of in the response. When you use this query parameter, the `limit` default changes to 1000.", + "in": "query", + "name": "forDownload", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Specifies the number of results per page", + "in": "query", + "name": "limit", + "schema": { + "default": 20, + "maximum": 200, + "type": "integer" + } + }, + { + "description": "The value of how the tokens are sorted", + "in": "query", + "name": "sortBy", + "schema": { + "enum": [ + "profile.email", + "profile.serial", + "activated", + "user.id", + "created", + "status", + "lastVerified" + ], + "type": "string" + } + }, + { + "description": "Specifies the sort order, either `ASC` or `DESC`", + "in": "query", + "name": "sortOrder", + "schema": { + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + } + } + ], + "post": { + "description": "Uploads a seed for a user to enroll a YubiKey OTP", + "operationId": "uploadYubikeyOtpTokenSeed", + "requestBody": { + "content": { + "application/json": { + "examples": { + "uploadYubikeyOtpSeedRequest": { + "$ref": "#/components/examples/UploadYubikeyTokenSeedRequest" + } + }, + "schema": { + "properties": { + "aesKey": { + "description": "The cryptographic key used in the AES (Advanced Encryption Standard) algorithm to encrypt and decrypt the YubiKey OTP", + "type": "string" + }, + "privateId": { + "description": "The YubiKey's private ID", + "type": "string" + }, + "publicId": { + "description": "The YubiKey's public ID", + "type": "string" + }, + "serialNumber": { + "description": "The unique identifier assigned to each YubiKey device", + "type": "string" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "yubikeyToken": { + "$ref": "#/components/examples/UploadYubikeyTokenSeedResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactorYubikeyOtpToken" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Upload a YubiKey OTP seed", + "tags": [ + "UserFactor" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/factors/yubikey_token/tokens/{tokenId}": { + "get": { + "description": "Retrieves the specified YubiKey OTP token by `id`", + "operationId": "getYubikeyOtpTokenById", + "parameters": [ + { + "description": "The YubiKey OTP token ID", + "in": "path", + "name": "tokenId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Token": { + "$ref": "#/components/examples/GetYubikeyOptTokenResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactorYubikeyOtpToken" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "Retrieve a YubiKey OTP token", + "tags": [ + "UserFactor" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/yubikeyTokenId" + } + ] + }, + "/api/v1/org/orgSettings/thirdPartyAdminSetting": { + "get": { + "description": "Retrieves the third-party admin setting. See [Configure third-party administrators](https://help.okta.com/okta_help.htm?type=oie&id=csh_admin-third) in the Okta product documentation.", + "operationId": "getThirdPartyAdminSetting", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ThirdPartyAdminSetting" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "Retrieve the org third-party admin setting", + "tags": [ + "OrgSettingAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Updates the third-party admin setting.\nThis setting allows third-party admins to perform administrative actions in the Admin Console, but they can't do any of the following:\n * Receive Okta admin email notifications\n * Contact Okta support\n * Sign in to the Okta Help Center\n\nSee [Configure third-party administrators](https://help.okta.com/okta_help.htm?type=oie&id=csh_admin-third) in the Okta product documentation.\n", + "operationId": "updateThirdPartyAdminSetting", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ThirdPartyAdminSetting" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ThirdPartyAdminSetting" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Update the org third-party admin setting", + "tags": [ + "OrgSettingAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/preferences": { + "get": { + "description": "Retrieves preferences of your Okta org", + "operationId": "getOrgPreferences", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "retrieveOrgPrefEx": { + "$ref": "#/components/examples/orgShowFooterPrefResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgPreferences" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "Retrieve the org preferences", + "tags": [ + "OrgSettingCustomization" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/preferences/hideEndUserFooter": { + "post": { + "description": "Sets the preference to hide the Okta End-User Dashboard footer for all end users of your org", + "operationId": "setOrgHideOktaUIFooter", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "hideOrgPrefEx": { + "$ref": "#/components/examples/orgHideFooterPrefResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgPreferences" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Set the hide dashboard footer preference", + "tags": [ + "OrgSettingCustomization" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/preferences/showEndUserFooter": { + "post": { + "description": "Sets the preference to show the Okta UI footer for all end users of your org", + "operationId": "setOrgShowOktaUIFooter", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "showOrgPrefEx": { + "$ref": "#/components/examples/orgShowFooterPrefResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgPreferences" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Set the show dashboard footer preference", + "tags": [ + "OrgSettingCustomization" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/aerial": { + "get": { + "description": "Retrieves the Okta Aerial consent grant details for your Org. Returns a 404 Not Found error if no consent has been granted.", + "operationId": "getAerialConsent", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "example-read-grant-response": { + "$ref": "#/components/examples/AerialConsentDetails" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgAerialConsentDetails" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "examples": { + "example-no-already-present-response": { + "$ref": "#/components/examples/AerialGrantAlreadyPresentErrorResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Can't complete request due to errors" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "content": { + "application/json": { + "examples": { + "example-no-grant-found-response": { + "$ref": "#/components/examples/AerialGrantNotFoundResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Consent hasn't been given and there are no grants to any Aerial Accounts" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Retrieve Okta Aerial consent for your org", + "tags": [ + "OrgSettingSupport" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/aerial/grant": { + "post": { + "description": "Grants an Okta Aerial account consent to manage your org. If the org is a child org, consent is taken from the parent org. Grant calls directly to the child are not allowed.", + "operationId": "grantAerialConsent", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "examples": { + "example-grant-call": { + "description": "Request body to grant an Okta Aerial account access to your Org", + "value": { + "accountId": "0200bs0617vvhv2v675mch1cukp" + } + } + }, + "schema": { + "$ref": "#/components/schemas/OrgAerialConsent" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "example-grant-success-response": { + "$ref": "#/components/examples/AerialConsentDetails" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgAerialConsentDetails" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "examples": { + "example-invalid-account-id": { + "$ref": "#/components/examples/AerialConsentInvalidAccountIdResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Can't complete request due to errors" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Grant Okta Aerial access to your org", + "tags": [ + "OrgSettingSupport" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/aerial/revoke": { + "post": { + "description": "Revokes access of an Okta Aerial account to your Org. The revoke operation will fail if the org has already been added to an Aerial account.", + "operationId": "revokeAerialConsent", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "examples": { + "example-revoke-request": { + "description": "Request body for revoking an Okta Aerial account", + "value": { + "accountId": "0200bs0617vvhv2v675mch1cukp" + } + } + }, + "schema": { + "$ref": "#/components/schemas/OrgAerialConsent" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrgAerialConsentRevoked" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "examples": { + "example-org-is-linked": { + "$ref": "#/components/examples/AerialConsentOrgAlreadyLinkedResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Can't complete request due to errors" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Revoke Okta Aerial access to your org", + "tags": [ + "OrgSettingSupport" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/oktaCommunication": { + "get": { + "description": "Retrieves Okta Communication Settings of your org", + "operationId": "getOktaCommunicationSettings", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "retrieveOktaCommSettingsEx": { + "$ref": "#/components/examples/orgCommunicationOptOutResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgOktaCommunicationSetting" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "Retrieve the Okta communication settings", + "tags": [ + "OrgSettingCommunication" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/oktaCommunication/optIn": { + "post": { + "description": "Opts in all users of this org to Okta communication emails", + "operationId": "optInUsersToOktaCommunicationEmails", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "optInOktaCommSettingsEx": { + "$ref": "#/components/examples/orgCommunicationOptInResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgOktaCommunicationSetting" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Opt in to Okta user communication emails", + "tags": [ + "OrgSettingCommunication" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/oktaCommunication/optOut": { + "post": { + "description": "Opts out all users of this org from Okta communication emails", + "operationId": "optOutUsersFromOktaCommunicationEmails", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "optOutOktaCommSettingsEx": { + "$ref": "#/components/examples/orgCommunicationOptOutResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgOktaCommunicationSetting" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Opt out of Okta user communication emails", + "tags": [ + "OrgSettingCommunication" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/oktaSupport": { + "get": { + "description": "Retrieves Okta Support Settings for your org", + "operationId": "getOrgOktaSupportSettings", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OktaSupportWithCaseNumberEx": { + "$ref": "#/components/examples/orgSupportSettingsWithCaseNumberResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OrgOktaSupportSettingsObj" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "Retrieve the Okta Support settings", + "tags": [ + "OrgSettingSupport" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/oktaSupport/cases": { + "get": { + "description": "Lists all Okta Support cases that the requesting principal has permission to view", + "operationId": "listOktaSupportCases", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OktaSupportCasesEx": { + "$ref": "#/components/examples/OktaSupportCases" + } + }, + "schema": { + "$ref": "#/components/schemas/OktaSupportCases" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "List all Okta Support cases", + "tags": [ + "OrgSettingSupport" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/oktaSupport/cases/{caseNumber}": { + "parameters": [ + { + "$ref": "#/components/parameters/caseNumber" + } + ], + "patch": { + "description": "Updates access to the org for an Okta Support case:\n\n* You can enable, disable, or extend access to your org for an Okta Support case.\n\n* You can approve Okta Support access to your org for self-assigned cases. A self-assigned case is created and assigned by the same Okta Support user.", + "operationId": "updateOktaSupportCase", + "requestBody": { + "content": { + "application/json": { + "examples": { + "AllowOktaSupportAccessStatus": { + "$ref": "#/components/examples/AllowOktaSupportAccessStatusRequest" + }, + "AllowSelfAssigned": { + "$ref": "#/components/examples/AllowSelfAssignedRequest" + }, + "ExtendOktaSupportAccessStatus": { + "$ref": "#/components/examples/ExtendOktaSupportAccessStatusRequest" + }, + "RevokeOktaSupportAccessStatus": { + "$ref": "#/components/examples/RevokeOktaSupportAccessStatusRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/OktaSupportCase" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AllowOktaSupportAccessStatus": { + "$ref": "#/components/examples/AllowOktaSupportAccessStatus" + }, + "AllowSelfAssigned": { + "$ref": "#/components/examples/AllowSelfAssigned" + }, + "ExtendOktaSupportAccessStatus": { + "$ref": "#/components/examples/ExtendOktaSupportAccessStatus" + }, + "RevokeOktaSupportAccessStatus": { + "$ref": "#/components/examples/RevokeOktaSupportAccessStatus" + } + }, + "schema": { + "$ref": "#/components/schemas/OktaSupportCase" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Update an Okta Support case", + "tags": [ + "OrgSettingSupport" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-iam-permissions": [ + "okta.support.cases.manage" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/oktaSupport/extend": { + "post": { + "deprecated": true, + "description": "Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time.\n\n> **Note:** This resource is deprecated. Use the [Update an Okta Support case](/openapi/okta-management/management/tags/orgsettingsupport/other/updateoktasupportcase) resource to extend Okta Support access for a support case.\n> For the corresponding Okta Admin Console feature, see [Give access to Okta Support](https://help.okta.com/okta_help.htm?type=oie&id=settings-support-access).", + "operationId": "extendOktaSupport", + "parameters": [], + "responses": { + "301": { + "description": "Moved Permanently" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Extend Okta Support access", + "tags": [ + "OrgSettingSupport" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/oktaSupport/grant": { + "post": { + "deprecated": true, + "description": "Grants Okta Support temporary access to your org as an administrator for eight hours\n\n> **Note:** This resource is deprecated. Use the [Update an Okta Support case](/openapi/okta-management/management/tags/orgsettingsupport/other/updateoktasupportcase) resource to grant Okta Support access for a support case.\n> For the corresponding Okta Admin Console feature, see [Give access to Okta Support](https://help.okta.com/okta_help.htm?type=oie&id=settings-support-access).", + "operationId": "grantOktaSupport", + "parameters": [], + "responses": { + "301": { + "description": "Moved Permanently" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Grant Okta Support access", + "tags": [ + "OrgSettingSupport" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/privacy/oktaSupport/revoke": { + "post": { + "deprecated": true, + "description": "Revokes Okta Support access to your org\n\n> **Note:** This resource is deprecated. Use the [Update an Okta Support case](/openapi/okta-management/management/tags/orgsettingsupport/other/updateoktasupportcase) resource to revoke Okta Support access for a support case.\n> For the corresponding Okta Admin Console feature, see [Give access to Okta Support](https://help.okta.com/okta_help.htm?type=oie&id=settings-support-access).", + "operationId": "revokeOktaSupport", + "parameters": [], + "responses": { + "301": { + "description": "Moved Permanently" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Revoke Okta Support access", + "tags": [ + "OrgSettingSupport" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/settings/autoAssignAdminAppSetting": { + "get": { + "description": "Retrieves the org setting to automatically assign the Okta Admin Console when an admin role is assigned", + "operationId": "getAutoAssignAdminAppSetting", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoAssignAdminAppSetting" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "Retrieve the Okta Admin Console assignment setting", + "tags": [ + "OrgSettingAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Updates the org setting to automatically assign the Okta Admin Console when an admin role is assigned\n\n> **Note:** This setting doesn't apply to the `SUPER_ADMIN` role.\n> When you assign the `SUPER_ADMIN` role to a user, the Admin Console is always assigned to the user regardless of the `autoAssignAdminAppSetting` setting.", + "operationId": "updateAutoAssignAdminAppSetting", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoAssignAdminAppSetting" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoAssignAdminAppSetting" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Update the Okta Admin Console assignment setting", + "tags": [ + "OrgSettingAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/org/settings/clientPrivilegesSetting": { + "get": { + "description": "Retrieves the org setting to assign the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) to new public client apps", + "operationId": "getClientPrivilegesSetting", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientPrivilegesSetting" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "Retrieve the default public client app role setting", + "tags": [ + "OrgSettingAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Assigns the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) as the default role for new public client apps", + "operationId": "assignClientPrivilegesSetting", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientPrivilegesSetting" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientPrivilegesSetting" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Assign the default public client app role setting", + "tags": [ + "OrgSettingAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/orgs": { + "post": { + "description": "Creates an org (child org) that has the same features as the current requesting org (parent org).\nA child org inherits any new features added to the parent org, but new features added to the child org aren't propagated back to the parent org.\n> **Notes:**\n> * Some features associated with products, such as Atspoke, Workflows, and Okta Identity Governance, aren't propagated to the child org.\n> * Wait at least 30 seconds after a 201-Created response before you make API requests to the new child org.\n> * For rate limits, see [Org creation rate limits](https://developer.okta.com/docs/reference/rl-additional-limits/#org-creation-rate-limits).", + "operationId": "createChildOrg", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateChildOrg": { + "$ref": "#/components/examples/CreateChildOrgRequestEx" + } + }, + "schema": { + "$ref": "#/components/schemas/ChildOrg" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "CreateChildOrg": { + "$ref": "#/components/examples/CreateChildOrgResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/ChildOrg" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + }, + "500": { + "$ref": "#/components/responses/ErrorInternalServer500" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Create an org", + "tags": [ + "OrgCreator" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/policies": { + "get": { + "description": "Lists all policies with the specified type", + "operationId": "listPolicies", + "parameters": [ + { + "description": "Specifies the type of policy to return", + "in": "query", + "name": "type", + "required": true, + "schema": { + "$ref": "#/components/schemas/PolicyType" + } + }, + { + "description": "Refines the query by the `status` of the policy - `ACTIVE` or `INACTIVE`", + "in": "query", + "name": "status", + "schema": { + "type": "string" + } + }, + { + "description": "Refines the query by policy name prefix (startWith method) passed in as `q=string`", + "in": "query", + "name": "q", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "expand", + "schema": { + "default": "", + "type": "string" + } + }, + { + "description": "Refines the query by sorting on the policy `name` in ascending order", + "in": "query", + "name": "sortBy", + "schema": { + "type": "string" + } + }, + { + "description": "Defines the number of policies returned, see [Pagination](https://developer.okta.com/docs/api/#pagination)", + "in": "query", + "name": "limit", + "schema": { + "type": "string" + } + }, + { + "description": "Reference to the associated authorization server", + "in": "query", + "name": "resourceId", + "schema": { + "type": "string" + } + }, + { + "description": "End page cursor for pagination, see [Pagination](https://developer.okta.com/docs/api/#pagination)", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "access-policy": { + "$ref": "#/components/examples/list-access-policy-response" + }, + "device-signal-collection-policy": { + "$ref": "#/components/examples/list-device-signal-collection-policy-response" + }, + "entity-risk-policy": { + "$ref": "#/components/examples/list-entity-risk-policy-response" + }, + "identity-claim-sourcing-policy": { + "$ref": "#/components/examples/list-identity-claim-sourcing-policy-response" + }, + "idp-discovery": { + "$ref": "#/components/examples/list-idp-discovery-policy-response" + }, + "mfa-enroll": { + "$ref": "#/components/examples/list-mfa-enroll-policy-response" + }, + "mfa-enroll-auto-enroll-disabled": { + "$ref": "#/components/examples/list-mfa-enroll-policy-auto-enroll-disabled-response" + }, + "mfa-enroll-grace-period": { + "$ref": "#/components/examples/list-mfa-enroll-policy-with-grace-period-response" + }, + "okta-sign-on-policy": { + "$ref": "#/components/examples/list-okta-sign-on-policy-response" + }, + "password": { + "$ref": "#/components/examples/list-password-policy-response" + }, + "passwordWithBreachedProtection": { + "$ref": "#/components/examples/list-password-policy-with-breached-protection-response" + }, + "post-auth-session-policy": { + "$ref": "#/components/examples/list-post-auth-session-policy-response" + }, + "profile-enrollment": { + "$ref": "#/components/examples/list-profile-enrollment-policy-response" + }, + "session-violation-detection-policy": { + "$ref": "#/components/examples/list-session-violation-detection-policy-response" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/Policy" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.read" + ] + } + ], + "summary": "List all policies", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a policy. There are many types of policies that you can create. See [Policies](https://developer.okta.com/docs/concepts/policies/) for an overview of the types of policies available and links to more indepth information.", + "operationId": "createPolicy", + "parameters": [ + { + "description": "This query parameter is only valid for Classic Engine orgs.", + "in": "query", + "name": "activate", + "schema": { + "default": true, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateOrUpdatePolicy" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "access-policy": { + "$ref": "#/components/examples/create-access-policy-response" + }, + "device-signal-collection-policy": { + "$ref": "#/components/examples/device-signal-collection-policy-response" + }, + "idp-discovery": { + "$ref": "#/components/examples/idp-discovery-policy-response" + }, + "mfa-enroll": { + "$ref": "#/components/examples/mfa-enroll-policy-with-grace-period-response" + }, + "mfa-enroll-auto-enroll-disabled": { + "$ref": "#/components/examples/mfa-enroll-policy-auto-enroll-disabled-response" + }, + "okta-sign-on-policy": { + "$ref": "#/components/examples/create-okta-sign-on-policy-response" + }, + "password": { + "$ref": "#/components/examples/password-policy-response" + }, + "passwordWithBreachedProtection": { + "$ref": "#/components/examples/password-policy-with-breached-protection-response" + }, + "profile-enrollment": { + "$ref": "#/components/examples/profile-enrollment-policy-response" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateOrUpdatePolicy" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Create a policy", + "tags": [ + "Policy" + ], + "x-codegen-request-body-name": "policy", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/policies/simulate": { + "parameters": [ + { + "$ref": "#/components/parameters/simulateParameter" + } + ], + "post": { + "description": "Creates a policy or policy rule simulation. The access simulation evaluates policy and policy rules based on the existing policy rule configuration.\nThe evaluation result simulates what the real-world authentication flow is and what policy rules have been applied or matched to the authentication flow.", + "operationId": "createPolicySimulation", + "requestBody": { + "content": { + "application/json": { + "examples": { + "SimulatePolicy": { + "$ref": "#/components/examples/SimulatePolicyBody" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/SimulatePolicyBody" + }, + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "SimulatePolicy": { + "$ref": "#/components/examples/SimulatePolicyResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/SimulatePolicyResponse" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.read" + ] + } + ], + "summary": "Create a policy simulation", + "tags": [ + "Policy" + ], + "x-codegen-request-body-name": "simulatePolicy", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/policies/{policyId}": { + "delete": { + "description": "Deletes a policy", + "operationId": "deletePolicy", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Delete a policy", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a policy", + "operationId": "getPolicy", + "parameters": [ + { + "in": "query", + "name": "expand", + "schema": { + "default": "", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "access-policy": { + "$ref": "#/components/examples/create-access-policy-response" + }, + "device-signal-collection-policy": { + "$ref": "#/components/examples/device-signal-collection-policy-response" + }, + "entity-risk-policy": { + "$ref": "#/components/examples/get-entity-risk-policy-response" + }, + "identity-claim-sourcing-policy": { + "$ref": "#/components/examples/get-identity-claim-sourcing-policy-response" + }, + "idp-discovery": { + "$ref": "#/components/examples/idp-discovery-policy-response" + }, + "mfa-enroll": { + "$ref": "#/components/examples/mfa-enroll-policy-response" + }, + "mfa-enroll-auto-enroll-disabled": { + "$ref": "#/components/examples/mfa-enroll-policy-auto-enroll-disabled-response" + }, + "mfa-enroll-grace-period": { + "$ref": "#/components/examples/mfa-enroll-policy-with-grace-period-response" + }, + "okta-sign-on-policy": { + "$ref": "#/components/examples/create-okta-sign-on-policy-response" + }, + "password": { + "$ref": "#/components/examples/password-policy-response" + }, + "passwordWithBreachedProtection": { + "$ref": "#/components/examples/password-policy-with-breached-protection-response" + }, + "post-auth-session-policy": { + "$ref": "#/components/examples/get-post-auth-session-policy-response" + }, + "profile-enrollment": { + "$ref": "#/components/examples/profile-enrollment-policy-response" + }, + "session-violation-detection-policy": { + "$ref": "#/components/examples/get-session-violation-detection-policy-response" + } + }, + "schema": { + "$ref": "#/components/schemas/Policy" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.read" + ] + } + ], + "summary": "Retrieve a policy", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + } + ], + "put": { + "description": "Replaces the properties of a policy identified by `policyId`", + "operationId": "replacePolicy", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateOrUpdatePolicy" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "access-policy": { + "$ref": "#/components/examples/create-access-policy-response" + }, + "device-signal-collection-policy": { + "$ref": "#/components/examples/device-signal-collection-policy-response" + }, + "idp-discovery": { + "$ref": "#/components/examples/idp-discovery-policy-response" + }, + "mfa-enroll": { + "$ref": "#/components/examples/mfa-enroll-policy-response" + }, + "mfa-enroll-auto-enroll-disabled": { + "$ref": "#/components/examples/mfa-enroll-policy-auto-enroll-disabled-response" + }, + "mfa-enroll-with-grace-period": { + "$ref": "#/components/examples/mfa-enroll-policy-with-grace-period-response" + }, + "okta-sign-on-policy": { + "$ref": "#/components/examples/create-okta-sign-on-policy-response" + }, + "password": { + "$ref": "#/components/examples/password-policy-response" + }, + "passwordWithBreachedProtection": { + "$ref": "#/components/examples/password-policy-with-breached-protection-response" + }, + "profile-enrollment": { + "$ref": "#/components/examples/profile-enrollment-policy-response" + } + }, + "schema": { + "$ref": "#/components/schemas/Policy" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Replace a policy", + "tags": [ + "Policy" + ], + "x-codegen-request-body-name": "policy", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/policies/{policyId}/app": { + "get": { + "deprecated": true, + "description": "Lists all applications mapped to a policy identified by `policyId`\n\n> **Note:** Use [List all resources mapped to a policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/policy/#tag/Policy/operation/listPolicyMappings) to list all applications mapped to a policy.", + "operationId": "listPolicyApps", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Application" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.read" + ] + } + ], + "summary": "List all apps mapped to a policy", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + } + ] + }, + "/api/v1/policies/{policyId}/clone": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + } + ], + "post": { + "description": "Clones an existing policy", + "operationId": "clonePolicy", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "access-policy": { + "$ref": "#/components/examples/create-access-policy-response" + }, + "idp-discovery": { + "$ref": "#/components/examples/idp-discovery-policy-response" + }, + "mfa-enroll": { + "$ref": "#/components/examples/mfa-enroll-policy-response" + }, + "mfa-enroll-auto-enroll-disabled": { + "$ref": "#/components/examples/mfa-enroll-policy-auto-enroll-disabled-response" + }, + "mfa-enroll-with-grace-period": { + "$ref": "#/components/examples/mfa-enroll-policy-with-grace-period-response" + }, + "okta-sign-on-policy": { + "$ref": "#/components/examples/create-okta-sign-on-policy-response" + }, + "password": { + "$ref": "#/components/examples/password-policy-response" + }, + "passwordWithBreachedProtection": { + "$ref": "#/components/examples/password-policy-with-breached-protection-response" + }, + "profile-enrollment": { + "$ref": "#/components/examples/profile-enrollment-policy-response" + } + }, + "schema": { + "$ref": "#/components/schemas/Policy" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Clone an existing policy", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/policies/{policyId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + } + ], + "post": { + "description": "Activates a policy", + "operationId": "activatePolicy", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Activate a policy", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/policies/{policyId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + } + ], + "post": { + "description": "Deactivates a policy", + "operationId": "deactivatePolicy", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Deactivate a policy", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/policies/{policyId}/mappings": { + "get": { + "description": "Lists all resources mapped to a policy identified by `policyId`", + "operationId": "listPolicyMappings", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "policy-mapping-response": { + "$ref": "#/components/examples/policy-mapping-list-response" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/PolicyMapping" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.read" + ] + } + ], + "summary": "List all resources mapped to a policy", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + } + ], + "post": { + "description": "Maps a resource to a policy identified by `policyId`\n\n> **Note:** Use the [Assign an app sign-in policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/ApplicationPolicies/#tag/ApplicationPolicies/operation/assignApplicationPolicy) endpoint to assign an app sign-in policy to an app.", + "operationId": "mapResourceToPolicy", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyMappingRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "policy-mapping-response": { + "$ref": "#/components/examples/policy-mapping-response" + } + }, + "schema": { + "$ref": "#/components/schemas/PolicyMapping" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Map a resource to a policy", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/policies/{policyId}/mappings/{mappingId}": { + "delete": { + "description": "Deletes the resource mapping for a policy identified by `policyId` and `mappingId`", + "operationId": "deletePolicyResourceMapping", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Delete a policy resource mapping", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a resource mapping for a policy identified by `policyId` and `mappingId`", + "operationId": "getPolicyMapping", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "policy-mapping-response": { + "$ref": "#/components/examples/policy-mapping-response" + } + }, + "schema": { + "$ref": "#/components/schemas/PolicyMapping" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.read" + ] + } + ], + "summary": "Retrieve a policy resource mapping", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + }, + { + "$ref": "#/components/parameters/pathPolicyMappingId" + } + ] + }, + "/api/v1/policies/{policyId}/rules": { + "get": { + "description": "Lists all policy rules", + "operationId": "listPolicyRules", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "access": { + "$ref": "#/components/examples/list-all-access-policy-rule-response" + }, + "device-signal-collection": { + "$ref": "#/components/examples/list-all-device-signal-collection-rule-response" + }, + "entity-risk": { + "$ref": "#/components/examples/list-all-entity-risk-policy-rule-response" + }, + "identity-claim-sourcing": { + "$ref": "#/components/examples/list-all-identity-claim-sourcing-policy-rule-response" + }, + "idp-discovery": { + "$ref": "#/components/examples/list-all-idp-discovery-policy-rule-response" + }, + "mfa-enroll": { + "$ref": "#/components/examples/list-all-mfa-enroll-policy-rule-response" + }, + "okta-sign-on": { + "$ref": "#/components/examples/list-all-sign-on-policy-rule-response" + }, + "password": { + "$ref": "#/components/examples/list-all-password-policy-rule-response" + }, + "post-auth-session": { + "$ref": "#/components/examples/list-all-post-auth-session-policy-rule-response" + }, + "profile-enrollment": { + "$ref": "#/components/examples/list-all-profile-enrollment-policy-rule-response" + }, + "session-violation-detection": { + "$ref": "#/components/examples/list-all-session-violation-detection-policy-rule-response" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/PolicyRule" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.read" + ] + } + ], + "summary": "List all policy rules", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + }, + { + "$ref": "#/components/parameters/limitParameter" + } + ], + "post": { + "description": "Creates a policy rule\n\n> **Note:** You can't create additional rules for the `PROFILE_ENROLLMENT`, `POST_AUTH_SESSION`, `CLIENT_UPDATE`, or <x-lifecycle class=\"ea\"></x-lifecycle> `IDENTITY_CLAIM_SOURCING` policies.", + "operationId": "createPolicyRule", + "parameters": [ + { + "description": "Set this parameter to `false` to create an `INACTIVE` rule.", + "in": "query", + "name": "activate", + "schema": { + "default": true, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "CloudRule": { + "$ref": "#/components/examples/cloud-rule" + }, + "CreateAuthPolicyRule2FADisablePostAuthKmsi": { + "$ref": "#/components/examples/twofa-enabled-post-auth-kmsi-disabled" + }, + "CreateAuthPolicyRule2FAEnablePostAuthKmsi": { + "$ref": "#/components/examples/twofa-enabled-post-auth-kmsi-enabled" + }, + "CreateAuthPolicyRuleAmc2Chains": { + "$ref": "#/components/examples/amc-two-chain" + }, + "CreateAuthPolicyRuleDevicePlatformCondition": { + "$ref": "#/components/examples/create-auth-policy-rule-condition" + }, + "DenyRule": { + "$ref": "#/components/examples/deny-rule" + }, + "DeviceConditionWithOamp": { + "$ref": "#/components/examples/device-condition-with-oamp-request" + }, + "DeviceSignalCollectionRule": { + "$ref": "#/components/examples/create-device-signal-collection-rule" + }, + "Enable2FAPreciseAuth": { + "$ref": "#/components/examples/twofa-enabled-disallow-password-allow-phishing" + }, + "EnableDynamicRoutingRule": { + "$ref": "#/components/examples/idp-discovery-dynamic-routing-rule" + }, + "EnableIdProofingForOamp": { + "$ref": "#/components/examples/oamp-id-proofing-policy-rule" + }, + "EnableSpecificRoutingRule": { + "$ref": "#/components/examples/idp-discovery-specific-routing-rule" + }, + "EnableSsprNoEmailEnroll": { + "$ref": "#/components/examples/sspr-recovery-email-without-enrollment" + }, + "EnableSsprNoStepUp": { + "$ref": "#/components/examples/sspr-enabled-no-step-up" + }, + "EnableSsprOAMP": { + "$ref": "#/components/examples/sspr-enabled-OAMP" + }, + "EnableSsprSSOStepUp": { + "$ref": "#/components/examples/sspr-enabled-sso-step-up" + }, + "EnableSsprSecurityQuestionStepUp": { + "$ref": "#/components/examples/sspr-enabled-sq-step-up" + }, + "EnableSsprWithConstraints": { + "$ref": "#/components/examples/sspr-enabled-sso-step-up-with-constraints" + }, + "EntityRiskRule": { + "$ref": "#/components/examples/entity-risk-rule-example" + }, + "PostAuthSessionRule": { + "$ref": "#/components/examples/post-auth-session-rule-example" + }, + "RadiusRule": { + "$ref": "#/components/examples/radius-rule" + }, + "SessionViolationDetectionRule": { + "$ref": "#/components/examples/session-violation-detection-rule-example" + }, + "SignOnPolicy": { + "$ref": "#/components/examples/sign-on-policy-rule" + }, + "SkipFactorChallengeOnPremRule": { + "$ref": "#/components/examples/skip-factor-challenge-on-prem-rule" + } + }, + "schema": { + "$ref": "#/components/schemas/PolicyRule" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CloudRule": { + "$ref": "#/components/examples/cloud-rule-response" + }, + "CreateAuthPolicyRule2FADisablePostAuthKmsi": { + "$ref": "#/components/examples/twofa-enabled-post-auth-kmsi-disabled-response" + }, + "CreateAuthPolicyRule2FAEnablePostAuthKmsi": { + "$ref": "#/components/examples/twofa-enabled-post-auth-kmsi-enabled-response" + }, + "CreateAuthPolicyRuleAmc2Chains": { + "$ref": "#/components/examples/amc-two-chain" + }, + "CreateAuthPolicyRuleDevicePlatformCondition": { + "$ref": "#/components/examples/create-auth-policy-rule-condition-response" + }, + "DenyRule": { + "$ref": "#/components/examples/deny-rule-response" + }, + "DeviceConditionWithOamp": { + "$ref": "#/components/examples/device-condition-with-oamp-response" + }, + "DeviceSignalCollectionRule": { + "$ref": "#/components/examples/device-signal-collection-rule-response" + }, + "Enable2FAPreciseAuth": { + "$ref": "#/components/examples/twofa-enabled-disallow-password-allow-phishing-response" + }, + "EnableDynamicRoutingRule": { + "$ref": "#/components/examples/idp-discovery-dynamic-routing-rule-response" + }, + "EnableIdProofingForOamp": { + "$ref": "#/components/examples/oamp-id-proofing-policy-rule-response" + }, + "EnableSpecificRoutingRule": { + "$ref": "#/components/examples/idp-discovery-specific-routing-rule-response" + }, + "EnableSsprNoEmailEnroll": { + "$ref": "#/components/examples/sspr-recovery-email-without-enrollment-response" + }, + "EnableSsprNoStepUp": { + "$ref": "#/components/examples/sspr-enabled-no-step-up-response" + }, + "EnableSsprSSOStepUp": { + "$ref": "#/components/examples/sspr-enabled-sso-step-up-response" + }, + "EnableSsprSecurityQuestionStepUp": { + "$ref": "#/components/examples/sspr-enabled-sq-step-up-response" + }, + "EnableSsprWithConstraints": { + "$ref": "#/components/examples/sspr-enabled-sso-step-up-with-constraints-response" + }, + "EnableSsprWithOAMP": { + "$ref": "#/components/examples/sspr-enabled-OAMP-response" + }, + "EntityRiskRule": { + "$ref": "#/components/examples/entity-risk-rule-response" + }, + "PostAuthSessionRule": { + "$ref": "#/components/examples/post-auth-session-rule-response" + }, + "RadiusRule": { + "$ref": "#/components/examples/radius-rule-response" + }, + "SessionViolationDetectionRule": { + "$ref": "#/components/examples/session-violation-detection-rule-response" + }, + "SignOnPolicy": { + "$ref": "#/components/examples/sign-on-policy-rule-response" + }, + "SkipFactorChallengeOnPremRule": { + "$ref": "#/components/examples/skip-factor-challenge-on-prem-rule-response" + } + }, + "schema": { + "$ref": "#/components/schemas/PolicyRule" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Create a policy rule", + "tags": [ + "Policy" + ], + "x-codegen-request-body-name": "policyRule", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/policies/{policyId}/rules/{ruleId}": { + "delete": { + "description": "Deletes a policy rule identified by `policyId` and `ruleId`", + "operationId": "deletePolicyRule", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Delete a policy rule", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a policy rule", + "operationId": "getPolicyRule", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AuthPolicyRule2FADisablePostAuthKmsi": { + "$ref": "#/components/examples/twofa-enabled-post-auth-kmsi-disabled-response" + }, + "AuthPolicyRule2FAEnablePostAuthKmsi": { + "$ref": "#/components/examples/twofa-enabled-post-auth-kmsi-enabled-response" + }, + "AuthenticationPolicyRuleWithPlatformDeviceConstraints": { + "$ref": "#/components/examples/update-auth-policy-rule-condition-response" + }, + "CloudRule": { + "$ref": "#/components/examples/cloud-rule-response" + }, + "DenyRule": { + "$ref": "#/components/examples/deny-rule-response" + }, + "DeviceSignalCollectionRule": { + "$ref": "#/components/examples/device-signal-collection-rule-response" + }, + "EnableDynamicRoutingRule": { + "$ref": "#/components/examples/idp-discovery-dynamic-routing-rule-response" + }, + "EnableSpecificRoutingRule": { + "$ref": "#/components/examples/idp-discovery-specific-routing-rule-response" + }, + "EnableSsprNoEmailEnroll": { + "$ref": "#/components/examples/sspr-recovery-email-without-enrollment-update" + }, + "EnableSsprNoStepUp": { + "$ref": "#/components/examples/sspr-enabled-no-step-up-update" + }, + "EnableSsprSSOStepUp": { + "$ref": "#/components/examples/sspr-enabled-sso-step-up-update" + }, + "EnableSsprSecurityQuestionStepUp": { + "$ref": "#/components/examples/sspr-enabled-sq-step-up-update" + }, + "EnableSsprWithConstraints": { + "$ref": "#/components/examples/sspr-enabled-sso-step-up-with-constraints-update" + }, + "EnableSsprWithOAMP": { + "$ref": "#/components/examples/sspr-enabled-OAMP-update" + }, + "EntityRiskRule": { + "$ref": "#/components/examples/entity-risk-rule-response" + }, + "IdentityClaimSourcingRule": { + "$ref": "#/components/examples/identity-claim-sourcing-rule-response" + }, + "PostAuthSessionRule": { + "$ref": "#/components/examples/post-auth-session-rule-response" + }, + "RadiusRule": { + "$ref": "#/components/examples/radius-rule-response" + }, + "SessionViolationDetectionRule": { + "$ref": "#/components/examples/session-violation-detection-rule-response" + }, + "SignOnPolicy": { + "$ref": "#/components/examples/sign-on-policy-rule-response" + }, + "SkipFactorChallengeOnPremRule": { + "$ref": "#/components/examples/skip-factor-challenge-on-prem-rule-response" + } + }, + "schema": { + "$ref": "#/components/schemas/PolicyRule" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.read" + ] + } + ], + "summary": "Retrieve a policy rule", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + }, + { + "$ref": "#/components/parameters/pathRuleId" + } + ], + "put": { + "description": "Replaces the properties for a policy rule identified by `policyId` and `ruleId`", + "operationId": "replacePolicyRule", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CloudRule": { + "$ref": "#/components/examples/cloud-rule" + }, + "DenyRule": { + "$ref": "#/components/examples/deny-rule" + }, + "EnableDynamicRoutingRule": { + "$ref": "#/components/examples/idp-discovery-dynamic-routing-rule" + }, + "EnableSpecificRoutingRule": { + "$ref": "#/components/examples/idp-discovery-specific-routing-rule" + }, + "EnableSsprNoEmailEnroll": { + "$ref": "#/components/examples/sspr-recovery-email-without-enrollment-update" + }, + "EnableSsprNoStepUp": { + "$ref": "#/components/examples/sspr-enabled-no-step-up-update" + }, + "EnableSsprSSOStepUp": { + "$ref": "#/components/examples/sspr-enabled-sso-step-up-update" + }, + "EnableSsprSecurityQuestionStepUp": { + "$ref": "#/components/examples/sspr-enabled-sq-step-up-update" + }, + "EnableSsprWithConstraints": { + "$ref": "#/components/examples/sspr-enabled-sso-step-up-with-constraints-update" + }, + "EntityRiskRule": { + "$ref": "#/components/examples/entity-risk-rule-example" + }, + "IdentityClaimSourcingRule": { + "$ref": "#/components/examples/identity-claim-sourcing-rule-example" + }, + "PostAuthSessionRule": { + "$ref": "#/components/examples/post-auth-session-rule-example" + }, + "RadiusRule": { + "$ref": "#/components/examples/radius-rule" + }, + "SessionViolationDetectionRule": { + "$ref": "#/components/examples/session-violation-detection-rule-example" + }, + "SignOnPolicy": { + "$ref": "#/components/examples/sign-on-policy-rule" + }, + "SkipFactorChallengeOnPremRule": { + "$ref": "#/components/examples/skip-factor-challenge-on-prem-rule" + }, + "UpdateAllowedIdentifiersInUserProfilePolicy": { + "$ref": "#/components/examples/update-identifiers-in-user-profile-policy" + }, + "UpdateAuthPolicyRule2FADisablePostAuthKmsi": { + "$ref": "#/components/examples/twofa-enabled-post-auth-kmsi-disabled" + }, + "UpdateAuthPolicyRule2FAEnablePostAuthKmsi": { + "$ref": "#/components/examples/twofa-enabled-post-auth-kmsi-enabled" + }, + "UpdateAuthenticationPolicyRuleWithPlatformDeviceConstraints": { + "$ref": "#/components/examples/update-auth-policy-rule-condition" + }, + "UpdateDeviceSignalCollectionRule": { + "$ref": "#/components/examples/update-device-signal-collection-rule" + } + }, + "schema": { + "$ref": "#/components/schemas/PolicyRule" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CloudRule": { + "$ref": "#/components/examples/cloud-rule-response" + }, + "DenyRule": { + "$ref": "#/components/examples/deny-rule-response" + }, + "EnableDynamicRoutingRule": { + "$ref": "#/components/examples/idp-discovery-dynamic-routing-rule-response" + }, + "EnableSpecificRoutingRule": { + "$ref": "#/components/examples/idp-discovery-specific-routing-rule-response" + }, + "EnableSsprNoEmailEnroll": { + "$ref": "#/components/examples/sspr-recovery-email-without-enrollment-response" + }, + "EnableSsprNoStepUp": { + "$ref": "#/components/examples/sspr-enabled-no-step-up-response" + }, + "EnableSsprSSOStepUp": { + "$ref": "#/components/examples/sspr-enabled-sso-step-up-response" + }, + "EnableSsprSecurityQuestionStepUp": { + "$ref": "#/components/examples/sspr-enabled-sq-step-up-response" + }, + "EnableSsprWithConstraints": { + "$ref": "#/components/examples/sspr-enabled-sso-step-up-with-constraints-response" + }, + "EntityRiskRule": { + "$ref": "#/components/examples/entity-risk-rule-response" + }, + "IdentityClaimSourcingRule": { + "$ref": "#/components/examples/identity-claim-sourcing-rule-response" + }, + "PostAuthSessionRule": { + "$ref": "#/components/examples/post-auth-session-rule-response" + }, + "RadiusRule": { + "$ref": "#/components/examples/radius-rule-response" + }, + "SessionViolationDetectionRule": { + "$ref": "#/components/examples/session-violation-detection-rule-response" + }, + "SignOnPolicy": { + "$ref": "#/components/examples/sign-on-policy-rule-response" + }, + "SkipFactorChallengeOnPremRule": { + "$ref": "#/components/examples/skip-factor-challenge-on-prem-rule-response" + }, + "UpdateAllowedIdentifiersInUserProfilePolicy": { + "$ref": "#/components/examples/update-identifiers-in-user-profile-policy-response" + }, + "UpdateAuthPolicyRule2FADisablePostAuthKmsi": { + "$ref": "#/components/examples/twofa-enabled-post-auth-kmsi-disabled-response" + }, + "UpdateAuthPolicyRule2FAEnablePostAuthKmsi": { + "$ref": "#/components/examples/twofa-enabled-post-auth-kmsi-enabled-response" + }, + "UpdateAuthenticationPolicyRuleWithPlatformDeviceConstraints": { + "$ref": "#/components/examples/update-auth-policy-rule-condition-response" + }, + "UpdateDeviceSignalCollectionRule": { + "$ref": "#/components/examples/update-device-signal-collection-rule-response" + } + }, + "schema": { + "$ref": "#/components/schemas/PolicyRule" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Replace a policy rule", + "tags": [ + "Policy" + ], + "x-codegen-request-body-name": "policyRule", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + }, + { + "$ref": "#/components/parameters/pathRuleId" + } + ], + "post": { + "description": "Activates a policy rule identified by `policyId` and `ruleId`", + "operationId": "activatePolicyRule", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Activate a policy rule", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathPolicyId" + }, + { + "$ref": "#/components/parameters/pathRuleId" + } + ], + "post": { + "description": "Deactivates a policy rule identified by `policyId` and `ruleId`", + "operationId": "deactivatePolicyRule", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.policies.manage" + ] + } + ], + "summary": "Deactivate a policy rule", + "tags": [ + "Policy" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/principal-rate-limits": { + "get": { + "description": "Lists all Principal Rate Limit entities considering the provided parameters", + "operationId": "listPrincipalRateLimitEntities", + "parameters": [ + { + "description": "Filters the list of principal rate limit entities by the provided principal type (`principalType`). For example,\n`filter=principalType eq \"SSWS_TOKEN\"` or `filter=principalType eq \"OAUTH_CLIENT\"`.", + "in": "query", + "name": "filter", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The cursor to use for pagination. It's an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination).", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of items to return in a single response page.", + "in": "query", + "name": "limit", + "schema": { + "default": 20, + "format": "int32", + "maximum": 50, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OAuthClientListAll": { + "$ref": "#/components/examples/PrincipalRateLimitsOAuthClientListAllExample" + }, + "SSWSListAll": { + "$ref": "#/components/examples/PrincipalRateLimitsSSWSListAllExample" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/PrincipalRateLimitEntity" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.principalRateLimits.read" + ] + } + ], + "summary": "List all principal rate limits", + "tags": [ + "PrincipalRateLimit" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new principal rate limit entity. Okta only allows one principal rate limit entity per org and principal.", + "operationId": "createPrincipalRateLimitEntity", + "requestBody": { + "content": { + "application/json": { + "examples": { + "SSWSToken": { + "$ref": "#/components/examples/PrincipalRateLimitEntityRequestSSWSToken" + } + }, + "schema": { + "$ref": "#/components/schemas/PrincipalRateLimitEntity" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "SSWSToken": { + "$ref": "#/components/examples/PrincipalRateLimitEntityResponseSSWSToken" + } + }, + "schema": { + "$ref": "#/components/schemas/PrincipalRateLimitEntity" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.principalRateLimits.manage" + ] + } + ], + "summary": "Create a principal rate limit", + "tags": [ + "PrincipalRateLimit" + ], + "x-codegen-request-body-name": "entity", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/principal-rate-limits/{principalRateLimitId}": { + "get": { + "description": "Retrieves a principal rate limit entity by `principalRateLimitId`", + "operationId": "getPrincipalRateLimitEntity", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "SSWSToken": { + "$ref": "#/components/examples/PrincipalRateLimitEntityResponseSSWSToken" + } + }, + "schema": { + "$ref": "#/components/schemas/PrincipalRateLimitEntity" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.principalRateLimits.read" + ] + } + ], + "summary": "Retrieve a principal rate limit", + "tags": [ + "PrincipalRateLimit" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPrincipalRateLimitId" + } + ], + "put": { + "description": "Replaces a principal rate limit entity by `principalRateLimitId`", + "operationId": "replacePrincipalRateLimitEntity", + "requestBody": { + "content": { + "application/json": { + "examples": { + "SSWSToken": { + "$ref": "#/components/examples/PrincipalRateLimitEntityReplaceRequestSSWSToken" + } + }, + "schema": { + "$ref": "#/components/schemas/PrincipalRateLimitEntity" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "SSWSToken": { + "$ref": "#/components/examples/PrincipalRateLimitEntityReplaceResponseSSWSToken" + } + }, + "schema": { + "$ref": "#/components/schemas/PrincipalRateLimitEntity" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.principalRateLimits.manage" + ] + } + ], + "summary": "Replace a principal rate limit", + "tags": [ + "PrincipalRateLimit" + ], + "x-codegen-request-body-name": "entity", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/push-providers": { + "get": { + "description": "Lists all push providers", + "operationId": "listPushProviders", + "parameters": [ + { + "description": "Filters push providers by `providerType`", + "in": "query", + "name": "type", + "schema": { + "$ref": "#/components/schemas/ProviderType" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "value": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/push-providers/{pushProviderId}" + } + }, + "configuration": { + "fileName": "fileName.p8", + "keyId": "ABC123DEFG", + "teamId": "DEF123GHIJ" + }, + "id": "ppchvbeucdTgqeiGxR0g4", + "lastUpdatedDate": "2022-01-00T00:00:00.000Z", + "name": "Example Push Provider 1", + "providerType": "APNS" + }, + { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE", + "GET", + "PUT" + ] + }, + "href": "https://your-subdomain.okta.com/api/v1/push-providers/{pushProviderId}" + } + }, + "configuration": { + "fileName": "fileName.json", + "projectId": "PROJECT_ID" + }, + "id": "ppctekcmngGaqeiBxB0g4", + "lastUpdatedDate": "2022-01-00T00:00:00.000Z", + "name": "Example Push Provider 2", + "providerType": "FCM" + } + ] + }, + "schema": { + "items": { + "$ref": "#/components/schemas/PushProvider" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.pushProviders.read" + ] + } + ], + "summary": "List all push providers", + "tags": [ + "PushProvider" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new push provider. Each Push Provider must have a unique `name`.", + "operationId": "createPushProvider", + "requestBody": { + "content": { + "application/json": { + "examples": { + "APNs": { + "$ref": "#/components/examples/PushProviderAPNsRequest" + }, + "FCM": { + "$ref": "#/components/examples/PushProviderFCMRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/PushProvider" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "APNs": { + "$ref": "#/components/examples/PushProviderAPNsResponse" + }, + "FCM": { + "$ref": "#/components/examples/PushProviderFCMResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/PushProvider" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.pushProviders.manage" + ] + } + ], + "summary": "Create a push provider", + "tags": [ + "PushProvider" + ], + "x-codegen-request-body-name": "pushProvider", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/push-providers/{pushProviderId}": { + "delete": { + "description": "Deletes a push provider by `pushProviderId`. If the push provider is currently being used in the org by a custom authenticator, the delete will not be allowed.", + "operationId": "deletePushProvider", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "409": { + "content": { + "application/json": { + "examples": { + "Cannot remove push provider in use by a custom app authenticator": { + "$ref": "#/components/examples/ErrorPushProviderUsedByCustomAppAuthenticator" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Conflict", + "headers": {} + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.pushProviders.manage" + ] + } + ], + "summary": "Delete a push provider", + "tags": [ + "PushProvider" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a push provider by `pushProviderId`", + "operationId": "getPushProvider", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "APNs": { + "$ref": "#/components/examples/PushProviderAPNsResponse" + }, + "FCM": { + "$ref": "#/components/examples/PushProviderFCMResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/PushProvider" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.pushProviders.read" + ] + } + ], + "summary": "Retrieve a push provider", + "tags": [ + "PushProvider" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathPushProviderId" + } + ], + "put": { + "description": "Replaces a push provider by `pushProviderId`", + "operationId": "replacePushProvider", + "requestBody": { + "content": { + "application/json": { + "examples": { + "APNs": { + "$ref": "#/components/examples/PushProviderAPNsRequest" + }, + "FCM": { + "$ref": "#/components/examples/PushProviderFCMRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/PushProvider" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "APNs": { + "$ref": "#/components/examples/PushProviderAPNsResponse" + }, + "FCM": { + "$ref": "#/components/examples/PushProviderFCMResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/PushProvider" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.pushProviders.manage" + ] + } + ], + "summary": "Replace a push provider", + "tags": [ + "PushProvider" + ], + "x-codegen-request-body-name": "pushProvider", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/rate-limit-settings/admin-notifications": { + "get": { + "description": "Retrieves the currently configured Rate Limit Admin Notification Settings", + "operationId": "getRateLimitSettingsAdminNotifications", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Disabled": { + "$ref": "#/components/examples/RateLimitAdminNotificationsDisabled" + }, + "Enabled": { + "$ref": "#/components/examples/RateLimitAdminNotificationsEnabled" + } + }, + "schema": { + "$ref": "#/components/schemas/RateLimitAdminNotifications" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.rateLimits.read" + ] + } + ], + "summary": "Retrieve the rate limit admin notification settings", + "tags": [ + "RateLimitSettings" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces the Rate Limit Admin Notification Settings and returns the configured properties", + "operationId": "replaceRateLimitSettingsAdminNotifications", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Disabled": { + "$ref": "#/components/examples/RateLimitAdminNotificationsDisabled" + }, + "Enabled": { + "$ref": "#/components/examples/RateLimitAdminNotificationsEnabled" + } + }, + "schema": { + "$ref": "#/components/schemas/RateLimitAdminNotifications" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Disabled": { + "$ref": "#/components/examples/RateLimitAdminNotificationsDisabled" + }, + "Enabled": { + "$ref": "#/components/examples/RateLimitAdminNotificationsEnabled" + } + }, + "schema": { + "$ref": "#/components/schemas/RateLimitAdminNotifications" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.rateLimits.manage" + ] + } + ], + "summary": "Replace the rate limit admin notification settings", + "tags": [ + "RateLimitSettings" + ], + "x-codegen-request-body-name": "RateLimitAdminNotifications", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/rate-limit-settings/per-client": { + "get": { + "description": "Retrieves the currently configured Per-Client Rate Limit Settings", + "operationId": "getRateLimitSettingsPerClient", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "EnforceDefault": { + "$ref": "#/components/examples/PerClientRateLimitSettingsEnforceDefault" + }, + "EnforceDefaultWithOverrides": { + "$ref": "#/components/examples/PerClientRateLimitSettingsEnforceDefaultWithOverrides" + }, + "PreviewDefaultWithOverrides": { + "$ref": "#/components/examples/PerClientRateLimitSettingsPreviewDefaultWithOverrides" + } + }, + "schema": { + "$ref": "#/components/schemas/PerClientRateLimitSettings" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.rateLimits.read" + ] + } + ], + "summary": "Retrieve the per-client rate limit settings", + "tags": [ + "RateLimitSettings" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces the Per-Client Rate Limit Settings and returns the configured properties", + "operationId": "replaceRateLimitSettingsPerClient", + "requestBody": { + "content": { + "application/json": { + "examples": { + "EnforceDefault": { + "$ref": "#/components/examples/PerClientRateLimitSettingsEnforceDefault" + }, + "EnforceDefaultWithOverrides": { + "$ref": "#/components/examples/PerClientRateLimitSettingsEnforceDefaultWithOverrides" + }, + "PreviewDefaultWithOverrides": { + "$ref": "#/components/examples/PerClientRateLimitSettingsPreviewDefaultWithOverrides" + } + }, + "schema": { + "$ref": "#/components/schemas/PerClientRateLimitSettings" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "EnforceDefault": { + "$ref": "#/components/examples/PerClientRateLimitSettingsEnforceDefault" + }, + "EnforceDefaultWithOverrides": { + "$ref": "#/components/examples/PerClientRateLimitSettingsEnforceDefaultWithOverrides" + }, + "PreviewDefaultWithOverrides": { + "$ref": "#/components/examples/PerClientRateLimitSettingsPreviewDefaultWithOverrides" + } + }, + "schema": { + "$ref": "#/components/schemas/PerClientRateLimitSettings" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.rateLimits.manage" + ] + } + ], + "summary": "Replace the per-client rate limit settings", + "tags": [ + "RateLimitSettings" + ], + "x-codegen-request-body-name": "perClientRateLimitSettings", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/rate-limit-settings/warning-threshold": { + "get": { + "description": "Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded", + "operationId": "getRateLimitSettingsWarningThreshold", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ExampleThreshold": { + "$ref": "#/components/examples/RateLimitWarningThresholdValidExample" + } + }, + "schema": { + "$ref": "#/components/schemas/RateLimitWarningThresholdResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.rateLimits.read" + ] + } + ], + "summary": "Retrieve the rate limit warning threshold percentage", + "tags": [ + "RateLimitSettings" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces the Rate Limit Warning Threshold Percentage and returns the configured property", + "operationId": "replaceRateLimitSettingsWarningThreshold", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ExampleThreshold": { + "$ref": "#/components/examples/RateLimitWarningThresholdValidExample" + } + }, + "schema": { + "$ref": "#/components/schemas/RateLimitWarningThresholdRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ExampleThreshold": { + "$ref": "#/components/examples/RateLimitWarningThresholdValidExample" + } + }, + "schema": { + "$ref": "#/components/schemas/RateLimitWarningThresholdResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.rateLimits.manage" + ] + } + ], + "summary": "Replace the rate limit warning threshold percentage", + "tags": [ + "RateLimitSettings" + ], + "x-codegen-request-body-name": "RateLimitWarningThreshold", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/realm-assignments": { + "get": { + "description": "Lists all realm assignments", + "operationId": "listRealmAssignments", + "parameters": [ + { + "$ref": "#/components/parameters/queryLimit" + }, + { + "description": "The cursor used for pagination. It represents the priority of the last realm assignment returned in the previous fetch operation.", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AssignmentLists": { + "$ref": "#/components/examples/ListRealmAssignmentsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/RealmAssignment" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realmAssignments.read" + ] + } + ], + "summary": "List all realm assignments", + "tags": [ + "RealmAssignment" + ], + "x-okta-lifecycle": { + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new realm assignment", + "operationId": "createRealmAssignment", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Create Realm Assignments": { + "$ref": "#/components/examples/CreateRealmAssignmentRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateRealmAssignmentRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RealmAssignment" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realmAssignments.manage" + ] + } + ], + "summary": "Create a realm assignment", + "tags": [ + "RealmAssignment" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "lifecycle": "GA" + } + } + }, + "/api/v1/realm-assignments/operations": { + "get": { + "description": "Lists all realm assignment operations. The upper limit is 200 and operations are sorted in descending order from most recent to oldest by ID.", + "operationId": "listRealmAssignmentOperations", + "parameters": [ + { + "$ref": "#/components/parameters/queryLimit" + }, + { + "$ref": "#/components/parameters/queryAfter" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Executions": { + "value": [ + { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/operations/rre4mje4ez6B2a7B60g7", + "method": "GET", + "rel": "self" + } + }, + "assignmentOperation": { + "configuration": { + "actions": { + "assignUserToRealm": { + "realmId": "00g1b7rvh0xPLKXFf0g5" + } + }, + "conditions": { + "expression": { + "value": "string" + }, + "profileSourceId": "0oa4enoRyjwSCy5hx0g4" + }, + "id": "0pr1b7rxZj2ibQzfP0g5", + "name": "Realm Assignment 1" + } + }, + "completed": "2023-10-25T21:02:54.000Z", + "created": "2023-10-25T21:02:54.000Z", + "id": "rre4mje4ez6B2a7B60g7", + "numUserMoved": 50, + "realmId": "00g1b7rvh0xPLKXFf0g5", + "realmName": "Realm Name", + "started": "2023-10-25T21:02:54.000Z", + "status": "COMPLETED", + "type": "realm:assignment" + }, + { + "_links": { + "self": { + "href": "http://your-subdomain.okta.com/api/v1/operations/rre4mje4ez7B2a7B60g7", + "method": "GET", + "rel": "self" + } + }, + "assignmentOperation": { + "configuration": { + "id": "ALL", + "name": "All Assignments" + } + }, + "completed": "2023-10-25T21:02:54.000Z", + "created": "2023-10-25T21:02:54.000Z", + "id": "rre4mje4ez7B2a7B60g7", + "numUserMoved": 50, + "started": "2023-10-25T21:02:54.000Z", + "status": "COMPLETED", + "type": "realm:assignment" + } + ] + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/RealmAssignmentOperationResponse" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realmAssignments.read" + ] + } + ], + "summary": "List all realm assignment operations", + "tags": [ + "RealmAssignment" + ], + "x-okta-lifecycle": { + "lifecycle": "GA" + } + }, + "post": { + "description": "Executes a realm assignment", + "operationId": "executeRealmAssignment", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ExecuteAllAssignments": { + "value": { + "assignmentId": "ALL" + } + }, + "ExecuteSpecificAssignment": { + "value": { + "assignmentId": "0pr1b7rxZj2ibQzfP0g5" + } + } + }, + "schema": { + "$ref": "#/components/schemas/OperationRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "Execution": { + "$ref": "#/components/examples/OperationResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/RealmAssignmentOperationResponse" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realmAssignments.manage" + ] + } + ], + "summary": "Execute a realm assignment", + "tags": [ + "RealmAssignment" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "lifecycle": "GA" + } + } + }, + "/api/v1/realm-assignments/{assignmentId}": { + "delete": { + "description": "Deletes a realm assignment", + "operationId": "deleteRealmAssignment", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realmAssignments.manage" + ] + } + ], + "summary": "Delete a realm assignment", + "tags": [ + "RealmAssignment" + ], + "x-okta-lifecycle": { + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a realm assignment", + "operationId": "getRealmAssignment", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CatchAllRealmAssignment": { + "$ref": "#/components/examples/DefaultRealmAssignment" + }, + "RealmAssignment": { + "$ref": "#/components/examples/GetRealmAssignmentResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/RealmAssignment" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realmAssignments.read" + ] + } + ], + "summary": "Retrieve a realm assignment", + "tags": [ + "RealmAssignment" + ], + "x-okta-lifecycle": { + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/assignmentId" + } + ], + "put": { + "description": "Replaces a realm assignment", + "operationId": "replaceRealmAssignment", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Replace Realm Assignment": { + "$ref": "#/components/examples/CreateRealmAssignmentRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UpdateRealmAssignmentRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RealmAssignment" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realmAssignments.manage" + ] + } + ], + "summary": "Replace a realm assignment", + "tags": [ + "RealmAssignment" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "lifecycle": "GA" + } + } + }, + "/api/v1/realm-assignments/{assignmentId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/assignmentId" + } + ], + "post": { + "description": "Activates a realm assignment", + "operationId": "activateRealmAssignment", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realmAssignments.manage" + ] + } + ], + "summary": "Activate a realm assignment", + "tags": [ + "RealmAssignment" + ], + "x-okta-lifecycle": { + "lifecycle": "GA" + } + } + }, + "/api/v1/realm-assignments/{assignmentId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/assignmentId" + } + ], + "post": { + "description": "Deactivates a realm assignment", + "operationId": "deactivateRealmAssignment", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realmAssignments.manage" + ] + } + ], + "summary": "Deactivate a realm assignment", + "tags": [ + "RealmAssignment" + ], + "x-okta-lifecycle": { + "lifecycle": "GA" + } + } + }, + "/api/v1/realms": { + "get": { + "description": "Lists all realms.\n\n> **Note:** The `search` parameter results are sourced from an eventually consistent datasource and may not reflect the latest information.", + "operationId": "listRealms", + "parameters": [ + { + "description": "Specifies the number of results returned. Defaults to 10 if `search` is provided.", + "in": "query", + "name": "limit", + "schema": { + "default": 200, + "format": "int32", + "type": "integer" + } + }, + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "description": "Searches for realms with a supported filtering expression for most properties.\n\nSearches for realms can be filtered by the contains (`co`) operator. You can only use `co` with the `profile.name` property. See [Operators](https://developer.okta.com/docs/api/#operators).", + "in": "query", + "name": "search", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the field to sort by and can be any single property (for search queries only)", + "in": "query", + "name": "sortBy", + "schema": { + "example": "profile.name", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/querySortOrder" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Realm Lists": { + "$ref": "#/components/examples/ListRealmsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/Realm" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realms.read" + ] + } + ], + "summary": "List all realms", + "tags": [ + "Realm" + ], + "x-okta-lifecycle": { + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new realm", + "operationId": "createRealm", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Create a realm": { + "$ref": "#/components/examples/CreateRealmRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateRealmRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Realm Lists": { + "$ref": "#/components/examples/ListRealmsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Realm" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realms.manage" + ] + } + ], + "summary": "Create a realm", + "tags": [ + "Realm" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "lifecycle": "GA" + } + } + }, + "/api/v1/realms/{realmId}": { + "delete": { + "description": "Deletes a realm permanently. This operation can only be performed after disassociating other entities like users and identity providers from a realm.", + "operationId": "deleteRealm", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realms.manage" + ] + } + ], + "summary": "Delete a realm", + "tags": [ + "Realm" + ], + "x-okta-lifecycle": { + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a realm", + "operationId": "getRealm", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "DefaultRealm": { + "$ref": "#/components/examples/DefaultRealmResponse" + }, + "NonDefaultRealm": { + "$ref": "#/components/examples/RealmResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Realm" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realms.read" + ] + } + ], + "summary": "Retrieve a realm", + "tags": [ + "Realm" + ], + "x-okta-lifecycle": { + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathRealmId" + } + ], + "put": { + "description": "Replaces the realm profile", + "operationId": "replaceRealm", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Replace a realm": { + "$ref": "#/components/examples/CreateRealmRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UpdateRealmRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Realm" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.realms.manage" + ] + } + ], + "summary": "Replace the realm profile", + "tags": [ + "Realm" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "lifecycle": "GA" + } + } + }, + "/api/v1/roles/{roleRef}/subscriptions": { + "get": { + "description": "Lists all subscriptions available to a specified Role", + "operationId": "listSubscriptionsRole", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Subscription" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all subscriptions for a role", + "tags": [ + "Subscription" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathRoleRef" + } + ] + }, + "/api/v1/roles/{roleRef}/subscriptions/{notificationType}": { + "get": { + "description": "Retrieves a subscription by `notificationType` for a specified Role", + "operationId": "getSubscriptionsNotificationTypeRole", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a subscription for a role", + "tags": [ + "Subscription" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathRoleRef" + }, + { + "$ref": "#/components/parameters/pathNotificationType" + } + ] + }, + "/api/v1/roles/{roleRef}/subscriptions/{notificationType}/subscribe": { + "parameters": [ + { + "$ref": "#/components/parameters/pathRoleRef" + }, + { + "$ref": "#/components/parameters/pathNotificationType" + } + ], + "post": { + "description": "Subscribes a Role to a specified notification type. Changes to Role subscriptions override the subscription status of any individual users with the Role.", + "operationId": "subscribeByNotificationTypeRole", + "responses": { + "200": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Subscribe a role to a specific notification type", + "tags": [ + "Subscription" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/roles/{roleRef}/subscriptions/{notificationType}/unsubscribe": { + "parameters": [ + { + "$ref": "#/components/parameters/pathRoleRef" + }, + { + "$ref": "#/components/parameters/pathNotificationType" + } + ], + "post": { + "description": "Unsubscribes a Role from a specified notification type. Changes to Role subscriptions override the subscription status of any individual users with the Role.", + "operationId": "unsubscribeByNotificationTypeRole", + "responses": { + "200": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unsubscribe a role from a specific notification type", + "tags": [ + "Subscription" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/security-events-providers": { + "get": { + "description": "Lists all security events provider instances", + "operationId": "listSecurityEventsProviderInstances", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "list": { + "$ref": "#/components/examples/ListOfSecurityEventsProviderInstances" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/SecurityEventsProviderResponse" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.securityEventsProviders.read" + ] + } + ], + "summary": "List all security events providers", + "tags": [ + "SSFReceiver" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "post": { + "description": "Creates a security events provider instance", + "operationId": "createSecurityEventsProviderInstance", + "requestBody": { + "content": { + "application/json": { + "examples": { + "issuer-and-JWKS-URL-provided": { + "$ref": "#/components/examples/SecurityEventsProviderRequestIssuerAndJwksUrl" + }, + "well-known-URL-provided": { + "$ref": "#/components/examples/SecurityEventsProviderRequestWellKnownUrl" + } + }, + "schema": { + "$ref": "#/components/schemas/SecurityEventsProviderRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "issuer-and-JWKS-URL-provided": { + "$ref": "#/components/examples/SecurityEventsProviderResponseIssuerAndJwksUrl" + }, + "well-known-URL-provided": { + "$ref": "#/components/examples/SecurityEventsProviderResponseWellKnownUrl" + } + }, + "schema": { + "$ref": "#/components/schemas/SecurityEventsProviderResponse" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.securityEventsProviders.manage" + ] + } + ], + "summary": "Create a security events provider", + "tags": [ + "SSFReceiver" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/security-events-providers/{securityEventProviderId}": { + "delete": { + "description": "Deletes a security events provider instance specified by `id`", + "operationId": "deleteSecurityEventsProviderInstance", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.securityEventsProviders.manage" + ] + } + ], + "summary": "Delete a security events provider", + "tags": [ + "SSFReceiver" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "get": { + "description": "Retrieves the security events provider instance specified by `id`", + "operationId": "getSecurityEventsProviderInstance", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "get": { + "$ref": "#/components/examples/SecurityEventsProviderResponseWellKnownUrl" + } + }, + "schema": { + "$ref": "#/components/schemas/SecurityEventsProviderResponse" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.securityEventsProviders.read" + ] + } + ], + "summary": "Retrieve the security events provider", + "tags": [ + "SSFReceiver" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathSecurityEventProviderId" + } + ], + "put": { + "description": "Replaces a security events provider instance specified by `id`", + "operationId": "replaceSecurityEventsProviderInstance", + "requestBody": { + "content": { + "application/json": { + "examples": { + "issuer-and-JWKS-URL-provided": { + "$ref": "#/components/examples/SecurityEventsProviderRequestIssuerAndJwksUrl" + }, + "well-known-URL-provided": { + "$ref": "#/components/examples/SecurityEventsProviderRequestWellKnownUrl" + } + }, + "schema": { + "$ref": "#/components/schemas/SecurityEventsProviderRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "issuer-and-JWKS-URL-provided": { + "$ref": "#/components/examples/SecurityEventsProviderResponseIssuerAndJwksUrl" + }, + "well-known-URL-provided": { + "$ref": "#/components/examples/SecurityEventsProviderResponseWellKnownUrl" + } + }, + "schema": { + "$ref": "#/components/schemas/SecurityEventsProviderResponse" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.securityEventsProviders.manage" + ] + } + ], + "summary": "Replace a security events provider", + "tags": [ + "SSFReceiver" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/security-events-providers/{securityEventProviderId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSecurityEventProviderId" + } + ], + "post": { + "description": "Activates a security events provider instance by setting its status to `ACTIVE`.\nThis operation resumes the flow of events from the security events provider to Okta.", + "operationId": "activateSecurityEventsProviderInstance", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "activatedInstance": { + "$ref": "#/components/examples/SecurityEventsProviderResponseWellKnownUrl" + } + }, + "schema": { + "$ref": "#/components/schemas/SecurityEventsProviderResponse" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.securityEventsProviders.manage" + ] + } + ], + "summary": "Activate a security events provider", + "tags": [ + "SSFReceiver" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/security-events-providers/{securityEventProviderId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSecurityEventProviderId" + } + ], + "post": { + "description": "Deactivates a security events provider instance by setting its status to `INACTIVE`.\nThis operation stops the flow of events from the security events provider to Okta.", + "operationId": "deactivateSecurityEventsProviderInstance", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "deactivatedInstance": { + "$ref": "#/components/examples/DeactivatedSecurityEventsProviderResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/SecurityEventsProviderResponse" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.securityEventsProviders.manage" + ] + } + ], + "summary": "Deactivate a security events provider", + "tags": [ + "SSFReceiver" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/sessions/{sessionId}": { + "delete": { + "description": "Revokes the specified session", + "operationId": "revokeSession", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.sessions.manage" + ] + } + ], + "summary": "Revoke a session", + "tags": [ + "Session" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves information about the session specified by the given session ID", + "operationId": "getSession", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "SessionsRetrieve": { + "$ref": "#/components/examples/RetrieveSessionResponse", + "summary": "Retrieve session information for a single session ID" + } + }, + "schema": { + "$ref": "#/components/schemas/Session" + } + } + }, + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.sessions.read" + ] + } + ], + "summary": "Retrieve a session", + "tags": [ + "Session" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathSessionId" + } + ] + }, + "/api/v1/sessions/{sessionId}/lifecycle/refresh": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSessionId" + } + ], + "post": { + "description": "Refreshes an existing session using the `id` for that session. A successful response contains the refreshed session with an updated `expiresAt` timestamp.", + "operationId": "refreshSession", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "SessionsRefresh": { + "$ref": "#/components/examples/RefreshSessionResponse", + "summary": "Refresh an existing session using the session ID" + } + }, + "schema": { + "$ref": "#/components/schemas/Session" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.sessions.manage" + ] + } + ], + "summary": "Refresh a session", + "tags": [ + "Session" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/ssf/stream": { + "delete": { + "description": "Deletes the specified SSF stream.\n\nIf the `stream_id` is not provided in the query string, the associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. Otherwise, the SSF stream with the `stream_id` is deleted, if found.", + "operationId": "deleteSsfStream", + "parameters": [ + { + "description": "The ID of the specified SSF Stream configuration", + "example": "esc1k235GIIztAuGK0g5", + "in": "query", + "name": "stream_id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "oauth2": [ + "ssf.manage" + ] + } + ], + "summary": "Delete an SSF stream", + "tags": [ + "SSFTransmitter" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "get": { + "description": "Retrieves either a list of all known SSF stream configurations or the individual configuration if specified by ID.\n\nAs stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token.", + "operationId": "getSsfStreams", + "parameters": [ + { + "description": "The ID of the specified SSF stream configuration", + "example": "esc1k235GIIztAuGK0g5", + "in": "query", + "name": "stream_id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "individualStreamResponse": { + "$ref": "#/components/examples/streamConfigurationExample" + }, + "listResponse": { + "$ref": "#/components/examples/listStreamConfigurationExample" + } + }, + "schema": { + "oneOf": [ + { + "items": { + "$ref": "#/components/schemas/StreamConfiguration" + }, + "title": "List of stream configurations", + "type": "array" + }, + { + "$ref": "#/components/schemas/StreamConfiguration" + } + ] + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "oauth2": [ + "ssf.read" + ] + } + ], + "summary": "Retrieve the SSF stream configuration(s)", + "tags": [ + "SSFTransmitter" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "patch": { + "description": "Updates properties for an existing SSF stream configuration.\n\nIf the `stream_id` isn't provided in the request body, the associated stream with the client ID (through the request OAuth 2.0 access token) is updated.", + "operationId": "updateSsfStream", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StreamConfiguration" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StreamConfiguration" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "oauth2": [ + "ssf.manage" + ] + } + ], + "summary": "Update an SSF stream", + "tags": [ + "SSFTransmitter" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "post": { + "description": "Creates an SSF stream for an event receiver to start receiving security events in the form of Security Event Tokens (SETs) from Okta.\n\nAn SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. The client ID is provided by Okta for an [OAuth 2.0 app integration](https://help.okta.com/okta_help.htm?id=ext_Apps_App_Integration_Wizard-oidc). One SSF stream is allowed for each client ID, hence, one SSF stream is allowed for each app integration in Okta.\n\nYou can create a maximum of 10 SSF stream configurations for one org.", + "operationId": "createSsfStream", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StreamConfigurationCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StreamConfiguration" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "409": { + "$ref": "#/components/responses/ErrorApiValidationConflict409" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "oauth2": [ + "ssf.manage" + ] + } + ], + "summary": "Create an SSF stream", + "tags": [ + "SSFTransmitter" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "put": { + "description": "Replaces all properties for an existing SSF stream configuration.\n\nIf the `stream_id` isn't provided in the request body, the associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.", + "operationId": "replaceSsfStream", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StreamConfiguration" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StreamConfiguration" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "oauth2": [ + "ssf.manage" + ] + } + ], + "summary": "Replace an SSF stream", + "tags": [ + "SSFTransmitter" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/ssf/stream/status": { + "get": { + "description": "Retrieves the status of an SSF stream. The status indicates whether the transmitter is able to transmit events over the stream.", + "operationId": "getSsfStreamStatus", + "parameters": [ + { + "description": "The ID of the specified SSF stream configuration", + "example": "esc1k235GIIztAuGK0g5", + "in": "query", + "name": "stream_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "streamStatusDisabledExample": { + "$ref": "#/components/examples/streamStatusDisabledExample" + }, + "streamStatusEnabledExample": { + "$ref": "#/components/examples/streamStatusEnabledExample" + } + }, + "schema": { + "$ref": "#/components/schemas/StreamStatus" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "oauth2": [ + "ssf.read" + ] + } + ], + "summary": "Retrieve the SSF stream status", + "tags": [ + "SSFTransmitter" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/ssf/stream/verification": { + "post": { + "description": "Verifies an SSF stream by publishing a verification event requested by a security events provider.\n\n> **Note:** A successful response doesn't indicate that the verification event\n was transmitted successfully, only that Okta has transmitted the event or will\n at some point in the future. The SSF receiver is responsible for validating and acknowledging\n successful transmission of the request by responding with HTTP Response Status Code 202.", + "operationId": "verifySsfStream", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StreamVerificationRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "oauth2": [ + "ssf.manage" + ] + } + ], + "summary": "Verify an SSF stream", + "tags": [ + "SSFTransmitter" + ], + "x-codegen-request-body-name": "instance", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/telephony-providers": { + "get": { + "description": "Lists all custom telephony providers that are configured in your org", + "operationId": "listAllCustomTelephonyProviderCredentials", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CustomTelephonyProviderCredentialsListAllResponseEx": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialsListAllResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialsResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.customTelephonyProvider.read" + ] + } + ], + "summary": "List all custom telephony providers", + "tags": [ + "CustomTelephonyProvider" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a custom telephony provider with the provided credentials", + "operationId": "createCustomTelephonyProviderCredentials", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CustomTelephonyProviderCredentialCreateRequestExTelesign": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialCreateRequestTelesignEx" + }, + "CustomTelephonyProviderCredentialCreateRequestExTwilio": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialCreateRequestTwilioEx" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "CustomTelephonyProviderCredentialCreateResponseTelesignEx": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialCreateResponseTelesignEx" + }, + "CustomTelephonyProviderCredentialCreateResponseTwilioEx": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialCreateResponseTwilioEx" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialResponse" + } + } + }, + "description": "Created" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.customTelephonyProvider.manage" + ] + } + ], + "summary": "Create a custom telephony provider", + "tags": [ + "CustomTelephonyProvider" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/telephony-providers/{customTelephonyProviderId}": { + "delete": { + "description": "Deletes a custom telephony provider by its ID.\n\nBefore you delete a provider, ensure that it is [deactivated](/openapi/okta-management/management/customtelephonyprovider/deactivatecustomtelephonycredential). Consider setting up another telephony provider if you still plan to use telephony in your org. See [Set up an external telephony provider](https://help.okta.com/okta_help.htm?type=oie&id=about-telephony).", + "operationId": "deleteCustomTelephonyProviderCredential", + "parameters": [ + { + "$ref": "#/components/parameters/customTelephonyProviderId" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.customTelephonyProvider.manage" + ] + } + ], + "summary": "Delete a custom telephony provider", + "tags": [ + "CustomTelephonyProvider" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves the details of a custom telephony provider by its ID", + "operationId": "getCustomTelephonyProviderCredential", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CustomTelephonyProviderCredentialsListOneResponseEx": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialListOneResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.customTelephonyProvider.read" + ] + } + ], + "summary": "Retrieve a custom telephony provider", + "tags": [ + "CustomTelephonyProvider" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/customTelephonyProviderId" + } + ], + "patch": { + "description": "Updates the credentials of an existing custom telephony provider", + "operationId": "updateCustomTelephonyProviderCredential", + "parameters": [ + { + "$ref": "#/components/parameters/customTelephonyProviderId" + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "CustomTelephonyProviderCredentialUpdateRequestEx": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialUpdateRequestEx" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CustomTelephonyProviderCredentialsUpdateResponseEx": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialsUpdateResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.customTelephonyProvider.manage" + ] + } + ], + "summary": "Update a custom telephony provider credential", + "tags": [ + "CustomTelephonyProvider" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/telephony-providers/{customTelephonyProviderId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/customTelephonyProviderId" + } + ], + "post": { + "description": "Activates a custom telephony provider by its ID. You must activate a provider before it can be used.", + "operationId": "activateCustomTelephonyCredential", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CustomTelephonyProviderCredentialListOneResponseEx": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialListOneResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.customTelephonyProvider.manage" + ] + } + ], + "summary": "Activate a custom telephony provider", + "tags": [ + "CustomTelephonyProvider" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/telephony-providers/{customTelephonyProviderId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/customTelephonyProviderId" + } + ], + "post": { + "description": "Deactivates a custom telephony provider by its ID. Keep the following points in mind when you deactivate a provider:\n* You must deactivate a provider before deleting it.\n* If you have two telephony providers configured, and both are active, you can only deactivate the secondary provider. The second provider is the one that isn't set as the primary provider.", + "operationId": "deactivateCustomTelephonyCredential", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CustomTelephonyProviderCredentialDeactivatedResponseEx": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialDeactivatedResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.customTelephonyProvider.manage" + ] + } + ], + "summary": "Deactivate a custom telephony provider", + "tags": [ + "CustomTelephonyProvider" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/telephony-providers/{customTelephonyProviderId}/setAsPrimary": { + "parameters": [ + { + "$ref": "#/components/parameters/customTelephonyProviderId" + } + ], + "post": { + "description": "Sets a custom telephony provider as the primary telephony provider for the org. You can only set one provider as a primary provider at a time.", + "operationId": "setAsPrimaryCustomTelephonyCredential", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CustomTelephonyProviderCredentialPrimaryResponseEx": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialPrimaryResponseEx" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.customTelephonyProvider.manage" + ] + } + ], + "summary": "Set a custom telephony provider as a primary telephony provider", + "tags": [ + "CustomTelephonyProvider" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/telephony-providers/{customTelephonyProviderId}/test": { + "parameters": [ + { + "$ref": "#/components/parameters/customTelephonyProviderId" + } + ], + "post": { + "description": "Sends a test message (SMS or call) using the specified custom telephony provider to verify that the provider is configured correctly.\n\nYou must provide a valid phone number and country code to send the test message. Send it to a phone number that you have access to so you can confirm that the message was received.", + "operationId": "sendTestCustomTelephonyProviderCredential", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CustomTelephonyProviderCredentialSendTestRequestEx": { + "$ref": "#/components/examples/CustomTelephonyProviderCredentialSendTestRequestEx" + } + }, + "schema": { + "$ref": "#/components/schemas/CustomTelephonyProviderCredentialSendTestRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.customTelephonyProvider.manage" + ] + } + ], + "summary": "Send a test message from a custom telephony provider", + "tags": [ + "CustomTelephonyProvider" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/templates/sms": { + "get": { + "description": "Lists all custom SMS templates. A subset of templates can be returned that match a template type.", + "operationId": "listSmsTemplates", + "parameters": [ + { + "in": "query", + "name": "templateType", + "schema": { + "$ref": "#/components/schemas/SmsTemplateType" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "SMS Template List response": { + "$ref": "#/components/examples/SMSTemplateListResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/SmsTemplate" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "List all SMS templates", + "tags": [ + "Template" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new custom SMS template", + "operationId": "createSmsTemplate", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Create an SMS Template request": { + "$ref": "#/components/examples/CreateOrReplaceSMSTemplateRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/SmsTemplate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Create an SMS Template response": { + "$ref": "#/components/examples/CreateOrReplaceSMSTemplateResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/SmsTemplate" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.manage" + ] + } + ], + "summary": "Create an SMS template", + "tags": [ + "Template" + ], + "x-codegen-request-body-name": "smsTemplate", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/templates/sms/{templateId}": { + "delete": { + "description": "Deletes an SMS template", + "operationId": "deleteSmsTemplate", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.manage" + ] + } + ], + "summary": "Delete an SMS template", + "tags": [ + "Template" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a specific template by `id`", + "operationId": "getSmsTemplate", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get an SMS template response": { + "$ref": "#/components/examples/CreateOrReplaceSMSTemplateResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/SmsTemplate" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.read" + ] + } + ], + "summary": "Retrieve an SMS template", + "tags": [ + "Template" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathTemplateId" + } + ], + "post": { + "description": "Updates only some of the SMS Template properties:\n * All properties within the custom SMS Template that have values are updated.\n * Any translation that doesn't exist is added.\n * Any translation with a null or empty value is removed.\n * Any translation with non-empty/null value is updated.\n", + "operationId": "updateSmsTemplate", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Update an SMS Template request": { + "$ref": "#/components/examples/UpdateSMSTemplateRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/SmsTemplate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Update an SMS Template response": { + "$ref": "#/components/examples/UpdateSMSTemplateResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/SmsTemplate" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.manage" + ] + } + ], + "summary": "Update an SMS template", + "tags": [ + "Template" + ], + "x-codegen-request-body-name": "smsTemplate", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces the SMS Template\n> **Notes:** You can't update the default SMS Template.\n", + "operationId": "replaceSmsTemplate", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Replace an SMS Template request": { + "$ref": "#/components/examples/CreateOrReplaceSMSTemplateRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/SmsTemplate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Replace an SMS Template response": { + "$ref": "#/components/examples/CreateOrReplaceSMSTemplateResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/SmsTemplate" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.templates.manage" + ] + } + ], + "summary": "Replace an SMS template", + "tags": [ + "Template" + ], + "x-codegen-request-body-name": "smsTemplate", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/threats/configuration": { + "get": { + "description": "Retrieves the ThreatInsight configuration for the org", + "operationId": "getCurrentConfiguration", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ThreatInsightResponseEx": { + "$ref": "#/components/examples/ThreatInsightResponseExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ThreatInsightConfiguration" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.threatInsights.read" + ] + } + ], + "summary": "Retrieve the ThreatInsight configuration", + "tags": [ + "ThreatInsight" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Updates the ThreatInsight configuration for the org", + "operationId": "updateConfiguration", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ThreatInsightUpdateEx": { + "$ref": "#/components/examples/ThreatInsightUpdateRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ThreatInsightConfiguration" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ThreatInsightUpdateEx": { + "$ref": "#/components/examples/ThreatInsightUpdateResponseExample" + } + }, + "schema": { + "$ref": "#/components/schemas/ThreatInsightConfiguration" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.threatInsights.manage" + ] + } + ], + "summary": "Update the ThreatInsight configuration", + "tags": [ + "ThreatInsight" + ], + "x-codegen-request-body-name": "threatInsightConfiguration", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/trustedOrigins": { + "get": { + "description": "Lists all trusted origins", + "operationId": "listTrustedOrigins", + "parameters": [ + { + "description": "A search string that prefix matches against the `name` and `origin`", + "in": "query", + "name": "q", + "schema": { + "type": "string" + } + }, + { + "description": "[Filter](https://developer.okta.com/docs/api/#filter) trusted origins with a supported expression for a subset of properties. You can filter on the following properties: `name`, `origin`, `status`, and `type` (type of scopes).\n", + "examples": { + "By name": { + "value": "name eq \"Example trusted origin\"" + } + }, + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "After cursor provided by a prior request", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of results", + "in": "query", + "name": "limit", + "schema": { + "default": 20, + "format": "int32", + "maximum": 200, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "TrustedOriginsResponse": { + "$ref": "#/components/examples/TrustedOriginsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/TrustedOrigin" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.trustedOrigins.read" + ] + } + ], + "summary": "List all trusted origins", + "tags": [ + "TrustedOrigin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a trusted origin", + "operationId": "createTrustedOrigin", + "requestBody": { + "content": { + "application/json": { + "examples": { + "TrustedOriginBody": { + "$ref": "#/components/examples/TrustedOriginBody" + }, + "TrustedOriginBodyWithIframeEmbedding": { + "$ref": "#/components/examples/TrustedOriginBodyWithIframeEmbedding" + }, + "TrustedOriginBodyWithIframeEmbeddingSignIn": { + "$ref": "#/components/examples/TrustedOriginBodyWithIframeEmbeddingSignIn" + } + }, + "schema": { + "$ref": "#/components/schemas/TrustedOriginWrite" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "TrustedOriginResponse": { + "$ref": "#/components/examples/TrustedOriginResponse" + }, + "TrustedOriginResponseWithIframeEmbedding": { + "$ref": "#/components/examples/TrustedOriginResponseWithIframeEmbedding" + }, + "TrustedOriginResponseWithIframeEmbeddingSignIn": { + "$ref": "#/components/examples/TrustedOriginResponseWithIframeEmbeddingSignIn" + } + }, + "schema": { + "$ref": "#/components/schemas/TrustedOrigin" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.trustedOrigins.manage" + ] + } + ], + "summary": "Create a trusted origin", + "tags": [ + "TrustedOrigin" + ], + "x-codegen-request-body-name": "trustedOrigin", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/trustedOrigins/{trustedOriginId}": { + "delete": { + "description": "Deletes a trusted origin", + "operationId": "deleteTrustedOrigin", + "responses": { + "204": { + "content": {}, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.trustedOrigins.manage" + ] + } + ], + "summary": "Delete a trusted origin", + "tags": [ + "TrustedOrigin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a trusted origin", + "operationId": "getTrustedOrigin", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "TrustedOriginResponse": { + "$ref": "#/components/examples/TrustedOriginResponse" + }, + "TrustedOriginResponseWithIframeEmbedding": { + "$ref": "#/components/examples/TrustedOriginResponseWithIframeEmbedding" + }, + "TrustedOriginResponseWithIframeEmbeddingSignIn": { + "$ref": "#/components/examples/TrustedOriginResponseWithIframeEmbeddingSignIn" + } + }, + "schema": { + "$ref": "#/components/schemas/TrustedOrigin" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.trustedOrigins.read" + ] + } + ], + "summary": "Retrieve a trusted origin", + "tags": [ + "TrustedOrigin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathTrustedOriginId" + } + ], + "put": { + "description": "Replaces a trusted origin", + "operationId": "replaceTrustedOrigin", + "requestBody": { + "content": { + "application/json": { + "examples": { + "TrustedOriginPutBody": { + "$ref": "#/components/examples/TrustedOriginPutBody" + }, + "TrustedOriginPutBodyWithIframeEmbedding": { + "$ref": "#/components/examples/TrustedOriginPutBodyWithIframeEmbedding" + } + }, + "schema": { + "$ref": "#/components/schemas/TrustedOrigin" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "TrustedOriginPutResponse": { + "$ref": "#/components/examples/TrustedOriginPutResponse" + }, + "TrustedOriginPutResponseWithIFrameEmbedding": { + "$ref": "#/components/examples/TrustedOriginPutResponseWithIframeEmbedding" + } + }, + "schema": { + "$ref": "#/components/schemas/TrustedOrigin" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.trustedOrigins.manage" + ] + } + ], + "summary": "Replace a trusted origin", + "tags": [ + "TrustedOrigin" + ], + "x-codegen-request-body-name": "trustedOrigin", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathTrustedOriginId" + } + ], + "post": { + "description": "Activates a trusted origin. Sets the `status` to `ACTIVE`.", + "operationId": "activateTrustedOrigin", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "TrustedOriginResponse": { + "$ref": "#/components/examples/TrustedOriginResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/TrustedOrigin" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.trustedOrigins.manage" + ] + } + ], + "summary": "Activate a trusted origin", + "tags": [ + "TrustedOrigin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathTrustedOriginId" + } + ], + "post": { + "description": "Deactivates a trusted origin. Sets the `status` to `INACTIVE`.", + "operationId": "deactivateTrustedOrigin", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "TrustedOriginInactiveResponse": { + "$ref": "#/components/examples/TrustedOriginInactiveResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/TrustedOrigin" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.trustedOrigins.manage" + ] + } + ], + "summary": "Deactivate a trusted origin", + "tags": [ + "TrustedOrigin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users": { + "get": { + "description": "Lists users in your org, with pagination in most cases.\n\nA subset of users can be returned that match a supported filter expression or search criteria. Different results are returned depending on specified queries in the request.\n\n> **Notes:**\n> * This operation omits users that have a status of `DEPROVISIONED` in the response. To return all users, use a filter or search query instead.\n> * The `search` parameter results are sourced from an eventually consistent datasource and may not reflect the latest information.", + "operationId": "listUsers", + "parameters": [ + { + "$ref": "#/components/parameters/OktaResponse" + }, + { + "description": "Searches for users with a supported filtering expression for most properties. Okta recommends this query parameter because it provides the largest range of search options and optimal performance.\n\n> **Note:** Using an overly complex or long search query can result in an error.\n\nThis operation supports [pagination](https://developer.okta.com/docs/api/#pagination). Use an ID lookup for records that you update to ensure your results contain the latest data. Returned users include those with the `DEPROVISIONED` status.\n\nProperty names in the search parameter are case sensitive, whereas operators (`eq`, `sw`, and so on) and string values are case insensitive. Unlike with user logins, diacritical marks are significant in search string values: a search for `isaac.brock` finds `Isaac.Brock`, but doesn't find a property whose value is `is\u00e1\u00e0c.br\u00f6ck`.\n\nThis operation requires [URL encoding](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). See [Special characters](https://developer.okta.com/docs/api/#special-characters).\n\nThis operation searches many properties:\n * Any user profile attribute, including custom-defined attributes\n * The top-level properties: `id`, `status`, `created`, `activated`, `statusChanged`, and `lastUpdated`\n * The [user type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/#tag/UserType/operation/updateUserType) accessed as `type.id`\n * Properties that have array values\n\n> **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> The ability to search by user classification is available as an [Early Access](https://developer.okta.com/docs/api/openapi/okta-management/guides/release-lifecycle/#early-access-ea) feature. The `classification.type` property cannot be used in conjunction with other search terms. You can search using `classification.type eq \"LITE\"` or `classification.type eq \"STANDARD\"`.\n\nYou can also use `sortBy` and `sortOrder` parameters. The `ne` (not equal) operator isn't supported, but you can obtain the same result by using `lt ... or ... gt`. For example, to see all users except those that have a status of `STAGED`, use `(status lt \"STAGED\" or status gt \"STAGED\")`.\n\nYou can search properties that are arrays. If any element matches the search term, the entire array (object) is returned. Okta follows the [SCIM Protocol Specification](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) for searching arrays. You can search multiple arrays, multiple values in an array, as well as using the standard logical and filtering operators. See [Filter](https://developer.okta.com/docs/reference/core-okta-api/#filter).\n\nSearches for users can be filtered by the following operators: `sw`, `eq`, and `co`. You can only use `co` with these select user profile attributes: `profile.firstName`, `profile.lastName`, `profile.email`, and `profile.login`. See [Operators](https://developer.okta.com/docs/api/#operators).", + "examples": { + "searchArrayAttributes": { + "description": "Searches for properties that are arrays. In this example, if a user has a custom user profile attribute \"arrayAttr\" that contains values [\"arrayAttrVal1\", \"arrayAttrVal2\"...], then this user is returned.", + "summary": "Search for property arrays", + "value": "profile.arrayAttr eq \"arrayAttrVal1\"" + }, + "searchArrayAttributesLiteUser": { + "description": "Searches for users with the classification type LITE. Supported values: STANDARD or LITE.", + "summary": "Search by classification", + "value": "classification.type eq \"LITE\"" + }, + "searchById": { + "description": "Search for users with the specified ID (00u1ero7vZFVEIYLWPBN)", + "summary": "Search for a specific ID", + "value": "id eq \"00u1ero7vZFVEIYLWPBN\"" + }, + "searchByLastUpdatedAfterDate": { + "description": "Search for users that were last updated after a specific timestamp", + "summary": "Search after a specific time", + "value": "lastUpdated gt \"2014-01-01T00:00:00.000Z\"" + }, + "searchByProfileDepartmentCreatedAndStatus": { + "description": "Search for users in the department of Engineering who were created before 01/01/2014 or have a status of ACTIVE", + "summary": "Search with multiple criteria", + "value": "profile.department eq \"Engineering\" and (created lt \"2014-01-01T00:00:00.000Z\" or status eq \"ACTIVE\")" + }, + "searchByStatus": { + "description": "Search for users that have a status of STAGED", + "summary": "Search for a specific status", + "value": "status eq \"STAGED\"" + } + }, + "in": "query", + "name": "search", + "schema": { + "type": "string" + } + }, + { + "description": "Filters users with a supported expression for a subset of properties.\n\n> **Note:** Returned users include those with the `DEPROVISIONED` status.\n\nThis requires [URL encoding](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). For example, `filter=lastUpdated gt \"2013-06-01T00:00:00.000Z\"` is encoded as `filter=lastUpdated%20gt%20%222013-06-01T00:00:00.000Z%22`. Filtering is case-sensitive for property names and query values, while operators are case-insensitive.\n\nFiltering supports the following limited number of properties: `status`, `lastUpdated`, `id`, `profile.login`, `profile.email`, `profile.firstName`, and `profile.lastName`.\n\nAdditionally, filtering supports only the equal `eq` operator from the standard Okta API filtering semantics, except in the case of the `lastUpdated` property. This property can also use the inequality operators (`gt`, `ge`, `lt`, and `le`). For logical operators, only the logical operators `and` and `or` are supported. The `not` operator isn't supported. See [Filter](https://developer.okta.com/docs/api/#filter) and [Operators](https://developer.okta.com/docs/api/#operators).", + "examples": { + "filterByDateRange": { + "description": "Filter users updated after 06/01/2013 but before 01/01/2014", + "summary": "Filter by date range", + "value": "lastUpdated gt \"2013-06-01T00:00:00.000Z\" and lastUpdated lt \"2014-01-01T00:00:00.000Z\"" + }, + "filterByLogin": { + "description": "Filter users with a specified login", + "summary": "Filter by login", + "value": "profile.login eq \"login@example.com\"" + }, + "filterByStatus": { + "description": "Filter users with a status of LOCKED_OUT", + "summary": "Filter by status", + "value": "status eq \"LOCKED_OUT\"" + }, + "filterByTypeAndProfileLastUpdatedAfterDate": { + "description": "Filter users updated after 06/01/2013 but with a status of LOCKED_OUT or RECOVERY", + "summary": "Filter by multiple criteria", + "value": "lastUpdated gt \"2013-06-01T00:00:00.000Z\" and (status eq \"LOCKED_OUT\" or status eq \"RECOVERY\")" + } + }, + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Finds users who match the specified query. Use the `q` parameter for simple queries, such as a lookup of users by name when creating a people picker.\n\nThe value of `q` is matched against `firstName`, `lastName`, or `email`. This performs a `startsWith` match, but this is an implementation detail and can change without notice. You don't need to specify `firstName`, `lastName`, or `email`.\n\n> **Notes:**\n> * Using the `q` parameter in a request omits users that have a status of `DEPROVISIONED`. To return all users, use a `filter` or `search` query instead.\n> * This doesn't support pagination, but you can use `limit`.\n> * This isn't designed for large data sets. For optimal performance, use the `search` parameter instead.", + "in": "query", + "name": "q", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "description": "Specifies the number of results returned. Defaults to 10 if `q` is provided.\n\nYou can use `limit` with `after` to define the cursor location in the data set and manage the user records per page.", + "in": "query", + "name": "limit", + "schema": { + "default": 200, + "format": "int32", + "type": "integer" + } + }, + { + "description": "Specifies the field to sort by (for search queries only). This can be any single property, for example `sortBy=profile.lastName`. Users with the same value for the `sortBy` property are ordered by `id`. Use with `sortOrder` to control the order of results.", + "in": "query", + "name": "sortBy", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/querySortOrder" + }, + { + "description": "Specifies a select set of user properties to query. Any other properties will be filtered out of the returned users. This is often called field projections in APIs, which can reduce payload size, improve performance, and limit unneccessary data exposure.\n\nRequested fields should be comma-separated. Comma-separate the fields and place sub-fields in the profile object inside a `profile:()` directive, for example `profile:(firstName, city)`. The `id` field is always included, regardless of whether it's specified in the `fields` parameter.", + "examples": { + "filterByProperties": { + "description": "Returned users should only show the following properties: id, status, profile.firstName, profile.lastName, profile.city", + "summary": "Request a subset of user fields", + "value": "id,status,profile:(firstName,lastName,city)" + } + }, + "in": "query", + "name": "fields", + "schema": { + "type": "string" + } + }, + { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle></x-lifecycle-container>A parameter to include metadata in the `_embedded` property. Supported value: `classification`.", + "in": "query", + "name": "expand", + "required": false, + "schema": { + "example": "classification", + "type": "string" + }, + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListUsers": { + "$ref": "#/components/examples/ListUsersResponse" + }, + "UsersFilter": { + "$ref": "#/components/examples/ListUsersFilterResponse" + }, + "UsersProjections": { + "$ref": "#/components/examples/ListUsersFieldsResponse" + }, + "UsersQ": { + "$ref": "#/components/examples/ListUsersQResponse" + }, + "UsersSearch": { + "$ref": "#/components/examples/ListUsersSearchResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/User" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all users", + "tags": [ + "User" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new user in your Okta org with or without credentials.<br>\n> **Legal Disclaimer**\n>\n> After a user is added to the Okta directory, they receive an activation email. As part of signing up for this service,\n> you agreed not to use Okta's service/product to spam and/or send unsolicited messages.\n> Please refrain from adding unrelated accounts to the directory as Okta is not responsible for, and disclaims any and all\n> liability associated with, the activation email's content. You, and you alone, bear responsibility for the emails sent to any recipients.\n\nAll responses return the created user. Activation of a user is an asynchronous operation. The system performs group reconciliation during activation and assigns the user to all apps via direct or indirect relationships (group memberships).\n* The user's `transitioningToStatus` property is `ACTIVE` during activation to indicate that the user hasn't completed the asynchronous operation.\n* The user's `status` is `ACTIVE` when the activation process is complete.\n\nThe user is emailed a one-time activation token if activated without a password.\n\n> **Note:** If the user is assigned to an app that is configured for provisioning, the activation process triggers downstream provisioning to the app. It is possible for a user to sign in before these apps have been successfully provisioned for the user.\n\n> **Important:** Do not generate or send a one-time activation token when activating users with an assigned password. Users should sign in with their assigned password.\n\nFor more information about the various scenarios of creating a user listed in the examples, see the [User creation scenarios](/openapi/okta-management/management/tags/user/section/user-status#section/User-creation-scenarios) section.", + "operationId": "createUser", + "parameters": [ + { + "description": "Executes an [activation lifecycle](https://developer.okta.com/docs/api/openapi/okta-management/management/userlifecycle/activateuser) operation when creating the user", + "in": "query", + "name": "activate", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "Indicates whether to create a user with a specified authentication provider.", + "in": "query", + "name": "provider", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "With `activate=true`, if `nextLogin=changePassword`, a user is created, activated, and the password is set to `EXPIRED`. The user must change it the next time they sign in.", + "in": "query", + "name": "nextLogin", + "schema": { + "$ref": "#/components/schemas/UserNextLogin" + }, + "x-okta-added-version": "0.14.0" + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "Create user in group": { + "$ref": "#/components/examples/create-user-in-group-request" + }, + "Create user with authentication provider": { + "$ref": "#/components/examples/create-user-with-authentication-provider-request" + }, + "Create user with imported hashed password": { + "$ref": "#/components/examples/create-user-with-imported-hashed-password-request" + }, + "Create user with non-default user type": { + "$ref": "#/components/examples/create-user-with-non-default-user-type-request" + }, + "Create user with password": { + "$ref": "#/components/examples/create-user-with-password-request" + }, + "Create user with password and recovery question": { + "$ref": "#/components/examples/create-user-with-password-and-recovery-question-request" + }, + "Create user with password import inline hook": { + "$ref": "#/components/examples/create-user-with-password-import-inline-hook-request" + }, + "Create user with recovery question": { + "$ref": "#/components/examples/create-user-with-recovery-question-request" + }, + "Create user without credentials": { + "$ref": "#/components/examples/create-user-without-credentials-request" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateUserRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Create user in group": { + "$ref": "#/components/examples/create-user-in-group-response" + }, + "Create user with authentication provider": { + "$ref": "#/components/examples/create-user-with-authentication-provider-response" + }, + "Create user with imported hashed password": { + "$ref": "#/components/examples/create-user-with-imported-hashed-password-response" + }, + "Create user with non-default user type": { + "$ref": "#/components/examples/create-user-with-non-default-user-type-response" + }, + "Create user with password": { + "$ref": "#/components/examples/create-user-with-password-response" + }, + "Create user with password and recovery question": { + "$ref": "#/components/examples/create-user-with-password-and-recovery-question-response" + }, + "Create user with password import inline hook": { + "$ref": "#/components/examples/create-user-with-password-import-inline-hook-response" + }, + "Create user with recovery question": { + "$ref": "#/components/examples/create-user-with-recovery-question-response" + }, + "Create user without credentials": { + "$ref": "#/components/examples/create-user-without-credentials-response" + } + }, + "schema": { + "$ref": "#/components/schemas/User" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "examples": { + "Create user with expired password and `null` password": { + "$ref": "#/components/examples/ErrorCreateUserWithExpiredPasswordWithNullPassword" + }, + "Create user with expired password and activate set to `false`": { + "$ref": "#/components/examples/ErrorCreateUserWithExpiredPasswordWithoutActivation" + }, + "Create user with too many groups specified": { + "$ref": "#/components/examples/ErrorCreateUserWithTooManyManyGroupsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Create a user", + "tags": [ + "User" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}": { + "delete": { + "description": "Deletes a user permanently. This operation can only be performed on users that have a `DEPROVISIONED` status.\n\n> **Warning:** This action can't be recovered!\n\nThis operation on a user that hasn't been deactivated causes that user to be deactivated. A second delete operation is required to delete the user.\n\n> **Note:** You can also perform user deletion asynchronously. To invoke asynchronous user deletion, pass an HTTP header `Prefer: respond-async` with the request.\n\nThis header is also supported by user deactivation, which is performed if the delete endpoint is invoked on a user that hasn't been deactivated.", + "operationId": "deleteUser", + "parameters": [ + { + "description": "Sends a deactivation email to the admin if `true`", + "in": "query", + "name": "sendEmail", + "schema": { + "default": false, + "type": "boolean" + }, + "x-okta-added-version": "1.5.0" + }, + { + "in": "header", + "name": "Prefer", + "required": false, + "schema": { + "enum": [ + "respond-async" + ], + "type": "string" + } + } + ], + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Delete a user", + "tags": [ + "User" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a user from your Okta org.\n\nYou can substitute `me` for the `id` to fetch the current user linked to an API token or session cookie.\n * The request returns the user linked to the API token that is specified in the Authorization header, not the user linked to the active session. Details of the admin user who granted the API token is returned.\n * When the end user has an active Okta session, it is typically a CORS request from the browser. Therefore, it's possible to retrieve the current user without the Authorization header.\n\nWhen fetching a user by `login` or `login shortname`, [URL encode](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) the request parameter to ensure that special characters are escaped properly. Logins with a `/` character can only be fetched by `id` due to URL issues with escaping the `/` character. If you don't know a user's ID, you can use the [List all users](/openapi/okta-management/management/user/listusers) endpoint to find it.\n\n> **Note:** Some browsers block third-party cookies by default, which disrupts Okta functionality in certain flows. See [Mitigate the impact of third-party cookie deprecation](https://help.okta.com/okta_help.htm?type=oie&id=ext-third-party-cookies).", + "operationId": "getUser", + "parameters": [ + { + "$ref": "#/components/parameters/OktaResponse" + }, + { + "$ref": "#/components/parameters/queryUserExpand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GetUserExample": { + "$ref": "#/components/examples/user-example" + } + }, + "schema": { + "$ref": "#/components/schemas/UserGetSingleton" + } + } + }, + "description": "Success", + "headers": { + "Etag": { + "description": "An HTTP entity tag (`ETag`) is an identifier for a specific version of a resource. See [Conditional Requests and Entity Tags](/#conditional-requests-and-entity-tags).", + "example": "W/\"1234567890abcdef\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "Retrieve a user", + "tags": [ + "User" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Updates a user's profile or credentials with partial update semantics.\n\n> **Important:** Use the `POST` method for partial updates. Unspecified properties are set to null with `PUT`.\n\n`profile` and `credentials` can be updated independently or together with a single request.\n\n> **Notes:**\n> * Currently, the user type of a user can only be changed using a full replacement `PUT` operation. If the request parameters of a partial update include the `type` element from the user object,\nthe value must match the existing type of the user. Only admins are permitted to change the user type of a user; end users are not allowed to change their own user type.\n>\n> * To update a current user's profile with partial semantics, you can use the `/api/v1/users/me` endpoint. But, a user can only update profile properties that they have write access for. Within the profile, if the user tries to update the primary or the secondary email IDs, verification emails are sent to those email IDs, and the fields are updated only upon verification.\n>\n> * You can update user profiles of users in the `DEPROVISIONED` status if you have the **Edit Deactivated User Profile Updates** option turned on in the Admin Console. See [deactivated user profiles](https://help.okta.com/okta_help.htm?type=oie&id=edit-deactivated-users).\n\nIf you are using this endpoint to set a password, it sets a password without validating existing user credentials. This is an administrative operation. For operations that validate credentials, refer to the [Reset password](https://developer.okta.com/docs/api/openapi/okta-management/management/usercred/resetpassword), [Start forgot password flow](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserCred/#tag/UserCred/operation/forgotPassword), and [Update password](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserCred/#tag/UserCred/operation/changePassword) endpoints.", + "operationId": "updateUser", + "parameters": [ + { + "description": "If true, validates against minimum age and history password policy", + "in": "query", + "name": "strict", + "schema": { + "type": "boolean" + } + }, + { + "description": "The ETag value of the user's expected current state. This becomes a conditional request used for concurrency control. See [Conditional Requests and Entity Tags](/#conditional-requests-and-entity-tags).", + "example": "W/\"1234567890abcdef\"", + "in": "header", + "name": "If-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "Set recovery question and answer": { + "$ref": "#/components/examples/update-user-set-recovery-question-and-answer" + }, + "Update user Profile": { + "$ref": "#/components/examples/update-user-profile-request" + }, + "Update user password": { + "$ref": "#/components/examples/update-user-set-password-request" + } + }, + "schema": { + "$ref": "#/components/schemas/UpdateUserRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Update user Response": { + "$ref": "#/components/examples/user-example" + } + }, + "schema": { + "$ref": "#/components/schemas/User" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Update a user", + "tags": [ + "User" + ], + "x-codegen-request-body-name": "user", + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces a user's profile, credentials, or both using strict-update semantics.\n\nAll profile properties must be specified when updating a user's profile with a `PUT` method. Any property not specified in the request is deleted.\n> **Important:** Don't use a `PUT` method for partial updates.", + "operationId": "replaceUser", + "parameters": [ + { + "description": "If `true`, validates against minimum age and history password policy", + "in": "query", + "name": "strict", + "schema": { + "type": "boolean" + }, + "x-okta-added-version": "1.10.0" + }, + { + "description": "The ETag value of the user's expected current state. This becomes a conditional request used for concurrency control. See [Conditional Requests and Entity Tags](/#conditional-requests-and-entity-tags).", + "example": "W/\"1234567890abcdef\"", + "in": "header", + "name": "If-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "Replace user Request": { + "$ref": "#/components/examples/replace-user-request" + } + }, + "schema": { + "$ref": "#/components/schemas/UpdateUserRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Replace user Response": { + "$ref": "#/components/examples/user-example" + } + }, + "schema": { + "$ref": "#/components/schemas/User" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Replace a user", + "tags": [ + "User" + ], + "x-codegen-request-body-name": "user", + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}/appLinks": { + "get": { + "description": "Lists all app links for all direct or indirect (through group membership) assigned apps\n\n> **Note:** To list all apps in an org, use the [List all applications endpoint in the Applications API](/openapi/okta-management/management/tags/application/other/listapplications).", + "operationId": "listAppLinks", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "List App Links": { + "$ref": "#/components/examples/ListAppLinks" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AssignedAppLink" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all assigned app links", + "tags": [ + "UserResources" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ] + }, + "/api/v1/users/{id}/blocks": { + "get": { + "description": "Lists information about how the user is blocked from accessing their account", + "operationId": "listUserBlocks", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "BlocksAnyDevices": { + "$ref": "#/components/examples/ListUserBlocksAnyDevicesResponse" + }, + "BlocksUnknownDevices": { + "$ref": "#/components/examples/ListUserBlocksUnknownDevicesResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/UserBlock" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all user blocks", + "tags": [ + "User" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ] + }, + "/api/v1/users/{id}/groups": { + "get": { + "description": "Lists all groups of which the user is a member\n> **Note:** To list all groups in your org, use the [List all groups endpoints in the Groups API](/openapi/okta-management/management/group/listgroups).", + "operationId": "listUserGroups", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "List user groups": { + "$ref": "#/components/examples/ListUserGroups" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/Group" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all groups", + "tags": [ + "UserResources" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ] + }, + "/api/v1/users/{id}/idps": { + "get": { + "description": "Lists the identity providers (IdPs) associated with the user", + "operationId": "listUserIdentityProviders", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "MultipleIdPsResponse": { + "$ref": "#/components/examples/MultipleIdPsResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/IdentityProvider" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all IdPs for user", + "tags": [ + "IdentityProviderUsers" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ] + }, + "/api/v1/users/{id}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Activates a user.\n\nPerform this operation only on users with a `STAGED` or `DEPROVISIONED` status. Activation of a user is an asynchronous operation.\n* The user has the `transitioningToStatus` property with an `ACTIVE` value during activation. This indicates that the user hasn't completed the asynchronous operation.\n* The user has an `ACTIVE` status when the activation process completes.\n\nUsers who don't have a password must complete the welcome flow by visiting the activation link to complete the transition to `ACTIVE` status.\n\n> **Note:** If you want to send a branded user activation email, change the subdomain of your request to the custom domain that's associated with the brand.\n> For example, change `subdomain.okta.com` to `custom.domain.one`. See [Multibrand and custom domains](https://developer.okta.com/docs/concepts/brands/#multibrand-and-custom-domains).\n\n> **Note:** If you have optional password enabled, visiting the activation link is optional for users who aren't required to enroll a password.\n> See [Create user with optional password](/openapi/okta-management/management/user/create-user-with-optional-password#user/Create-user-with-optional-password).\n\n> **Legal disclaimer**\n> After a user is added to the Okta directory, they receive an activation email. As part of signing up for this service,\n> you agreed not to use Okta's service/product to spam and/or send unsolicited messages.\n> Please refrain from adding unrelated accounts to the directory as Okta is not responsible for, and disclaims any and all\n> liability associated with, the activation email's content. You, and you alone, bear responsibility for the emails sent to any recipients.", + "operationId": "activateUser", + "parameters": [ + { + "description": "Sends an activation email to the user if `true`", + "in": "query", + "name": "sendEmail", + "required": false, + "schema": { + "default": true, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserActivationToken" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Activate a user", + "tags": [ + "UserLifecycle" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Deactivates a user.\n\nPerform this operation only on users that do not have a `DEPROVISIONED` status.\n* The user's `transitioningToStatus` property is `DEPROVISIONED` during deactivation to indicate that the user hasn't completed the asynchronous operation.\n* The user's status is `DEPROVISIONED` when the deactivation process is complete.\n\n> **Important:** Deactivating a user is a **destructive** operation. The user is deprovisioned from all assigned apps, which might destroy their data such as email or files.\n**This action cannot be recovered!**\n\nYou can also perform user deactivation asynchronously. To invoke asynchronous user deactivation, pass an HTTP header `Prefer: respond-async` with the request.\n\n> **Note:** Users with the `DEPROVISIONED` status won't have their profiles updated when running the [Update a user](/openapi/okta-management/management/user/updateuser) endpoint unless you have the **Edit Deactived User Profile Updates** option turned on in the Admin Console. See [Edit deactivated user profiles](https://help.okta.com/okta_help.htm?type=oie&id=edit-deactivated-users).", + "operationId": "deactivateUser", + "parameters": [ + { + "description": "Sends a deactivation email to the admin if `true`", + "in": "query", + "name": "sendEmail", + "schema": { + "default": false, + "type": "boolean" + }, + "x-okta-added-version": "1.5.0" + }, + { + "description": "Request asynchronous processing", + "in": "header", + "name": "Prefer", + "required": false, + "schema": { + "enum": [ + "respond-async" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Deactivate a user", + "tags": [ + "UserLifecycle" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}/lifecycle/expire_password": { + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Expires the password. This operation transitions the user status to `PASSWORD_EXPIRED` so that the user must change their password the next time that they sign in.\n<br>\nIf you have integrated Okta with your on-premises Active Directory (AD), then setting a user's password as expired in Okta also expires the password in AD.\nWhen the user tries to sign in to Okta, delegated authentication finds the password-expired status in AD,\nand the user is presented with the password-expired page where they can change their password.\n\n> **Note:** The Okta account management policy doesn't support the `/users/{id}/lifecycle/expire_password` endpoint. See [Configure an Okta account management policy](https://developer.okta.com/docs/guides/okta-account-management-policy/main/).", + "operationId": "expirePassword", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Expire password response": { + "$ref": "#/components/examples/ExpirePwdResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/User" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Expire the password", + "tags": [ + "UserCred" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}/lifecycle/expire_password_with_temp_password": { + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Expires the password and resets the user's password to a temporary password. This operation transitions the user status to `PASSWORD_EXPIRED` so that the user must change their password the next time that they sign in.\nThe user's password is reset to a temporary password that's returned, and then the user's password is expired.\nIf `revokeSessions` is included in the request with a value of `true`, the user's current outstanding sessions are revoked and require re-authentication.\n\nIf you have integrated Okta with your on-premises Active Directory (AD), then setting a user's password as expired in Okta also expires the password in AD.\nWhen the user tries to sign in to Okta, delegated authentication finds the password-expired status in AD, and the user is presented with the password-expired page where they can change their password.", + "operationId": "expirePasswordWithTempPassword", + "parameters": [ + { + "description": "Revokes the user's existing sessions if `true`", + "in": "query", + "name": "revokeSessions", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Expire password with temp password response": { + "$ref": "#/components/examples/ExpirePwdWithTempPwdResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/tempPassword" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Expire the password with a temporary password", + "tags": [ + "UserCred" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}/lifecycle/reactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Reactivates a user.\n\nPerform this operation only on users with a `PROVISIONED` or `RECOVERY` [status](/openapi/okta-management/management/user/listusers#user/listusers/t=response&c=200&path=status).\nThis operation restarts the activation workflow if for some reason the user activation wasn't completed when using the `activationToken` from [Activate User](/openapi/okta-management/management/userlifecycle/activateuser).\n\nUsers that don't have a password must complete the flow by completing the [Reset password](/openapi/okta-management/management/usercred/resetpassword) flow and MFA enrollment steps to transition the user to `ACTIVE` status.\n\nIf `sendEmail` is `false`, returns an activation link for the user to set up their account. The activation token can be used to create a custom activation link.", + "operationId": "reactivateUser", + "parameters": [ + { + "description": "Sends an activation email to the user if `true`", + "in": "query", + "name": "sendEmail", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserActivationToken" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Reactivate a user", + "tags": [ + "UserLifecycle" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}/lifecycle/reset_factors": { + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Resets all factors for the specified user. All MFA factor enrollments return to the unenrolled state. The user's status remains `ACTIVE`. This link is present only if the user is currently enrolled in one or more MFA factors.", + "operationId": "resetFactors", + "responses": { + "200": { + "content": {}, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Reset the factors", + "tags": [ + "UserLifecycle" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}/lifecycle/reset_password": { + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Resets a password. Generates a one-time token (OTT) that you can use to reset a user's password. You can automatically email the OTT link to the user or return the OTT to the API caller and distribute using a custom flow.\n\nThis operation transitions the user to the `RECOVERY` status. The user is then not able to sign in or initiate a forgot password flow until they complete the reset flow.\n\nThis operation provides an option to delete all the user's sessions. However, if the request is made in the context of a session owned by the specified user, that session isn't cleared.\n> **Note:** You can also use this API to convert a user with the Okta credential provider to use a federated provider. After this conversion, the user can't directly sign in with a password.\n> To convert a federated user back to an Okta user, use the default API call.\n\nIf an email address is associated with multiple users, keep in mind the following to ensure a successful password recovery lookup:\n * Okta no longer includes deactivated users in the lookup.\n * The lookup searches sign-in IDs first, then primary email addresses, and then secondary email addresses.\n If `sendEmail` is `false`, returns a link for the user to reset their password.", + "operationId": "resetPassword", + "parameters": [ + { + "in": "query", + "name": "sendEmail", + "required": true, + "schema": { + "type": "boolean" + } + }, + { + "description": "Revokes all user sessions, except for the current session, if set to `true`", + "in": "query", + "name": "revokeSessions", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Reset password without sending email response": { + "$ref": "#/components/examples/ResetPwdWithoutSendingEmailResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResetPasswordToken" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Reset a password", + "tags": [ + "UserCred" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}/lifecycle/suspend": { + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Suspends a user. Perform this operation only on users with an `ACTIVE` status. The user has a `SUSPENDED` status when the process completes.\n\nSuspended users can't sign in to Okta. They can only be unsuspended or deactivated. Their group and app assignments are retained.", + "operationId": "suspendUser", + "responses": { + "200": { + "content": {}, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorMissingRequiredParameter400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Suspend a user", + "tags": [ + "UserLifecycle" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}/lifecycle/unlock": { + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Unlocks a user with a `LOCKED_OUT` status or unlocks a user with an `ACTIVE` status that's blocked from unknown devices. Unlocked users have an `ACTIVE` status and can sign in with their current password.\n> **Note:** This operation works with Okta-sourced users. It doesn't support directory-sourced accounts such as Active Directory.", + "operationId": "unlockUser", + "responses": { + "200": { + "content": {}, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Unlock a user", + "tags": [ + "UserLifecycle" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{id}/lifecycle/unsuspend": { + "parameters": [ + { + "$ref": "#/components/parameters/pathId" + } + ], + "post": { + "description": "Unsuspends a user and returns them to the `ACTIVE` state. This operation can only be performed on users that have a `SUSPENDED` status.", + "operationId": "unsuspendUser", + "responses": { + "200": { + "content": {}, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorMissingRequiredParameter400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Unsuspend a user", + "tags": [ + "UserLifecycle" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userIdOrLogin}/linkedObjects/{primaryRelationshipName}/{primaryUserId}": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserIdOrLogin" + }, + { + "$ref": "#/components/parameters/pathPrimaryRelationshipName" + }, + { + "$ref": "#/components/parameters/pathPrimaryUserId" + } + ], + "put": { + "description": "Assigns the first user as the `associated` and the second user as the `primary` for the specified relationship.\n\nIf the first user is already associated with a different `primary` for this relationship, the previous link is removed. A linked object relationship can specify only one primary user for an associated user.", + "operationId": "assignLinkedObjectValueForPrimary", + "responses": { + "204": { + "content": {}, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Assign a linked object value for primary", + "tags": [ + "UserLinkedObject" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userIdOrLogin}/linkedObjects/{relationshipName}": { + "delete": { + "description": "Deletes any existing relationship between the `associated` and `primary` user. For the `associated` user, this is specified by the ID. The `primary` name specifies the relationship.\n\nThe operation is successful if the relationship is deleted. The operation is also successful if the specified user isn't in the `associated` relationship for any instance of the specified `primary` and thus, no relationship is found.", + "operationId": "deleteLinkedObjectForUser", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Delete a linked object value", + "tags": [ + "UserLinkedObject" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Lists either the `self` link for the primary user or all associated users in the relationship specified by `relationshipName`. If the specified user isn't associated in any relationship, an empty array is returned.\n\nUse `me` instead of `id` to specify the current session user.", + "operationId": "listLinkedObjectsForUser", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "GetAssociatedLinkedObjectResponse": { + "$ref": "#/components/examples/GetAssociatedLinkedObjectsResponse" + }, + "GetPrimaryLinkedObjectResponse": { + "$ref": "#/components/examples/GetPrimaryLinkedObjectResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/ResponseLinks" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List the primary or all of the associated linked object values", + "tags": [ + "UserLinkedObject" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserIdOrLogin" + }, + { + "$ref": "#/components/parameters/pathRelationshipName" + } + ] + }, + "/api/v1/users/{userId}/authenticator-enrollments": { + "get": { + "description": "Lists all authenticator enrollments of the specified user", + "operationId": "listAuthenticatorEnrollments", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "AuthenticatorEnrollmentsListAllEx": { + "$ref": "#/components/examples/AuthenticatorEnrollmentResponseListAll" + } + }, + "schema": { + "$ref": "#/components/schemas/AuthenticatorEnrollment" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all authenticator enrollments", + "tags": [ + "UserAuthenticatorEnrollments" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/queryDiscloseIdentifiers" + } + ] + }, + "/api/v1/users/{userId}/authenticator-enrollments/phone": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "post": { + "description": "Creates a Phone authenticator enrollment that's automatically activated", + "operationId": "createAuthenticatorEnrollment", + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/PhoneAuthenticatorEnrollmentRequestBody" + }, + "responses": { + "200": { + "$ref": "#/components/responses/PhoneAuthenticatorCreateEnrollmentResponse" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Create an auto-activated Phone authenticator enrollment", + "tags": [ + "UserAuthenticatorEnrollments" + ], + "x-codegen-request-body-name": "authenticator", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/users/{userId}/authenticator-enrollments/tac": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "post": { + "description": "Creates an auto-activated Temporary access code (TAC) authenticator enrollment", + "operationId": "createTacAuthenticatorEnrollment", + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/TacAuthenticatorEnrollmentRequestBody" + }, + "responses": { + "200": { + "$ref": "#/components/responses/TacAuthenticatorCreateEnrollmentResponse" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Create an auto-activated TAC authenticator enrollment", + "tags": [ + "UserAuthenticatorEnrollments" + ], + "x-codegen-request-body-name": "authenticator", + "x-okta-iam-permissions": [ + "okta.users.credentials.manageTemporaryAccessCode" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/api/v1/users/{userId}/authenticator-enrollments/{enrollmentId}": { + "delete": { + "description": "Deletes an existing enrollment for the specified user. The user can enroll the authenticator again.", + "operationId": "deleteAuthenticatorEnrollment", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Delete an authenticator enrollment", + "tags": [ + "UserAuthenticatorEnrollments" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "get": { + "description": "Retrieves a user's authenticator enrollment by `enrollmentId`", + "operationId": "getAuthenticatorEnrollment", + "parameters": [ + { + "$ref": "#/components/parameters/queryDiscloseIdentifiers" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/AuthenticatorEnrollmentResponse" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "Retrieve an authenticator enrollment", + "tags": [ + "UserAuthenticatorEnrollments" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathEnrollmentId" + } + ] + }, + "/api/v1/users/{userId}/classification": { + "get": { + "description": "Retrieves a user's classification", + "operationId": "getUserClassification", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get classification of user": { + "$ref": "#/components/examples/Get-User-Classification-Example" + } + }, + "schema": { + "$ref": "#/components/schemas/UserClassification" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "Retrieve a user's classification", + "tags": [ + "UserClassification" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isCorsEnabled": true, + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "put": { + "description": "Replaces the user's classification", + "operationId": "replaceUserClassification", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Set user to LITE": { + "$ref": "#/components/examples/Set-User-Classification-Example" + } + }, + "schema": { + "$ref": "#/components/schemas/ReplaceUserClassification" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Get classification of user": { + "$ref": "#/components/examples/Get-User-Classification-Example" + } + }, + "schema": { + "$ref": "#/components/schemas/UserClassification" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Replace the user's classification", + "tags": [ + "UserClassification" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isCorsEnabled": true, + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + } + }, + "/api/v1/users/{userId}/clients": { + "get": { + "description": "Lists all client resources for which the specified user has grants or tokens\n\n> **Note:** To list all client resources for which a specified authorization server has tokens, use the [List all client resources for an authorization server in the Authorization Servers API](/openapi/okta-management/management/authorizationserverclients/listoauth2clientsforauthorizationserver).", + "operationId": "listUserClients", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "List user clients": { + "$ref": "#/components/examples/ListUserClients" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2Client" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all clients", + "tags": [ + "UserResources" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ] + }, + "/api/v1/users/{userId}/clients/{clientId}/grants": { + "delete": { + "description": "Revokes all grants for the specified user and client", + "operationId": "revokeGrantsForUserAndClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Revoke all grants for a client", + "tags": [ + "UserGrant" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Lists all grants for a specified user and client", + "operationId": "listGrantsForUserAndClient", + "parameters": [ + { + "description": "Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.", + "in": "query", + "name": "expand", + "schema": { + "type": "string" + } + }, + { + "description": "The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination).", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of tokens to return", + "in": "query", + "name": "limit", + "schema": { + "default": 20, + "format": "int32", + "maximum": 200, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2ScopeConsentGrant" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all grants for a client", + "tags": [ + "UserGrant" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathClientId" + } + ] + }, + "/api/v1/users/{userId}/clients/{clientId}/tokens": { + "delete": { + "description": "Revokes all refresh tokens issued for the specified user and client", + "operationId": "revokeTokensForUserAndClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Revoke all refresh tokens for a client", + "tags": [ + "UserOAuth" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Lists all refresh tokens issued for the specified user and client", + "operationId": "listRefreshTokensForUserAndClient", + "parameters": [ + { + "description": "Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.", + "in": "query", + "name": "expand", + "schema": { + "example": "scope", + "type": "string" + } + }, + { + "description": "The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination).", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of tokens to return", + "in": "query", + "name": "limit", + "schema": { + "default": 20, + "format": "int32", + "maximum": 200, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2RefreshToken" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all refresh tokens for a client", + "tags": [ + "UserOAuth" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathClientId" + } + ] + }, + "/api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}": { + "delete": { + "description": "Revokes the specified refresh and access tokens", + "operationId": "revokeTokenForUserAndClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Revoke a token for a client", + "tags": [ + "UserOAuth" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a refresh token issued for the specified user and client", + "operationId": "getRefreshTokenForUserAndClient", + "parameters": [ + { + "description": "Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.", + "in": "query", + "name": "expand", + "schema": { + "example": "scope", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OAuth2RefreshToken" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "Retrieve a refresh token for a client", + "tags": [ + "UserOAuth" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathClientId" + }, + { + "$ref": "#/components/parameters/pathTokenId" + } + ] + }, + "/api/v1/users/{userId}/credentials/change_password": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "post": { + "description": "Updates a user's password by validating the user's current password.\n\nThis operation provides an option to delete all the sessions of the specified user. However, if the request is made in the context of a session owned by the specified user, that session isn't cleared.\n\nYou can only perform this operation on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid [password credential](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#tag/User/operation/createUser!path=credentials/password&t=request).\n\nThe user transitions to `ACTIVE` status when successfully invoked in `RECOVERY` status.\n\n> **Note:** The Okta account management policy doesn't support the `/users/{userId}/credentials/change_password` endpoint. See [Configure an Okta account management policy](https://developer.okta.com/docs/guides/okta-account-management-policy/main/).", + "operationId": "changePassword", + "parameters": [ + { + "description": "If true, validates against the password minimum age policy", + "in": "query", + "name": "strict", + "schema": { + "default": false, + "type": "boolean" + }, + "x-okta-added-version": "1.10.0" + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "Change password request": { + "$ref": "#/components/examples/ChangePwdRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/ChangePasswordRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Change password response": { + "$ref": "#/components/examples/ChangePwdResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserCredentials" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Update password", + "tags": [ + "UserCred" + ], + "x-codegen-request-body-name": "changePasswordRequest", + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/credentials/change_recovery_question": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "post": { + "description": "Updates a user's recovery question and answer credential by validating the user's current password.\nYou can only perform this operation on users in `STAGED`, `ACTIVE`, or `RECOVERY` status that have a valid [password credential](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#tag/User/operation/createUser!path=credentials/password&t=request).", + "operationId": "changeRecoveryQuestion", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Update recovery question request": { + "$ref": "#/components/examples/UpdateRecQuestionRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UserCredentials" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Update recovery question response": { + "$ref": "#/components/examples/UpdateRecQuestionResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserCredentials" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Update recovery question", + "tags": [ + "UserCred" + ], + "x-codegen-request-body-name": "userCredentials", + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/credentials/forgot_password": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "post": { + "description": "Starts the forgot password flow.\n\nGenerates a one-time token (OTT) that you can use to reset a user's password.\n\nThe user must validate their security question's answer when visiting the reset link. Perform this operation only on users with an `ACTIVE` status and\na valid [recovery question credential](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#tag/User/operation/createUser!path=credentials/recovery_question&t=request).\n\n> **Note:** If you have migrated to Identity Engine, you can allow users to recover passwords with any enrolled MFA authenticator. See [Self-service account recovery](https://help.okta.com/oie/en-us/content/topics/identity-engine/authenticators/configure-sspr.htm?cshid=ext-config-sspr).\n\nIf an email address is associated with multiple users, keep in mind the following to ensure a successful password recovery lookup:\n * Okta no longer includes deactivated users in the lookup.\n * The lookup searches sign-in IDs first, then primary email addresses, and then secondary email addresses.\n\nIf `sendEmail` is `false`, returns a link for the user to reset their password. This operation doesn't affect the status of the user.", + "operationId": "forgotPassword", + "parameters": [ + { + "description": "Sends a forgot password email to the user if `true`", + "in": "query", + "name": "sendEmail", + "required": false, + "schema": { + "default": true, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Forgot password response": { + "$ref": "#/components/examples/ForgotPwdResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ForgotPasswordResponse" + } + } + }, + "description": "Reset URL" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Start forgot password flow", + "tags": [ + "UserCred" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/credentials/forgot_password_recovery_question": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "post": { + "description": "Resets the user's password to the specified password if the provided answer to the recovery question is correct.\nYou must include the recovery question answer with the submission.", + "operationId": "forgotPasswordSetNewPassword", + "parameters": [ + { + "in": "query", + "name": "sendEmail", + "required": false, + "schema": { + "default": true, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "Forgot password recovery question request": { + "$ref": "#/components/examples/ForgotPwdRecoveryQuestionRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UserCredentials" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Forgot password recovery question response": { + "$ref": "#/components/examples/ForgotPwdRecoveryQuestionResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserCredentials" + } + } + }, + "description": "Credentials" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Reset password with recovery question", + "tags": [ + "UserCred" + ], + "x-codegen-request-body-name": "userCredentials", + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/devices": { + "get": { + "description": "Lists all devices enrolled by a user\n\n> **Note:** To list all devices registered to an org, use the [List all devices endpoint in the Devices API](/openapi/okta-management/management/tags/device/other/listdevices).", + "operationId": "listUserDevices", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "APIUsersListDevicesResponseExample": { + "$ref": "#/components/examples/APIUserListDevicesResponse", + "summary": "List all devices for a specific user" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/UserDevice" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all devices for an enrolled user", + "tags": [ + "UserResources" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ] + }, + "/api/v1/users/{userId}/factors": { + "get": { + "description": "Lists all enrolled factors for the specified user that are included in the highest priority [authenticator enrollment policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/policy/) that applies to the user.\n\nOnly enrolled factors that are `REQUIRED` or `OPTIONAL` in the highest priority authenticator enrollment policy can be returned.\n\n> **Note:** When admins use this endpoint for other users, the authenticator enrollment policy that's evaluated can vary depending on how client-specific conditions are configured in the rules of an authenticator enrollment policy. The client-specific conditions of the admin's client are used during policy evaluation instead of the client-specific conditions of the user. This can affect which authenticator enrollment policy is evaluated and which factors are returned.\n>\n> For example, an admin in Europe lists all enrolled factors for a user in North America. The network zone of the admin's client (in Europe) is used during policy evaluation instead of the network zone of the user (in North America).", + "operationId": "listFactors", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListFactorsResponse": { + "$ref": "#/components/examples/ListFactorsResults" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/UserFactor" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all enrolled factors", + "tags": [ + "UserFactor" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "post": { + "description": "Enrolls a supported factor for the specified user\n\n> **Notes:**\n> * All responses return the enrolled factor with a status of either `PENDING_ACTIVATION` or `ACTIVE`.\n> * You can't use the Factors API to enroll Okta FastPass (`signed_nonce`) for a user. See [Configure Okta FastPass](https://help.okta.com/okta_help.htm?type=oie&id=ext-fp-configure).\n\n#### Additional SMS/Call factor information\n\n* **Rate limits**: Okta may return a `429 Too Many Requests` status code if you attempt to resend an SMS or a voice call challenge (OTP) within the same time window. The current [rate limit](https://developer.okta.com/docs/reference/rate-limits/) is one SMS/CALL challenge per phone number every 30 seconds.\n\n* **Existing phone numbers**: Okta may return a `400 Bad Request` status code if a user attempts to enroll with a different phone number when the user has an existing mobile phone or has an existing phone with voice call capability. A user can enroll only one mobile phone for `sms` and enroll only one voice call capable phone for `call` factor.\n\n#### Additional WebAuthn factor information\n\n* For detailed information on the WebAuthn standard, including an up-to-date list of supported browsers, see [webauthn.me](https://a0.to/webauthnme-okta-docs).\n\n* When you enroll a WebAuthn factor, the `activation` object in `_embedded` contains properties used to help the client to create a new WebAuthn credential for use with Okta. See the [WebAuthn spec for PublicKeyCredentialCreationOptions](https://www.w3.org/TR/webauthn/#dictionary-makecredentialoptions).\n\n* As of the `2026.04.0` release, the FIDO2 (WebAuthn) authenticator is now called Passkey (FIDO2 WebAuthn) and there are new settings and updates to the authenticator page layout. There have been no changes to any existing parameter names, values, or endpoint paths. For example, the `factorType` for the Passkey (FIDO2 WebAuthn) authenticator is still `webauthn`. See [Passkeys and WebAuthn](https://developer.okta.com/docs/guides/authenticators-web-authn/aspnet/main/#passkeys-and-webauthn).\n\n\n#### Additional Custom TOTP factor information\n\n* The enrollment process involves passing both the `factorProfileId` and `sharedSecret` properties for a token.\n\n* A factor profile represents a particular configuration of the Custom TOTP factor. It includes certain properties that match the hardware token that end users possess, such as the HMAC algorithm, passcode length, and time interval. There can be multiple Custom TOTP factor profiles per org, but users can only enroll in one Custom TOTP factor. Admins can [create Custom TOTP factor profiles](https://help.okta.com/okta_help.htm?id=ext-mfa-totp) in the Admin Console. Then, copy the `factorProfileId` from the Admin Console into the API request.\n\n* <x-lifecycle class=\"oie\"></x-lifecycle>\nFor Custom TOTP enrollment, Okta automaticaly enrolls a user with a `token:software:totp` factor and the `push` factor if the user isn't currently enrolled with these factors.", + "operationId": "enrollFactor", + "parameters": [ + { + "description": "If `true`, indicates that you are replacing the currently registered phone number for the specified user. This parameter is ignored if the existing phone number is used by an activated factor.", + "in": "query", + "name": "updatePhone", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "ID of an existing custom SMS template. See the [SMS Templates API](../Template). This parameter is only used by `sms` factors. If the provided ID doesn't exist, the default template is used instead.", + "in": "query", + "name": "templateId", + "schema": { + "example": "cstk2flOtuCMDJK4b0g3", + "type": "string" + } + }, + { + "description": "Defines how long the token remains valid", + "in": "query", + "name": "tokenLifetimeSeconds", + "schema": { + "default": 300, + "format": "int32", + "maximum": 86400, + "minimum": 1, + "type": "integer" + }, + "x-okta-added-version": "1.3.0" + }, + { + "description": "If `true`, the factor is immediately activated as part of the enrollment. An activation process isn't required. Currently auto-activation is supported by `sms`, `call`, `email` and `token:hotp` (Custom TOTP) factors.", + "in": "query", + "name": "activate", + "schema": { + "default": false, + "type": "boolean" + }, + "x-okta-added-version": "1.3.0" + }, + { + "description": "An ISO 639-1 two-letter language code that defines a localized message to send. This parameter is only used by `sms` factors. If a localized message doesn't exist or the `templateId` is incorrect, the default template is used instead.", + "in": "header", + "name": "Accept-Language", + "schema": { + "example": "fr", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "call": { + "$ref": "#/components/examples/EnrollFactorCallRequest" + }, + "customTotp": { + "$ref": "#/components/examples/EnrollFactorCustomTotpRequest" + }, + "email": { + "$ref": "#/components/examples/EnrollFactorEmailRequest" + }, + "google": { + "$ref": "#/components/examples/EnrollFactorGoogleRequest" + }, + "push": { + "$ref": "#/components/examples/EnrollFactorOVPushRequest" + }, + "question": { + "$ref": "#/components/examples/EnrollFactorQuestionRequest" + }, + "rsa_securId": { + "$ref": "#/components/examples/EnrollFactorRsaSecurIdRequest" + }, + "sms": { + "$ref": "#/components/examples/EnrollFactorSmsRequest" + }, + "symantec_vip": { + "$ref": "#/components/examples/EnrollFactorSymantecVipRequest" + }, + "token:software:totp": { + "$ref": "#/components/examples/EnrollFactorOVTotpRequest" + }, + "u2f": { + "$ref": "#/components/examples/EnrollFactorU2fRequest" + }, + "webAuthn": { + "$ref": "#/components/examples/EnrollFactorWebauthnRequest" + }, + "yubikey": { + "$ref": "#/components/examples/EnrollFactorYubikeyRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactor" + } + } + }, + "description": "Factor", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "call": { + "$ref": "#/components/examples/EnrollFactorCallResponse" + }, + "customTotp": { + "$ref": "#/components/examples/EnrollFactorCustomTotpResponse" + }, + "email": { + "$ref": "#/components/examples/EnrollFactorEmailResponse" + }, + "google": { + "$ref": "#/components/examples/EnrollFactorGoogleResponse" + }, + "push": { + "$ref": "#/components/examples/EnrollFactorOVPushResponse" + }, + "question": { + "$ref": "#/components/examples/EnrollFactorQuestionResponse" + }, + "rsa_securId": { + "$ref": "#/components/examples/EnrollFactorRsaSecurIdResponse" + }, + "sms": { + "$ref": "#/components/examples/EnrollFactorSmsResponse" + }, + "symantec_vip": { + "$ref": "#/components/examples/EnrollFactorSymantecVipResponse" + }, + "token:software:totp": { + "$ref": "#/components/examples/EnrollFactorOVTotpResponse" + }, + "u2f": { + "$ref": "#/components/examples/EnrollFactorU2fResponse" + }, + "webAuthn": { + "$ref": "#/components/examples/EnrollFactorWebauthnResponse" + }, + "yubikey": { + "$ref": "#/components/examples/EnrollFactorYubikeyResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactor" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Enroll a factor", + "tags": [ + "UserFactor" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/factors/catalog": { + "get": { + "description": "Lists all the supported factors that can be enrolled for the specified user that are included in the highest priority [authenticator enrollment policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/policy/) that applies to the user.\n\nOnly factors that are `REQUIRED` or `OPTIONAL` in the highest priority authenticator enrollment policy can be returned.\n\n> **Note:** When admins use this endpoint for other users, the authenticator enrollment policy that's evaluated can vary depending on how client-specific conditions are configured in the rules of an authenticator enrollment policy. The client-specific conditions of the admin's client are used during policy evaluation instead of the client-specific conditions of the user. This can affect which authenticator enrollment policy is evaluated and which factors are returned.\n>\n> For example, an admin in Europe lists all supported factors for a user in North America. The network zone of the admin's client (in Europe) is used during policy evaluation instead of the network zone of the user (in North America).", + "operationId": "listSupportedFactors", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "List of supported factors": { + "$ref": "#/components/examples/SupportedFactorResults" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/UserFactorSupported" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all supported factors", + "tags": [ + "UserFactor" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ] + }, + "/api/v1/users/{userId}/factors/questions": { + "get": { + "description": "Lists all available security questions for the specified user", + "operationId": "listSupportedSecurityQuestions", + "responses": { + "200": { + "content": { + "application/json": { + "example": [ + { + "question": "disliked_food", + "questionText": "What is the food you least liked as a child?" + }, + { + "question": "name_of_first_plush_toy", + "questionText": "What is the name of your first stuffed animal?" + }, + { + "question": "first_award", + "questionText": "What did you earn your first medal or award for?" + } + ], + "schema": { + "items": { + "$ref": "#/components/schemas/UserFactorSecurityQuestionProfile" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + } + ], + "summary": "List all supported security questions", + "tags": [ + "UserFactor" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + }, + "x-okta-no-scope-required": true + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ] + }, + "/api/v1/users/{userId}/factors/{factorId}": { + "delete": { + "description": "Unenrolls an existing factor for the specified user. You can't unenroll a factor from a deactivated user. Unenrolling a factor allows the user to enroll a new factor.\n\n> **Note:** If you unenroll the `push` or the `signed_nonce` factors, Okta also unenrolls any other `totp`, `signed_nonce`, or Okta Verify `push` factors associated with the user.", + "operationId": "unenrollFactor", + "parameters": [ + { + "description": "If `true`, removes the phone number as both a recovery method and a factor. This parameter is only used for the `sms` and `call` factors.", + "in": "query", + "name": "removeRecoveryEnrollment", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Unenroll a factor", + "tags": [ + "UserFactor" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an existing factor for the specified user", + "operationId": "getFactor", + "responses": { + "200": { + "$ref": "#/components/responses/GetFactorResponse" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "Retrieve a factor", + "tags": [ + "UserFactor" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathFactorId" + } + ] + }, + "/api/v1/users/{userId}/factors/{factorId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathFactorId" + } + ], + "post": { + "description": "Activates a factor. Some factors (`call`, `email`, `push`, `sms`, `token:software:totp`, `u2f`, and `webauthn`) require activation to complete the enrollment process.\n\nOkta enforces a rate limit of five activation attempts within five minutes. After a user exceeds the rate limit, Okta returns an error message.\n\n> **Notes:**\n> * If the user exceeds their SMS, call, or email factor activation rate limit, then an [OTP resend request](./#tag/UserFactor/operation/resendEnrollFactor) isn't allowed for the same factor.\n> * You can't use the Factors API to activate Okta FastPass (`signed_nonce`) for a user. See [Configure Okta FastPass](https://help.okta.com/okta_help.htm?type=oie&id=ext-fp-configure).", + "operationId": "activateFactor", + "requestBody": { + "content": { + "application/json": { + "examples": { + "call": { + "$ref": "#/components/examples/FactorPasscodeRequest" + }, + "email": { + "$ref": "#/components/examples/FactorPasscodeRequest" + }, + "sms": { + "$ref": "#/components/examples/FactorPasscodeRequest" + }, + "token:software:totp": { + "$ref": "#/components/examples/FactorPasscodeRequest" + }, + "u2f": { + "$ref": "#/components/examples/ActivateFactorU2fRequest" + }, + "webauthn": { + "$ref": "#/components/examples/ActivateFactorWebauthnRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactorActivateRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "call": { + "$ref": "#/components/examples/ActivateFactorCallResponse" + }, + "email": { + "$ref": "#/components/examples/ActivateFactorEmailResponse" + }, + "push": { + "$ref": "#/components/examples/ActivateFactorPushResponse" + }, + "sms": { + "$ref": "#/components/examples/ActivateFactorSmsResponse" + }, + "token:software:totp": { + "$ref": "#/components/examples/ActivateFactorTotpResponse" + }, + "u2f": { + "$ref": "#/components/examples/ActivateFactorU2fResponse" + }, + "webauthn": { + "$ref": "#/components/examples/ActivateFactorWebauthnResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactorActivateResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Activate a factor", + "tags": [ + "UserFactor" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/factors/{factorId}/resend": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathFactorId" + } + ], + "post": { + "description": "Resends an `sms`, `call`, or `email` factor challenge as part of an enrollment flow.\n\nFor `call` and `sms` factors, Okta enforces a rate limit of one OTP challenge per device every 30 seconds. You can configure your `sms` and `call` factors to use a third-party telephony provider. See the [Telephony inline hook reference](https://developer.okta.com/docs/reference/telephony-hook/). Okta alternates between SMS providers with every resend request to ensure delivery of SMS and Call OTPs across different carriers.\n\n> **Note:** Resend operations aren't allowed after a factor exceeds the activation rate limit. See [Activate a factor](./#tag/UserFactor/operation/activateFactor).", + "operationId": "resendEnrollFactor", + "parameters": [ + { + "description": "ID of an existing custom SMS template. See the [SMS Templates API](../Template). This parameter is only used by `sms` factors.", + "in": "query", + "name": "templateId", + "schema": { + "example": "cstk2flOtuCMDJK4b0g3", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "sms": { + "value": { + "factorType": "sms", + "profile": { + "phoneNumber": "+1-555-415-1337" + }, + "provider": "OKTA" + } + } + }, + "schema": { + "$ref": "#/components/schemas/ResendUserFactor" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "sms": { + "$ref": "#/components/examples/EnrollFactorSmsResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/ResendUserFactor" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Resend a factor enrollment", + "tags": [ + "UserFactor" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId}": { + "get": { + "description": "Retrieves the status of a `push` factor verification transaction\n\n > **Note:**\n > The response body for a number matching push challenge to an Okta Verify `push` factor enrollment is different from the response body of a standard push challenge.\n > The number matching push challenge [response body](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/userfactor/other/getfactortransactionstatus!c=200&path=1/_embedded&t=response) contains the correct answer for the challenge.\n > Use [Verify a factor](/openapi/okta-management/management/userfactor/verifyfactor) to configure which challenge is sent.", + "operationId": "getFactorTransactionStatus", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "REJECTED": { + "$ref": "#/components/examples/UserFactorVerifyPushTransactionRejected" + }, + "SUCCESS": { + "$ref": "#/components/examples/UserFactorVerifyPushTransactionApproved" + }, + "TIMEOUT": { + "$ref": "#/components/examples/UserFactorVerifyPushTransactionTimeout" + }, + "WAITING": { + "$ref": "#/components/examples/UserFactorVerifyPushTransactionWaiting" + }, + "WAITING (with number matching challenge)": { + "$ref": "#/components/examples/UserFactorVerifyPushTransactionWaitingNMC" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactorPushTransaction" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "Retrieve a factor transaction status", + "tags": [ + "UserFactor" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathFactorId" + }, + { + "$ref": "#/components/parameters/pathTransactionId" + } + ] + }, + "/api/v1/users/{userId}/factors/{factorId}/verify": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathFactorId" + } + ], + "post": { + "description": "Verifies an OTP for a factor. Some factors (`call`, `email`, `push`, `sms`, `u2f`, and `webauthn`) must first issue a challenge before you can verify the factor. Do this by making a request without a body. After a challenge is issued, make another request to verify the factor.\n\n> **Notes:**\n> - You can send standard push challenges or number matching push challenges to Okta Verify `push` factor enrollments. Use a [request body](https://developer.okta.com/docs/api/openapi/okta-management/management/userfactor/verifyfactor!path=2/useNumberMatchingChallenge&t=request) for number matching push challenges.\n> - To verify a `push` factor, use the **poll** link returned when you issue the challenge. See [Retrieve a factor transaction status](/openapi/okta-management/management/tags/userfactor/other/getfactortransactionstatus).", + "operationId": "verifyFactor", + "parameters": [ + { + "description": "ID of an existing custom SMS template. See the [SMS Templates API](../Template). This parameter is only used by `sms` factors.", + "in": "query", + "name": "templateId", + "schema": { + "example": "cstk2flOtuCMDJK4b0g3", + "type": "string" + } + }, + { + "description": "Defines how long the token remains valid", + "in": "query", + "name": "tokenLifetimeSeconds", + "schema": { + "default": 300, + "format": "int32", + "maximum": 86400, + "minimum": 1, + "type": "integer" + }, + "x-okta-added-version": "1.3.0" + }, + { + "description": "Public IP address for the user agent", + "in": "header", + "name": "X-Forwarded-For", + "schema": { + "type": "string" + }, + "x-okta-added-version": "1.11.0" + }, + { + "description": "Type of user agent detected when the request is made. Required to verify `push` factors.", + "in": "header", + "name": "User-Agent", + "schema": { + "type": "string" + }, + "x-okta-added-version": "1.11.0" + }, + { + "description": "An ISO 639-1 two-letter language code that defines a localized message to send. This parameter is only used by `sms` factors. If a localized message doesn't exist or the `templateId` is incorrect, the default template is used instead.", + "in": "header", + "name": "Accept-Language", + "schema": { + "example": "fr", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "call verify": { + "$ref": "#/components/examples/FactorPasscodeRequest" + }, + "email verify": { + "$ref": "#/components/examples/FactorPasscodeRequest" + }, + "push challenge with number matching": { + "$ref": "#/components/examples/NumberMatchingChallengeRequest" + }, + "security question verify": { + "$ref": "#/components/examples/UserFactorVerifySecurityQuestionRequest" + }, + "sms verify": { + "$ref": "#/components/examples/FactorPasscodeRequest" + }, + "token verify": { + "$ref": "#/components/examples/FactorPasscodeRequest" + }, + "totp verify": { + "$ref": "#/components/examples/FactorPasscodeRequest" + }, + "u2f verify": { + "$ref": "#/components/examples/UserFactorVerifyU2fRequest" + }, + "webAuthn verify": { + "$ref": "#/components/examples/UserFactorVerifyWebauthnRequest" + }, + "yubikey verify": { + "$ref": "#/components/examples/FactorPasscodeRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactorVerifyRequest" + } + } + }, + "description": "Verifies an OTP for a factor. Some factors (`call`, `email`, `push`, `sms`, `u2f`, and `webauthn`) must first issue a challenge before you can verify the factor. Do this by making a request without a body. After a challenge is issued, make another request to verify the factor.\n\n> **Note:**\n> Unlike standard push challenges that don't require a request body, a number matching [`push`](https://developer.okta.com/docs/api/openapi/okta-management/management/userfactor/verifyfactor!path=2/useNumberMatchingChallenge&t=request) challenge requires a request body. `useNumberMatchingChallenge` must be set to `true`.\n> When a number matching challenge is issued for an Okta Verify `push` factor enrollment, a `correctAnswer` challenge object is returned in the [`_embedded`](https://developer.okta.com/docs/api/openapi/okta-management/management/userfactor/verifyfactor!c=200&path=_embedded&t=response) object.", + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "call challenge": { + "$ref": "#/components/examples/UserFactorChallengeCallResponse" + }, + "call verify": { + "$ref": "#/components/examples/UserFactorVerifyCallSuccessResponse" + }, + "email challenge": { + "$ref": "#/components/examples/UserFactorChallengeEmailResponse" + }, + "email verify": { + "$ref": "#/components/examples/UserFactorVerifyEmailSuccessResponse" + }, + "security question verify": { + "$ref": "#/components/examples/UserFactorVerifySuccessSqResponse" + }, + "sms challenge": { + "$ref": "#/components/examples/UserFactorChallengeSmsResponse" + }, + "sms verify": { + "$ref": "#/components/examples/UserFactorVerifySuccessSmsResponse" + }, + "token verify": { + "$ref": "#/components/examples/UserFactorVerifySuccessTokenResponse" + }, + "totp verify": { + "$ref": "#/components/examples/UserFactorVerifySuccessTotpResponse" + }, + "u2f challenge": { + "$ref": "#/components/examples/UserFactorChallengeU2fResponse" + }, + "u2f verify": { + "$ref": "#/components/examples/UserFactorVerifyU2fResponse" + }, + "webAuthn challenge": { + "$ref": "#/components/examples/UserFactorChallengeWebauthnResponse" + }, + "webAuthn verify": { + "$ref": "#/components/examples/UserFactorVerifyWebauthnResponse" + }, + "yubikey verify": { + "$ref": "#/components/examples/UserFactorVerifySuccessYubikeyResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactorVerifyResponse" + } + } + }, + "description": "Success" + }, + "201": { + "content": { + "application/json": { + "examples": { + "push challenge": { + "$ref": "#/components/examples/UserFactorChallengePushResponse" + }, + "push challenge with number matching": { + "$ref": "#/components/examples/UserFactorChallengePushResponseWithNumberMatchingChallenge" + } + }, + "schema": { + "$ref": "#/components/schemas/UserFactorVerifyResponseWaiting" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Verify a factor", + "tags": [ + "UserFactor" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/grants": { + "delete": { + "description": "Revokes all grants for a specified user", + "operationId": "revokeUserGrants", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Revoke all user grants", + "tags": [ + "UserGrant" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Lists all grants for the specified user", + "operationId": "listUserGrants", + "parameters": [ + { + "description": "The scope ID to filter on", + "in": "query", + "name": "scopeId", + "schema": { + "type": "string" + } + }, + { + "description": "Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.", + "in": "query", + "name": "expand", + "schema": { + "example": "scope", + "type": "string" + } + }, + { + "description": "The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination).", + "in": "query", + "name": "after", + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the number of grants to return", + "in": "query", + "name": "limit", + "schema": { + "default": 20, + "format": "int32", + "maximum": 200, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/OAuth2ScopeConsentGrant" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all user grants", + "tags": [ + "UserGrant" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ] + }, + "/api/v1/users/{userId}/grants/{grantId}": { + "delete": { + "description": "Revokes one grant for a specified user", + "operationId": "revokeUserGrant", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Revoke a user grant", + "tags": [ + "UserGrant" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a grant for the specified user", + "operationId": "getUserGrant", + "parameters": [ + { + "description": "Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.", + "in": "query", + "name": "expand", + "schema": { + "example": "scope", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OAuth2ScopeConsentGrant" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "Retrieve a user grant", + "tags": [ + "UserGrant" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathGrantId" + } + ] + }, + "/api/v1/users/{userId}/risk": { + "get": { + "description": "Retrieves the user risk object for a user ID", + "operationId": "getUserRisk", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UserRiskMediumResponseExample": { + "$ref": "#/components/examples/UserRiskMediumResponse" + }, + "UserRiskNoneResponseExample": { + "$ref": "#/components/examples/UserRiskNoneResponse" + }, + "UserRiskResponseExample": { + "$ref": "#/components/examples/UserRiskResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/UserRiskGetResponse" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.userRisk.read" + ] + } + ], + "summary": "Retrieve the user's risk", + "tags": [ + "UserRisk" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "put": { + "description": "Upserts (creates or updates) the user risk object for a user ID. You can optionally provide a `riskReason` to describe why the risk level is being changed. If `riskReason` isn't provided, the reason defaults to `override.by.admin`.", + "operationId": "upsertUserRisk", + "requestBody": { + "content": { + "application/json": { + "examples": { + "RiskProviderRequestExample": { + "$ref": "#/components/examples/UserRiskRequest" + }, + "RiskProviderRequestMediumExample": { + "$ref": "#/components/examples/UserRiskRequestMediumExample" + }, + "RiskProviderRequestMediumWithReasonExample": { + "$ref": "#/components/examples/UserRiskRequestMediumWithReasonExample" + }, + "RiskProviderRequestWithReasonExample": { + "$ref": "#/components/examples/UserRiskRequestWithReason" + } + }, + "schema": { + "$ref": "#/components/schemas/UserRiskRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UserRiskMediumResponseExample": { + "$ref": "#/components/examples/UserRiskMediumResponse" + }, + "UserRiskMediumResponseWithReasonExample": { + "$ref": "#/components/examples/UserRiskMediumResponseWithReason" + }, + "UserRiskResponseExample": { + "$ref": "#/components/examples/UserRiskResponse" + }, + "UserRiskResponseWithReasonExample": { + "$ref": "#/components/examples/UserRiskResponseWithReason" + } + }, + "schema": { + "$ref": "#/components/schemas/UserRiskPutResponse" + } + } + }, + "description": "Updated the user's risk" + }, + "201": { + "content": { + "application/json": { + "examples": { + "UserRiskMediumResponseExample": { + "$ref": "#/components/examples/UserRiskMediumResponse" + }, + "UserRiskMediumResponseWithReasonExample": { + "$ref": "#/components/examples/UserRiskMediumResponseWithReason" + }, + "UserRiskResponseExample": { + "$ref": "#/components/examples/UserRiskResponse" + }, + "UserRiskResponseWithReasonExample": { + "$ref": "#/components/examples/UserRiskResponseWithReason" + } + }, + "schema": { + "$ref": "#/components/schemas/UserRiskPutResponse" + } + } + }, + "description": "Created the user's risk" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.userRisk.manage" + ] + } + ], + "summary": "Upsert the user's risk", + "tags": [ + "UserRisk" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/roles": { + "get": { + "description": "Lists all roles assigned to a user (identified by `userId`)", + "operationId": "listAssignedRolesForUser", + "parameters": [ + { + "$ref": "#/components/parameters/pathQueryRoleExpand" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Custom roles": { + "$ref": "#/components/examples/StandardAndCustomRolesListResponse" + }, + "IAM-based standard roles": { + "$ref": "#/components/examples/IAMStandardRolesListResponse" + }, + "Standard roles": { + "$ref": "#/components/examples/StandardRolesListResponse" + } + }, + "schema": { + "items": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/CustomRole", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/CustomRole", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRole", + "APP_ADMIN": "#/components/schemas/StandardRole", + "CUSTOM": "#/components/schemas/CustomRole", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRole", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRole", + "MOBILE_ADMIN": "#/components/schemas/StandardRole", + "ORG_ADMIN": "#/components/schemas/StandardRole", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRole", + "REPORT_ADMIN": "#/components/schemas/StandardRole", + "SUPER_ADMIN": "#/components/schemas/StandardRole", + "USER_ADMIN": "#/components/schemas/StandardRole", + "WORKFLOWS_ADMIN": "#/components/schemas/CustomRole" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRole" + }, + { + "$ref": "#/components/schemas/CustomRole" + } + ] + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all user role assignments", + "tags": [ + "RoleAssignmentAUser" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ], + "post": { + "description": "Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a user.\n\nYou can also assign a custom role to a user, but the preferred method to assign a custom role to a user is to create a binding between the custom role, the resource set, and the user. See [Create a role resource set binding](/openapi/okta-management/management/roledresourcesetbinding/createresourcesetbinding).\n\n> **Notes:**\n> * The request payload is different for standard and custom role assignments.\n> * For IAM-based standard role assignments, use the request payload for standard roles. However, the response payload for IAM-based role assignments is similar to the custom role's assignment response.", + "operationId": "assignRoleToUser", + "parameters": [ + { + "description": "Setting this to `true` grants the user third-party admin status", + "in": "query", + "name": "disableNotifications", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "APP_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "CUSTOM": "#/components/schemas/CustomRoleAssignmentSchema", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "ORG_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "REPORT_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "SUPER_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "USER_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "WORKFLOWS_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRoleAssignmentSchema" + }, + { + "$ref": "#/components/schemas/CustomRoleAssignmentSchema" + } + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "Custom roles": { + "$ref": "#/components/examples/CustomRoleResponseUser" + }, + "IAM-based standard roles": { + "$ref": "#/components/examples/IAMStandardRoleResponseUser" + }, + "Standard roles": { + "$ref": "#/components/examples/StandardRoleResponseUser" + } + }, + "schema": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/CustomRole", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/CustomRole", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRole", + "APP_ADMIN": "#/components/schemas/StandardRole", + "CUSTOM": "#/components/schemas/CustomRole", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRole", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRole", + "ORG_ADMIN": "#/components/schemas/StandardRole", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRole", + "REPORT_ADMIN": "#/components/schemas/StandardRole", + "SUPER_ADMIN": "#/components/schemas/StandardRole", + "USER_ADMIN": "#/components/schemas/StandardRole", + "WORKFLOWS_ADMIN": "#/components/schemas/CustomRole" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRole" + }, + { + "$ref": "#/components/schemas/CustomRole" + } + ], + "type": "object", + "x-okta-ignore-redocly-rules-for-sdk": true + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign a user role", + "tags": [ + "RoleAssignmentAUser" + ], + "x-codegen-request-body-name": "assignRoleRequest", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/roles/{roleAssignmentId}": { + "delete": { + "description": "Unassigns a role assignment (identified by `roleAssignmentId`) from a user (identified by `userId`)", + "operationId": "unassignRoleFromUser", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign a user role", + "tags": [ + "RoleAssignmentAUser" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a role assigned to a user (identified by `userId`). The `roleAssignmentId` parameter is the unique identifier for either a standard role assignment object or a custom role resource set binding object.", + "operationId": "getUserAssignedRole", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Custom roles": { + "$ref": "#/components/examples/CustomRoleResponseUser" + }, + "IAM-based standard roles": { + "$ref": "#/components/examples/IAMStandardRoleResponseUser" + }, + "Standard roles": { + "$ref": "#/components/examples/StandardRoleResponseUser" + } + }, + "schema": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/CustomRole", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/CustomRole", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRole", + "APP_ADMIN": "#/components/schemas/StandardRole", + "CUSTOM": "#/components/schemas/CustomRole", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRole", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRole", + "ORG_ADMIN": "#/components/schemas/StandardRole", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRole", + "REPORT_ADMIN": "#/components/schemas/StandardRole", + "SUPER_ADMIN": "#/components/schemas/StandardRole", + "USER_ADMIN": "#/components/schemas/StandardRole", + "WORKFLOWS_ADMIN": "#/components/schemas/CustomRole" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRole" + }, + { + "$ref": "#/components/schemas/CustomRole" + } + ] + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a user role assignment", + "tags": [ + "RoleAssignmentAUser" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + } + ] + }, + "/api/v1/users/{userId}/roles/{roleAssignmentId}/governance": { + "get": { + "description": "Retrieves the governance sources of a role (identified by `roleAssignmentId`) that's assigned to a user (identified by `userId`)", + "operationId": "getUserAssignedRoleGovernance", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/GetUseRoleGovernanceResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/RoleGovernance" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve all user role governance sources", + "tags": [ + "RoleAssignmentAUser" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + } + ] + }, + "/api/v1/users/{userId}/roles/{roleAssignmentId}/governance/{grantId}": { + "get": { + "description": "Retrieves a governance source (identified by `grantId`) for a role (identified by `roleAssignmentId`) that's assigned to a user (identified by `userId`)", + "operationId": "getRoleAssignmentGovernanceGrant", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/GetRoleAssignmentGovernanceGrantResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/RoleGovernanceSource" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a user role governance source", + "tags": [ + "RoleAssignmentAUser" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathGrantId" + } + ] + }, + "/api/v1/users/{userId}/roles/{roleAssignmentId}/governance/{grantId}/resources": { + "get": { + "description": "Retrieves the resources of a governance source (identified by `grantId`) for a role (identified by `roleAssignmentId`) that's assigned to a user (identified by `userId`)", + "operationId": "getRoleAssignmentGovernanceGrantResources", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example Response": { + "$ref": "#/components/examples/GetRoleAssignmentGovernanceGrantResources" + } + }, + "schema": { + "$ref": "#/components/schemas/RoleGovernanceResources" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve the user role governance source resources", + "tags": [ + "RoleAssignmentAUser" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathGrantId" + } + ] + }, + "/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/catalog/apps": { + "get": { + "description": "Lists all app targets for an `APP_ADMIN` role assigned to a user. The response is a list that includes OIN-cataloged apps or app instances. The response payload for an app instance contains the `id` property, but an OIN-cataloged app payload doesn't.", + "operationId": "listApplicationTargetsForApplicationAdministratorRoleForUser", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/CatalogApplication" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all admin role app targets", + "tags": [ + "RoleBTargetAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + } + ], + "put": { + "description": "Assigns all apps as target to an `APP_ADMIN` role", + "operationId": "assignAllAppsAsTargetToRoleForUser", + "responses": { + "200": { + "content": {}, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign all apps as target to admin role", + "tags": [ + "RoleBTargetAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}": { + "delete": { + "description": "Unassigns an OIN app target from an `APP_ADMIN` role assignment to an admin user.\n\n> **Note:** You can't remove the last OIN app target from a role assignment since this causes an exception.\n> If you need a role assignment that applies to all apps, delete the `APP_ADMIN` role assignment to the user and recreate a new one.\n", + "operationId": "unassignAppTargetFromAppAdminRoleForUser", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign an admin role app target", + "tags": [ + "RoleBTargetAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathAppName" + } + ], + "put": { + "description": "Assigns an OIN app target for an `APP_ADMIN` role assignment to an admin user. When you assign the first app target, you reduce the scope of the role assignment.\nThe role no longer applies to all app targets, but applies only to the specified target.\n\nAssigning an OIN app target overrides any existing app instance targets of the OIN app.\nFor example, if a user was assigned to administer a specific Facebook instance, a successful request to add an OIN app target with `facebook` for `appName` makes that user the admin for all Facebook instances.\n", + "operationId": "assignAppTargetToAdminRoleForUser", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign an admin role app target", + "tags": [ + "RoleBTargetAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}": { + "delete": { + "description": "Unassigns an app instance target from an `APP_ADMIN` role assignment to an admin user.\n\n> **Note:** You can't remove the last app instance target from a role assignment since this causes an exception.\n> If you need a role assignment that applies to all apps, delete the `APP_ADMIN` role assignment and recreate a new one.", + "operationId": "unassignAppInstanceTargetFromAdminRoleForUser", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign an admin role app instance target", + "tags": [ + "RoleBTargetAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathAppName" + }, + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "put": { + "description": "Assigns an app instance target to an `APP_ADMIN` role assignment to an admin user. When you assign the first OIN app or app instance target, you reduce the scope of the role assignment.\nThe role no longer applies to all app targets, but applies only to the specified target.\n\n> **Note:** You can target a mixture of both OIN app and app instance targets, but can't assign permissions to manage all instances of an OIN app and then assign a subset of permission to the same OIN app.\n> For example, you can't specify that an admin has access to manage all instances of the Salesforce app and then also manage specific configurations of the Salesforce app.\n", + "operationId": "assignAppInstanceTargetToAppAdminRoleForUser", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign an admin role app instance target", + "tags": [ + "RoleBTargetAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/groups": { + "get": { + "description": "Lists all group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to an admin user.\nIf the role isn't scoped to specific group targets, an empty array `[]` is returned.\n", + "operationId": "listGroupTargetsForRole", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Group" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all admin role group targets", + "tags": [ + "RoleBTargetAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + } + ] + }, + "/api/v1/users/{userId}/roles/{roleAssignmentId}/targets/groups/{groupId}": { + "delete": { + "description": "Unassigns a group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to an admin user.\n\n> **Note:** You can't remove the last group target from a role assignment since this causes an exception.\n> If you need a role assignment that applies to all groups, delete the role assignment to the user and recreate a new one.\n", + "operationId": "unassignGroupTargetFromUserAdminRole", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign an admin role group target", + "tags": [ + "RoleBTargetAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathGroupId" + } + ], + "put": { + "description": "Assigns a group target for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to an admin user.\nWhen you assign the first group target, you reduce the scope of the role assignment. The role no longer applies to all targets but applies only to the specified target.\n", + "operationId": "assignGroupTargetToUserRole", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign an admin role group target", + "tags": [ + "RoleBTargetAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/roles/{roleIdOrEncodedRoleId}/targets": { + "get": { + "description": "Retrieves all role targets for an `APP_ADMIN`, `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to an admin user by user or group assignment type.\nIf the role isn't scoped to specific group targets or any app targets, an empty array `[]` is returned.\n", + "operationId": "getRoleTargetsByUserIdAndRoleId", + "parameters": [ + { + "$ref": "#/components/parameters/assignmentType" + }, + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "App Instance Target": { + "$ref": "#/components/examples/RoleTargetAppInstanceResponse" + }, + "App Target": { + "$ref": "#/components/examples/RoleTargetAppResponse" + }, + "Group Target": { + "$ref": "#/components/examples/RoleTargetGroupResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/RoleTarget" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a role target by assignment type", + "tags": [ + "RoleBTargetAdmin" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathRoleIdOrEncodedRoleId" + } + ] + }, + "/api/v1/users/{userId}/sessions": { + "delete": { + "description": "Revokes all active identity provider sessions of the user. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.\n\nYou can also clear the user's remembered factors for all devices using the `forgetDevices` parameter. See [forgetDevices](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserSessions/#tag/UserSessions/operation/revokeUserSessions!in=query&path=forgetDevices&t=request).\n> **Note:** This operation doesn't clear the sessions created for web or native apps.", + "operationId": "revokeUserSessions", + "parameters": [ + { + "description": "Revokes issued OpenID Connect and OAuth refresh and access tokens", + "in": "query", + "name": "oauthTokens", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Clears the user's remembered factors for all devices.\n> **Note:** This parameter defaults to false in Classic Engine.", + "in": "query", + "name": "forgetDevices", + "schema": { + "default": true, + "type": "boolean" + } + } + ], + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Revoke all user sessions", + "tags": [ + "UserSessions" + ], + "x-okta-lifecycle": { + "isCorsEnabled": true, + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ] + }, + "/api/v1/users/{userId}/subscriptions": { + "get": { + "description": "Lists all subscriptions available to a specified user. Returns an `AccessDeniedException` message if requests are made for another user.", + "operationId": "listSubscriptionsUser", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "description": "The unique ID of the user", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Subscription" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all subscriptions for a user", + "tags": [ + "Subscription" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ] + }, + "/api/v1/users/{userId}/subscriptions/{notificationType}": { + "get": { + "description": "Retrieves a subscription by `notificationType` for a specified user. Returns an `AccessDeniedException` message if requests are made for another user.", + "operationId": "getSubscriptionsNotificationTypeUser", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "description": "The unique ID of the user", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pathNotificationType" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "Retrieve a subscription for a user", + "tags": [ + "Subscription" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathNotificationType" + } + ] + }, + "/api/v1/users/{userId}/subscriptions/{notificationType}/subscribe": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathNotificationType" + } + ], + "post": { + "description": "Subscribes the current user to a specified notification type. Returns an `AccessDeniedException` message if requests are made for another user.", + "operationId": "subscribeByNotificationTypeUser", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "description": "The unique ID of the user", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pathNotificationType" + } + ], + "responses": { + "200": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Subscribe a user to a specific notification type", + "tags": [ + "Subscription" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribe": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/pathNotificationType" + } + ], + "post": { + "description": "Unsubscribes the current user from a specified notification type. Returns an `AccessDeniedException` message if requests are made for another user.", + "operationId": "unsubscribeByNotificationTypeUser", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "description": "The unique ID of the user", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pathNotificationType" + } + ], + "responses": { + "200": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "description": "Not Found" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Unsubscribe a user from a specific notification type", + "tags": [ + "Subscription" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/zones": { + "get": { + "description": "Lists all Network Zones with pagination. A subset of zones can be returned that match a supported filter expression or query.\n\nThis operation requires URL encoding. For example, `filter=(id eq \"nzoul0wf9jyb8xwZm0g3\" or id eq \"nzoul1MxmGN18NDQT0g3\")` is encoded as `filter=%28id+eq+%22nzoul0wf9jyb8xwZm0g3%22+or+id+eq+%22nzoul1MxmGN18NDQT0g3%22%29`.\n\nOkta supports filtering on the `id`, `usage`, and `system` properties. See [Filter](https://developer.okta.com/docs/api/#filter) for more information on the expressions that are used in filtering.", + "operationId": "listNetworkZones", + "parameters": [ + { + "in": "query", + "name": "after", + "schema": { + "description": "Specifies the pagination cursor for the next page of Network Zones", + "example": "BlockedIpZones", + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "schema": { + "default": -1, + "description": "Specifies the number of results for a page", + "example": 5, + "format": "int32", + "type": "integer" + } + }, + { + "in": "query", + "name": "filter", + "schema": { + "description": "Filters zones by usage, ID, or system expression", + "example": "id eq \"nzowc1U5Jh5xuAK0o0g3\"", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "RetrieveAllZones": { + "$ref": "#/components/examples/RetrieveAllZones" + }, + "RetrieveAllZonesWithFilter": { + "$ref": "#/components/examples/RetrieveAllZonesWithFilter" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/NetworkZone" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.networkZones.read" + ] + } + ], + "summary": "List all network zones", + "tags": [ + "NetworkZone" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a Network Zone\n* For an IP Network Zone, you must define either `gateways` or `proxies`.\n* For a Dynamic Network Zone, you must define at least one of the following: `asns`, `locations`, or `proxyType`.\n* For an Enhanced Dynamic Network Zone, you must define at least one of the following: `asns`, `locations`, or `ipServiceCategories`.\n> **Note:** To view all properties for an Enhanced Dynamic Network Zone, select `DYNAMIC_V2` from the `type` dropdown list.", + "operationId": "createNetworkZone", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateEDNetworkZone": { + "$ref": "#/components/examples/CreateEDNZRequest" + }, + "CreateIPPolicyBlocklistNetworkZone": { + "$ref": "#/components/examples/CreateIPPolicyBlockListNetworkZone" + }, + "CreateIPPolicyNetworkZone": { + "$ref": "#/components/examples/CreateIPPolicyNetworkZone" + } + }, + "schema": { + "$ref": "#/components/schemas/NetworkZone" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "CreateEDNetworkZone": { + "$ref": "#/components/examples/CreateEDNZResponse" + }, + "CreateIPPolicyBlocklistNetworkZone": { + "$ref": "#/components/examples/CreateIPPolicyBlockListNetworkZoneResponse" + }, + "CreateIPPolicyNetworkZone": { + "$ref": "#/components/examples/CreateIPPolicyNetworkZoneResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/NetworkZone" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/NzErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.networkZones.manage" + ] + } + ], + "summary": "Create a network zone", + "tags": [ + "NetworkZone" + ], + "x-codegen-request-body-name": "zone", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/zones/{zoneId}": { + "delete": { + "description": "Deletes a Network Zone by `zoneId`\n> **Notes:**\n> * You can't delete a Network Zone that's used by a [Policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/policy/) or [Rule](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/policy/#tag/Policy/operation/listPolicyRules).\n> * For Okta Identity Engine orgs, you can't delete a Network Zone with an ACTIVE `status`. <x-lifecycle class=\"oie\"></x-lifecycle>", + "operationId": "deleteNetworkZone", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/NzErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.networkZones.manage" + ] + } + ], + "summary": "Delete a network zone", + "tags": [ + "NetworkZone" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a Network Zone by `zoneId`", + "operationId": "getNetworkZone", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "RetrieveNetworkZoneDynamic": { + "$ref": "#/components/examples/RetrieveNetworkZoneDynamic" + }, + "RetrieveNetworkZoneEnhancedDynamic": { + "$ref": "#/components/examples/CreateEDNZResponse" + }, + "RetrieveNetworkZoneIP": { + "$ref": "#/components/examples/RetrieveNetworkZoneIP" + } + }, + "schema": { + "$ref": "#/components/schemas/NetworkZone" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/NzErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.networkZones.read" + ] + } + ], + "summary": "Retrieve a network zone", + "tags": [ + "NetworkZone" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathZoneId" + } + ], + "put": { + "description": "Replaces a Network Zone by `zoneId`. The replaced Network Zone type must be the same as the existing type.\nYou can replace the usage (`POLICY`, `BLOCKLIST`) of a Network Zone by updating the `usage` attribute.\n\n**IP exempt zone**<br>\nIf you have the IP exempt zone feature enabled, you can allow traffic from specific gateway IPs irrespective of Okta ThreatInsight configurations, blocked network zones, or IP change events within Identity Threat Protection with Okta AI.<br>\n<br>\nWhen you enable this feature, Okta creates a zone called `DefaultExemptIpZone`. Gateway IPs that you add to this zone always have access to Okta resources. See [IP exempt zone](https://help.okta.com/okta_help.htm?type=oie&id=csh-about-ip-exempt-zone).\n\n> **Note:** You can't add trusted proxy IPs to this zone, delete the zone, or create additional exempt IP zones.", + "operationId": "replaceNetworkZone", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ReplaceNetworkZone": { + "$ref": "#/components/examples/ReplaceNetworkZone" + }, + "UpdateDefaultExemptIpZone": { + "$ref": "#/components/examples/UpdateDefaultExemptIpZone" + } + }, + "schema": { + "$ref": "#/components/schemas/NetworkZone" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ReplaceNetworkZone": { + "$ref": "#/components/examples/ReplaceNetworkZoneResponse" + }, + "UpdateDefaultExemptIpZoneResponse": { + "$ref": "#/components/examples/UpdateDefaultExemptIpZoneResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/NetworkZone" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/NzErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/NzErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.networkZones.manage" + ] + } + ], + "summary": "Replace a network zone", + "tags": [ + "NetworkZone" + ], + "x-codegen-request-body-name": "zone", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/zones/{zoneId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathZoneId" + } + ], + "post": { + "description": "Activates a Network Zone by `zoneId`", + "operationId": "activateNetworkZone", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ActivateNetworkZone": { + "$ref": "#/components/examples/ActivateNetworkZone" + } + }, + "schema": { + "$ref": "#/components/schemas/NetworkZone" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/NzErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.networkZones.manage" + ] + } + ], + "summary": "Activate a network zone", + "tags": [ + "NetworkZone" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/api/v1/zones/{zoneId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathZoneId" + } + ], + "post": { + "description": "Deactivates a Network Zone by `zoneId`", + "operationId": "deactivateNetworkZone", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "DeactivateNetworkZone": { + "$ref": "#/components/examples/DeactivateNetworkZone" + } + }, + "schema": { + "$ref": "#/components/schemas/NetworkZone" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/NzErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.networkZones.manage" + ] + } + ], + "summary": "Deactivate a network zone", + "tags": [ + "NetworkZone" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/attack-protection/api/v1/authenticator-settings": { + "get": { + "description": "Retrieves the Authenticator Settings for an org", + "operationId": "getAuthenticatorSettings", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttackProtectionAuthenticatorSettings" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "Retrieve the authenticator settings", + "tags": [ + "AttackProtection" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "put": { + "description": "Replaces the Authenticator Settings for an org", + "operationId": "replaceAuthenticatorSettings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttackProtectionAuthenticatorSettings" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttackProtectionAuthenticatorSettings" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Replace the authenticator settings", + "tags": [ + "AttackProtection" + ], + "x-codegen-request-body-name": "authenticatorSettings", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/attack-protection/api/v1/user-lockout-settings": { + "get": { + "description": "Retrieves the User Lockout Settings for an org", + "operationId": "getUserLockoutSettings", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserLockoutSettings" + } + } + }, + "description": "OK" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.read" + ] + } + ], + "summary": "Retrieve the user lockout settings", + "tags": [ + "AttackProtection" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces the User Lockout Settings for an org", + "operationId": "replaceUserLockoutSettings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserLockoutSettings" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserLockoutSettings" + } + } + }, + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "content": { + "application/json": { + "examples": { + "Access Denied": { + "$ref": "#/components/examples/ErrorAccessDenied" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Forbidden" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.orgs.manage" + ] + } + ], + "summary": "Replace the user lockout settings", + "tags": [ + "AttackProtection" + ], + "x-codegen-request-body-name": "lockoutSettings", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/integrations/api/v1/api-services": { + "get": { + "description": "Lists all API Service Integration instances with a pagination option", + "operationId": "listApiServiceIntegrationInstances", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "APIServiceIntegrationResponseExample": { + "$ref": "#/components/examples/APIServiceIntegrationListResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/APIServiceIntegrationInstance" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.oauthIntegrations.read" + ] + } + ], + "summary": "List all API service integration instances", + "tags": [ + "ApiServiceIntegrations" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates and authorizes an API Service Integration instance", + "operationId": "createApiServiceIntegrationInstance", + "requestBody": { + "content": { + "application/json": { + "examples": { + "postAPIServiceIntegrationRequestExample": { + "$ref": "#/components/examples/postAPIServiceIntegrationRequest" + }, + "postAPIServiceWithPropertiesIntegrationRequestExample": { + "$ref": "#/components/examples/postAPIServiceWithPropertiesIntegrationRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/postAPIServiceIntegrationInstanceRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "APIServiceIntegrationResponseExample": { + "$ref": "#/components/examples/postAPIServiceIntegrationResponse" + }, + "APIServiceWithPropertiesIntegrationResponseExample": { + "$ref": "#/components/examples/postAPIServiceWithPropertiesIntegrationResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/postAPIServiceIntegrationInstance" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.oauthIntegrations.manage" + ] + } + ], + "summary": "Create an API service integration instance", + "tags": [ + "ApiServiceIntegrations" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/integrations/api/v1/api-services/{apiServiceId}": { + "delete": { + "description": "Deletes an API Service Integration instance by `id`. This operation also revokes access to scopes that were previously granted to this API Service Integration instance.", + "operationId": "deleteApiServiceIntegrationInstance", + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.oauthIntegrations.manage" + ] + } + ], + "summary": "Delete an API service integration instance", + "tags": [ + "ApiServiceIntegrations" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an API Service Integration instance by `id`", + "operationId": "getApiServiceIntegrationInstance", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "APIServiceIntegrationResponseExample": { + "$ref": "#/components/examples/APIServiceIntegrationResponse" + }, + "APIServiceWithPropertiesIntegrationResponseExample": { + "$ref": "#/components/examples/APIServiceWithPropertiesIntegrationResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/APIServiceIntegrationInstance" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.oauthIntegrations.read" + ] + } + ], + "summary": "Retrieve an API service integration instance", + "tags": [ + "ApiServiceIntegrations" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathApiServiceId" + } + ] + }, + "/integrations/api/v1/api-services/{apiServiceId}/credentials/secrets": { + "get": { + "description": "Lists all client secrets for an API Service Integration instance by `apiServiceId`", + "operationId": "listApiServiceIntegrationInstanceSecrets", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "APIServiceIntegrationResponseExample": { + "$ref": "#/components/examples/APIServiceIntegrationInstanceSecretListResponse" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/APIServiceIntegrationInstanceSecret" + }, + "type": "array" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.oauthIntegrations.read" + ] + } + ], + "summary": "List all API service integration instance secrets", + "tags": [ + "ApiServiceIntegrations" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathApiServiceId" + } + ], + "post": { + "description": "Creates an API Service Integration instance Secret object with a new active client secret. You can create up to two Secret objects. An error is returned if you attempt to create more than two Secret objects.", + "operationId": "createApiServiceIntegrationInstanceSecret", + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "newAPIServiceIntegrationInstanceSecretResponse": { + "$ref": "#/components/examples/newAPIServiceIntegrationInstanceSecretResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/APIServiceIntegrationInstanceSecret" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.oauthIntegrations.manage" + ] + } + ], + "summary": "Create an API service integration instance secret", + "tags": [ + "ApiServiceIntegrations" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}": { + "delete": { + "description": "Deletes an API Service Integration instance Secret by `secretId`. You can only delete an inactive Secret.", + "operationId": "deleteApiServiceIntegrationInstanceSecret", + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.oauthIntegrations.manage" + ] + } + ], + "summary": "Delete an API service integration instance secret", + "tags": [ + "ApiServiceIntegrations" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathApiServiceId" + }, + { + "$ref": "#/components/parameters/pathSecretId" + } + ] + }, + "/integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/activate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathApiServiceId" + }, + { + "$ref": "#/components/parameters/pathSecretId" + } + ], + "post": { + "description": "Activates an API Service Integration instance Secret by `secretId`", + "operationId": "activateApiServiceIntegrationInstanceSecret", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "activeAPIServiceIntegrationInstanceSecretResponse": { + "$ref": "#/components/examples/activeAPIServiceIntegrationInstanceSecretResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/APIServiceIntegrationInstanceSecret" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.oauthIntegrations.manage" + ] + } + ], + "summary": "Activate an API service integration instance secret", + "tags": [ + "ApiServiceIntegrations" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/deactivate": { + "parameters": [ + { + "$ref": "#/components/parameters/pathApiServiceId" + }, + { + "$ref": "#/components/parameters/pathSecretId" + } + ], + "post": { + "description": "Deactivates an API Service Integration instance Secret by `secretId`", + "operationId": "deactivateApiServiceIntegrationInstanceSecret", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "inactiveAPIServiceIntegrationInstanceSecretResponse": { + "$ref": "#/components/examples/inactiveAPIServiceIntegrationInstanceSecretResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/APIServiceIntegrationInstanceSecret" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/ErrorInvalidToken401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.oauthIntegrations.manage" + ] + } + ], + "summary": "Deactivate an API service integration instance secret", + "tags": [ + "ApiServiceIntegrations" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/integrations/api/v1/submissions": {}, + "/integrations/api/v1/submissions/integration-capabilities/{status}": { + "parameters": [ + { + "$ref": "#/components/parameters/IntegrationCapabilityStatus" + } + ] + }, + "/integrations/api/v1/submissions/logo": {}, + "/integrations/api/v1/submissions/logo/default": {}, + "/integrations/api/v1/submissions/{submissionId}": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/auth-settings/default": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/capabilities": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/capabilities/api-service/protocols/oauth2": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/capabilities/idv/protocols/id-proofing": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/capabilities/{capability}/auth-settings/default": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + }, + { + "$ref": "#/components/parameters/pathCapability" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/capabilities/{capability}/protocols/actions": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + }, + { + "$ref": "#/components/parameters/pathCapability" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/capabilities/{capability}/protocols/actions/actions-provider/{actionsProviderType}/available-actions": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + }, + { + "$ref": "#/components/parameters/pathCapability" + }, + { + "$ref": "#/components/parameters/pathActionsProviderType" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/capabilities/{capability}/protocols/actions/actions-provider/{actionsProviderType}/validate-actions": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + }, + { + "$ref": "#/components/parameters/pathCapability" + }, + { + "$ref": "#/components/parameters/pathActionsProviderType" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/express-configuration": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/submit": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/tenant-settings": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + } + ] + }, + "/integrations/api/v1/submissions/{submissionId}/testing": { + "parameters": [ + { + "$ref": "#/components/parameters/pathSubmissionId" + } + ] + }, + "/oauth2/v1/clients/{clientId}/roles": { + "get": { + "description": "Lists all roles assigned to a client app identified by `clientId`", + "operationId": "listRolesForClient", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Custom roles": { + "$ref": "#/components/examples/CustomRolesListResponseClient" + }, + "IAM-based standard roles": { + "$ref": "#/components/examples/IAMStandardRolesListResponseClient" + }, + "Standard roles": { + "$ref": "#/components/examples/StandardRolesListResponseClient" + } + }, + "schema": { + "items": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/CustomRole", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/CustomRole", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRole", + "APP_ADMIN": "#/components/schemas/StandardRole", + "CUSTOM": "#/components/schemas/CustomRole", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRole", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRole", + "ORG_ADMIN": "#/components/schemas/StandardRole", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRole", + "REPORT_ADMIN": "#/components/schemas/StandardRole", + "SUPER_ADMIN": "#/components/schemas/StandardRole", + "USER_ADMIN": "#/components/schemas/StandardRole", + "WORKFLOWS_ADMIN": "#/components/schemas/CustomRole" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRole" + }, + { + "$ref": "#/components/schemas/CustomRole" + } + ] + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all client role assignments", + "tags": [ + "RoleAssignmentClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathClientId" + } + ], + "post": { + "description": "Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a client app.\n\nYou can also assign a custom role to a client app, but the preferred method to assign a custom role to a client is to create a binding between the custom role, the resource set, and the client app. See [Create a role resource set binding](/openapi/okta-management/management/roledresourcesetbinding/createresourcesetbinding).\n\n> **Notes:**\n> * The request payload is different for standard and custom role assignments.\n> * For IAM-based standard role assignments, use the request payload for standard roles. However, the response payload for IAM-based role assignments is similar to the custom role's assignment response.", + "operationId": "assignRoleToClient", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Custom role assignment": { + "$ref": "#/components/examples/CustomRoleAssignmentRequest" + }, + "Standard role": { + "$ref": "#/components/examples/StandardRoleAssignmentRequest" + } + }, + "schema": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "APP_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "CUSTOM": "#/components/schemas/CustomRoleAssignmentSchema", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "ORG_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "REPORT_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "SUPER_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "USER_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema", + "WORKFLOWS_ADMIN": "#/components/schemas/StandardRoleAssignmentSchema" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRoleAssignmentSchema" + }, + { + "$ref": "#/components/schemas/CustomRoleAssignmentSchema" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Custom role assignment": { + "$ref": "#/components/examples/CustomRoleResponseClient" + }, + "IAM-based role assignment": { + "$ref": "#/components/examples/IAMStandardRolesListResponseClient" + }, + "Standard role": { + "$ref": "#/components/examples/StandardRoleResponseClient" + } + }, + "schema": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/CustomRole", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/CustomRole", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRole", + "APP_ADMIN": "#/components/schemas/StandardRole", + "CUSTOM": "#/components/schemas/CustomRole", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRole", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRole", + "ORG_ADMIN": "#/components/schemas/StandardRole", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRole", + "REPORT_ADMIN": "#/components/schemas/StandardRole", + "SUPER_ADMIN": "#/components/schemas/StandardRole", + "USER_ADMIN": "#/components/schemas/StandardRole", + "WORKFLOWS_ADMIN": "#/components/schemas/CustomRole" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRole" + }, + { + "$ref": "#/components/schemas/CustomRole" + } + ] + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign a client role", + "tags": [ + "RoleAssignmentClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}": { + "delete": { + "description": "Unassigns a role assignment (identified by `roleAssignmentId`) from a client app (identified by `clientId`)", + "operationId": "deleteRoleFromClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign a client role", + "tags": [ + "RoleAssignmentClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves a role assignment (identified by `roleAssignmentId`) for a client app (identified by `clientId`)", + "operationId": "retrieveClientRole", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Custom role assignment": { + "$ref": "#/components/examples/CustomRoleResponseClient" + }, + "IAM-based standard role assignment": { + "$ref": "#/components/examples/IAMStandardRoleResponseClient" + }, + "Standard role": { + "$ref": "#/components/examples/StandardRoleResponseClient" + } + }, + "schema": { + "discriminator": { + "mapping": { + "ACCESS_CERTIFICATIONS_ADMIN": "#/components/schemas/CustomRole", + "ACCESS_REQUESTS_ADMIN": "#/components/schemas/CustomRole", + "API_ACCESS_MANAGEMENT_ADMIN": "#/components/schemas/StandardRole", + "APP_ADMIN": "#/components/schemas/StandardRole", + "CUSTOM": "#/components/schemas/CustomRole", + "GROUP_MEMBERSHIP_ADMIN": "#/components/schemas/StandardRole", + "HELP_DESK_ADMIN": "#/components/schemas/StandardRole", + "ORG_ADMIN": "#/components/schemas/StandardRole", + "READ_ONLY_ADMIN": "#/components/schemas/StandardRole", + "REPORT_ADMIN": "#/components/schemas/StandardRole", + "SUPER_ADMIN": "#/components/schemas/StandardRole", + "USER_ADMIN": "#/components/schemas/StandardRole", + "WORKFLOWS_ADMIN": "#/components/schemas/CustomRole" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/StandardRole" + }, + { + "$ref": "#/components/schemas/CustomRole" + } + ] + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "Retrieve a client role", + "tags": [ + "RoleAssignmentClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathClientId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + } + ] + }, + "/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/catalog/apps": { + "get": { + "description": "Lists all OIN app targets for an `APP_ADMIN` role that's assigned to a client (by `clientId`).", + "operationId": "listAppTargetRoleToClient", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ClientRoleTargetExample": { + "$ref": "#/components/examples/ClientRoleTargetResponseFacebookEx" + }, + "ClientRoleTargetNonOINExample": { + "$ref": "#/components/examples/ClientRoleTargetResponseInstanceEx" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/CatalogApplication" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all client role app targets", + "tags": [ + "RoleBTargetClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathClientId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + } + ] + }, + "/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}": { + "delete": { + "description": "Unassigns an OIN app target for a role assignment to a client app\n\n> **Note:** You can't remove the last OIN app target from a role assignment.\n> If you need a role assignment that applies to all apps, delete the role assignment with the target and create another one. See [Unassign a client role](/openapi/okta-management/management/tags/roleassignmentclient/other/deleterolefromclient).", + "operationId": "removeAppTargetRoleFromClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign a client role app target", + "tags": [ + "RoleBTargetClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathClientId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathAppName" + } + ], + "put": { + "description": "Assigns an OIN app target for an `APP_ADMIN` role assignment to a client. When you assign an app target from the OIN catalog, you reduce the scope of the role assignment.\nThe role assignment applies to only app instances that are included in the specified OIN app target.\n\nAn assigned OIN app target overrides any existing app instance targets.\nFor example, if a user is assigned to administer a specific Facebook instance, a successful request to add an OIN app target with `facebook` for `appName` makes that user the administrator for all Facebook instances.", + "operationId": "assignAppTargetRoleToClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign a client role app target", + "tags": [ + "RoleBTargetClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}": { + "delete": { + "description": "Unassigns an app instance target from a role assignment to a client app\n\n> **Note:** You can't remove the last app instance target from a role assignment.\n> If you need a role assignment that applies to all the apps, delete the role assignment with the instance target and create another one. See [Unassign a client role](/openapi/okta-management/management/tags/roleassignmentclient/other/deleterolefromclient).", + "operationId": "removeAppTargetInstanceRoleForClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign a client role app instance target", + "tags": [ + "RoleBTargetClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathClientId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathAppName" + }, + { + "$ref": "#/components/parameters/pathAppId" + } + ], + "put": { + "description": "Assigns an app instance target to an `APP_ADMIN` role assignment to a client. When you assign the first OIN app or app instance target, you reduce the scope of the role assignment.\nThe role no longer applies to all app targets, but applies only to the specified target.\n\n> **Note:** You can target a mixture of both OIN app and app instance targets, but you can't assign permissions to manage all instances of an OIN app and then assign a subset of permissions to the same app.\nFor example, you can't specify that an admin has access to manage all instances of the Salesforce app and then also manage only specific configurations of the Salesforce app.", + "operationId": "assignAppTargetInstanceRoleForClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign a client role app instance target", + "tags": [ + "RoleBTargetClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/groups": { + "get": { + "description": "Lists all group targets for a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client. If the role isn't scoped to specific group targets, Okta returns an empty array `[]`.", + "operationId": "listGroupTargetRoleForClient", + "parameters": [ + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/queryLimit" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Group" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.read" + ] + } + ], + "summary": "List all client role group targets", + "tags": [ + "RoleBTargetClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathClientId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + } + ] + }, + "/oauth2/v1/clients/{clientId}/roles/{roleAssignmentId}/targets/groups/{groupId}": { + "delete": { + "description": "Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client app.\n\n> **Note:** You can't remove the last group target from a role assignment. If you need a role assignment that applies to all groups, delete the role assignment with the target and create another one. See [Unassign a client role](/openapi/okta-management/management/tags/roleassignmentclient/other/deleterolefromclient).", + "operationId": "removeGroupTargetRoleFromClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Unassign a client role group target", + "tags": [ + "RoleBTargetClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathClientId" + }, + { + "$ref": "#/components/parameters/pathRoleAssignmentId" + }, + { + "$ref": "#/components/parameters/pathGroupId" + } + ], + "put": { + "description": "Assigns a group target to a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client app. When you assign the first group target, you reduce the scope of the role assignment. The role no longer applies to all targets, but applies only to the specified target.", + "operationId": "assignGroupTargetRoleForClient", + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.roles.manage" + ] + } + ], + "summary": "Assign a client role group target", + "tags": [ + "RoleBTargetClient" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/okta-personal-settings/api/v1/edit-feature": { + "put": { + "description": "Replaces Okta Personal admin settings in a Workforce org", + "operationId": "replaceOktaPersonalAdminSettings", + "requestBody": { + "content": { + "application/json": { + "examples": { + "exampleSettings": { + "$ref": "#/components/examples/editFeatureExample" + } + }, + "schema": { + "$ref": "#/components/schemas/OktaPersonalAdminFeatureSettings" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/Error-FF-NotEnabled-Response-401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.personal.adminSettings.manage" + ] + } + ], + "summary": "Replace the Okta Personal admin settings", + "tags": [ + "OktaPersonalSettings" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/okta-personal-settings/api/v1/export-blocklists": { + "get": { + "description": "Lists all blocked email domains which are excluded from app migration", + "operationId": "listPersonalAppsExportBlockList", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "exampleSettings": { + "$ref": "#/components/examples/getBlockListExample" + } + }, + "schema": { + "$ref": "#/components/schemas/PersonalAppsBlockList" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/Error-FF-NotEnabled-Response-401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.personal.adminSettings.read" + ] + } + ], + "summary": "List all blocked email domains", + "tags": [ + "OktaPersonalSettings" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + "put": { + "description": "Replaces the list of blocked email domains which are excluded from app migration", + "operationId": "replaceBlockedEmailDomains", + "requestBody": { + "content": { + "application/json": { + "examples": { + "exampleSettings": { + "$ref": "#/components/examples/getBlockListExample" + } + }, + "schema": { + "$ref": "#/components/schemas/PersonalAppsBlockList" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/Error-FF-NotEnabled-Response-401" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.personal.adminSettings.manage" + ] + } + ], + "summary": "Replace the blocked email domains", + "tags": [ + "OktaPersonalSettings" + ], + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + } + }, + "/privileged-access/api/v1/containers/{containerId}/prepare-resources": { + "parameters": [ + { + "$ref": "#/components/parameters/containerId" + }, + { + "$ref": "#/components/parameters/privQueryLastUpdated" + } + ] + }, + "/privileged-access/api/v1/containers/{containerId}/resource-filter-criteria": { + "parameters": [ + { + "$ref": "#/components/parameters/containerId" + } + ] + }, + "/privileged-access/api/v1/containers/{containerId}/resources": { + "parameters": [ + { + "$ref": "#/components/parameters/containerId" + }, + { + "$ref": "#/components/parameters/privQueryLastUpdated" + }, + { + "$ref": "#/components/parameters/privQueryStatus" + }, + { + "$ref": "#/components/parameters/privQueryLimit" + }, + { + "$ref": "#/components/parameters/privQueryAfter" + } + ] + }, + "/privileged-access/api/v1/okta-service-accounts": { + "get": { + "description": "Lists all Okta managed user accounts in your org.\n\nUse the `match` parameter to search for accounts where the account name (`name`) or username (`username`) contains the specified value.", + "operationId": "listOktaManagedUserAccounts", + "parameters": [ + { + "$ref": "#/components/parameters/queryLimit" + }, + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/oktaManagedUserMatchQueryFilter" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListOktaManagedUserAccounts": { + "$ref": "#/components/examples/ListOktaManagedUserAccounts" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/OktaManagedUserAccountResponse" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.serviceAccounts.okta.read" + ] + } + ], + "summary": "List all Okta managed user accounts", + "tags": [ + "OktaManagedUserAccount" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new Okta managed user account for managing a Universal Directory user as a service account.\n\nYou must specify an existing Okta user in your org with the `oktaUserId` request parameter.", + "operationId": "createOktaManagedUserAccount", + "requestBody": { + "content": { + "application/json": { + "examples": { + "CreateOktaManagedUserAccount": { + "$ref": "#/components/examples/CreateOktaManagedUserAccountRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/OktaManagedUserAccountRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "examples": { + "OktaManagedUserAccountResponse": { + "$ref": "#/components/examples/OktaManagedUserAccountResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OktaManagedUserAccountResponse" + } + } + }, + "description": "Created" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.serviceAccounts.okta.manage" + ] + } + ], + "summary": "Create an Okta managed user account", + "tags": [ + "OktaManagedUserAccount" + ], + "x-codegen-request-body-name": "body", + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/privileged-access/api/v1/okta-service-accounts/{id}": { + "delete": { + "description": "Deletes an Okta managed user account specified by ID.\n\nThis operation removes the service account management for the Okta user, suspends the underlying Okta user account,\nbut doesn't delete the user from Universal Directory.", + "operationId": "deleteOktaManagedUserAccount", + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.serviceAccounts.okta.manage" + ] + } + ], + "summary": "Delete an Okta managed user account", + "tags": [ + "OktaManagedUserAccount" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an Okta managed user account specified by ID", + "operationId": "getOktaManagedUserAccount", + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OktaManagedUserAccountResponse": { + "$ref": "#/components/examples/OktaManagedUserAccountResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OktaManagedUserAccountResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.serviceAccounts.okta.read" + ] + } + ], + "summary": "Retrieve an Okta managed user account", + "tags": [ + "OktaManagedUserAccount" + ], + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/oktaManagedUserAccountId" + } + ], + "patch": { + "description": "Updates an existing Okta managed user account specified by ID.\n\nYou can only update the `name`, `description`, `ownerUserIds`, and `ownerGroupIds` properties.", + "operationId": "updateOktaManagedUserAccount", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UpdateOktaManagedUserAccount": { + "$ref": "#/components/examples/UpdateOktaManagedUserAccountRequest" + } + }, + "schema": { + "$ref": "#/components/schemas/OktaManagedUserAccountForUpdate" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "OktaManagedUserAccountResponse": { + "$ref": "#/components/examples/OktaManagedUserAccountResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/OktaManagedUserAccountResponse" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.serviceAccounts.okta.manage" + ] + } + ], + "summary": "Update an Okta managed user account", + "tags": [ + "OktaManagedUserAccount" + ], + "x-codegen-request-body-name": "body", + "x-okta-iam-admin-roles": [ + "SUPER_ADMIN" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/privileged-access/api/v1/resources": {}, + "/privileged-access/api/v1/resources/{id}": { + "parameters": [ + { + "$ref": "#/components/parameters/privilegedResourceId" + } + ] + }, + "/privileged-access/api/v1/resources/{id}/claim": { + "parameters": [ + { + "$ref": "#/components/parameters/privilegedResourceId" + } + ] + }, + "/privileged-access/api/v1/resources/{id}/rotate-password": { + "parameters": [ + { + "$ref": "#/components/parameters/privilegedResourceId" + } + ] + }, + "/privileged-access/api/v1/service-accounts": { + "get": { + "description": "Lists all app service accounts", + "operationId": "listAppServiceAccounts", + "parameters": [ + { + "$ref": "#/components/parameters/queryLimit" + }, + { + "$ref": "#/components/parameters/queryAfter" + }, + { + "$ref": "#/components/parameters/matchQueryFilter" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ListAppServiceAccounts": { + "$ref": "#/components/examples/ListAppServiceAccounts" + } + }, + "schema": { + "items": { + "$ref": "#/components/schemas/AppServiceAccount" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.serviceAccounts.read" + ] + } + ], + "summary": "List all app service accounts", + "tags": [ + "ServiceAccount" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "post": { + "description": "Creates a new app service account for managing an app account", + "operationId": "createAppServiceAccount", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppServiceAccount" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppServiceAccount" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.serviceAccounts.manage" + ] + } + ], + "summary": "Create an app service account", + "tags": [ + "ServiceAccount" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/privileged-access/api/v1/service-accounts/{id}": { + "delete": { + "description": "Deletes an app service account specified by ID", + "operationId": "deleteAppServiceAccount", + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.serviceAccounts.manage" + ] + } + ], + "summary": "Delete an app service account", + "tags": [ + "ServiceAccount" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "get": { + "description": "Retrieves an app service account specified by ID", + "operationId": "getAppServiceAccount", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppServiceAccount" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.serviceAccounts.read" + ] + } + ], + "summary": "Retrieve an app service account", + "tags": [ + "ServiceAccount" + ], + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/serviceAccountId" + } + ], + "patch": { + "description": "Updates an existing app service account specified by ID", + "operationId": "updateAppServiceAccount", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppServiceAccountForUpdate" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppServiceAccount" + } + } + }, + "description": "Success" + }, + "400": { + "$ref": "#/components/responses/ErrorApiValidationFailed400" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.serviceAccounts.manage" + ] + } + ], + "summary": "Update an existing app service account", + "tags": [ + "ServiceAccount" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + } + }, + "/security/api/v1/security-events": { + "post": { + "description": "Publishes a security event token (SET) sent by a security events provider. After the token is verified, Okta ingests the event and performs any appropriate action.", + "operationId": "publishSecurityEventTokens", + "requestBody": { + "content": { + "application/secevent+jwt": { + "examples": { + "SET": { + "value": "eyJraWQiOiJzYW1wbGVfa2lkIiwidHlwIjoic2ZXZlbnQra ... mrtmw" + } + }, + "schema": { + "type": "string" + } + } + }, + "description": "The request body is a signed [SET](https://datatracker.ietf.org/doc/html/rfc8417), which is a type of JSON Web Token (JWT).\n\nFor SET JWT header and body descriptions, see [SET JWT header](/openapi/okta-management/management/ssfsecurityeventtoken/securityeventtokenrequestjwtheader) and [SET JWT body payload](/openapi/okta-management/management/ssfsecurityeventtoken/securityeventtokenrequestjwtbody).\n", + "required": true + }, + "responses": { + "202": { + "description": "Accepted" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecurityEventTokenError" + } + } + }, + "description": "Bad Request" + } + }, + "security": [], + "summary": "Publish a security event token", + "tags": [ + "SSFSecurityEventToken" + ], + "x-codegen-request-body-name": "Security Event Token", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/webauthn-registration/api/v1/activate": { + "post": { + "description": "Activates a preregistered WebAuthn factor. As part of this operation, Okta first decrypts and verifies the factor PIN and enrollment data sent by the fulfillment provider.", + "operationId": "activatePreregistrationEnrollment", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Activate Preregistration Enrollment Request": { + "$ref": "#/components/examples/EnrollmentActivationRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/EnrollmentActivationRequest" + } + } + }, + "description": "Enrollment activation request" + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Activate Preregistration Enrollment Response": { + "$ref": "#/components/examples/EnrollmentActivationResponseExample" + } + }, + "schema": { + "$ref": "#/components/schemas/EnrollmentActivationResponse" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "examples": { + "NoDisable": { + "$ref": "#/components/examples/ErrorPinOrCredResponsesProcessingFailure" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "PIN or cred requests generation failed" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Activate a preregistered WebAuthn factor", + "tags": [ + "WebAuthnPreregistration" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/webauthn-registration/api/v1/enroll": { + "post": { + "description": "Enrolls a preregistered WebAuthn factor. This WebAuthn factor has a longer challenge timeout period to accommodate the fulfillment request process. As part of this operation, Okta generates elliptic curve (EC) key-pairs used to encrypt the factor PIN and enrollment data sent by the fulfillment provider.", + "operationId": "enrollPreregistrationEnrollment", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Initialize Preregistration Enrollment Request": { + "$ref": "#/components/examples/EnrollmentInitializationRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/EnrollmentInitializationRequest" + } + } + }, + "description": "Enrollment initialization request" + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Initialize Preregistration Enrollment Response": { + "$ref": "#/components/examples/EnrollmentInitializationResponseExample" + } + }, + "schema": { + "$ref": "#/components/schemas/EnrollmentInitializationResponse" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "examples": { + "NoDisable": { + "$ref": "#/components/examples/ErrorPinOrCredRequestsGenerationFailure" + } + }, + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "PIN or cred requests generation failed" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Enroll a preregistered WebAuthn factor", + "tags": [ + "WebAuthnPreregistration" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/webauthn-registration/api/v1/initiate-fulfillment-request": { + "post": { + "description": "Generates a fulfillment request by sending a WebAuthn preregistration event to start the flow. The WebAuthn preregistration integration for Okta Workflows uses a preregistration event to populate the fulfillment request.", + "operationId": "generateFulfillmentRequest", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Generate Fulfillment Request": { + "$ref": "#/components/examples/GenerateFulfillmentRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/FulfillmentRequest" + } + } + }, + "description": "Fulfillment request" + }, + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Generate a fulfillment request", + "tags": [ + "WebAuthnPreregistration" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/webauthn-registration/api/v1/send-pin": { + "post": { + "description": "Sends the decoded PIN for the specified WebAuthn preregistration enrollment. PINs are sent to the user's email. To resend the PIN, call this operation again.", + "operationId": "sendPin", + "requestBody": { + "content": { + "application/json": { + "examples": { + "Send PIN Request": { + "$ref": "#/components/examples/SendPinRequestExample" + } + }, + "schema": { + "$ref": "#/components/schemas/PinRequest" + } + } + }, + "description": "Send PIN request" + }, + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Send a PIN to user", + "tags": [ + "WebAuthnPreregistration" + ], + "x-codegen-request-body-name": "body", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + }, + "/webauthn-registration/api/v1/users/{userId}/enrollments": { + "get": { + "description": "Lists all WebAuthn preregistration factors for the specified user", + "operationId": "listWebAuthnPreregistrationFactors", + "responses": { + "200": { + "content": { + "application/json": { + "example": [ + { + "_links": { + "self": { + "hints": { + "allow": [ + "DELETE" + ] + }, + "href": "https://example.okta.com/webauthn-registration/api/v1/users/00u15s1KDETTQMQYABRL/enrollments/fwf23789dfs9asdf782" + } + }, + "created": "2018-05-24T20:43:19.000Z", + "factorType": "webauthn", + "fulfillmentProvider": "yubico", + "id": "fwf23789dfs9asdf782", + "lastUpdated": "2018-05-24T21:43:32.000Z", + "profile": { + "authenticatorName": "YubiKey 5C", + "credentialId": "l3Br0n-7H3g047NqESqJynFtIgf3Ix9OfaRoNwLoloso99Xl2zS_O7EXUkmPeAIzTVtEL4dYjicJWBz7NpqhGA", + "presetPinAvailable": true + }, + "provider": "FIDO", + "status": "ACTIVE", + "vendorName": "FIDO" + } + ], + "schema": { + "items": { + "$ref": "#/components/schemas/WebAuthnPreregistrationFactor" + }, + "type": "array" + } + } + }, + "description": "Success" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.read" + ] + } + ], + "summary": "List all WebAuthn preregistration factors", + "tags": [ + "WebAuthnPreregistration" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + } + ] + }, + "/webauthn-registration/api/v1/users/{userId}/enrollments/{authenticatorEnrollmentId}": { + "delete": { + "description": "Deletes a specific WebAuthn preregistration factor for a user", + "operationId": "deleteWebAuthnPreregistrationFactor", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Delete a WebAuthn preregistration factor", + "tags": [ + "WebAuthnPreregistration" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/authenticatorEnrollmentId" + } + ] + }, + "/webauthn-registration/api/v1/users/{userId}/enrollments/{authenticatorEnrollmentId}/mark-error": { + "parameters": [ + { + "$ref": "#/components/parameters/pathUserId" + }, + { + "$ref": "#/components/parameters/authenticatorEnrollmentId" + } + ], + "post": { + "description": "Assigns the fulfillment error status to a WebAuthn preregistration factor for a user. The `/mark-error` path indicates that the specific `FULFILLMENT_ERRORED` AuthFactor status is set on the enrollment.", + "operationId": "assignFulfillmentErrorWebAuthnPreregistrationFactor", + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + }, + "404": { + "$ref": "#/components/responses/ErrorResourceNotFound404" + }, + "429": { + "$ref": "#/components/responses/ErrorTooManyRequests429" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [ + "okta.users.manage" + ] + } + ], + "summary": "Assign the fulfillment error status to a WebAuthn preregistration factor", + "tags": [ + "WebAuthnPreregistration" + ], + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + } + } + }, + "servers": [ + { + "url": "https://{yourOktaDomain}", + "variables": { + "yourOktaDomain": { + "default": "subdomain.okta.com", + "description": "The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains." + } + } + } + ], + "tags": [ + { + "description": "The Agent Pools API provides operations to manage the update settings of the directory agents for your org.", + "name": "AgentPools", + "x-displayName": "Directory Agent Pools" + }, + { + "description": "This API provides operations to manage API service integration instances in your org.\n\nFor a current list of available API service integrations, see the [Okta Integration Network catalog](https://www.okta.com/integrations/?capability=api).\n\nSee [Add an API Service Integration](https://help.okta.com/okta_help.htm?type=oie&id=ext-add-api-service-integration) for corresponding admin instructions using the Admin Console.\nIf you want to build an API service integration, see [API service integrations in the OIN](https://developer.okta.com/docs/guides/oin-api-service-overview/).\n", + "name": "ApiServiceIntegrations", + "x-displayName": "API Service Integrations" + }, + { + "description": "The API Tokens API provides operations to manage SSWS API tokens for your org.", + "name": "ApiToken", + "x-displayName": "API Tokens" + }, + { + "description": "The Applications API provides operations to manage apps in your org.\n\nTo create a custom app integration instance, use the [Create an Application](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/application/other/createapplication) operation with the schema provided in the request payload.\n\nTo create an app instance from the Okta Integration Network (OIN), use the [Create an Application](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/application/other/createapplication)\noperation with the corresponding OIN app schema in the request body.", + "name": "Application", + "x-displayName": "Applications" + }, + { + "description": "The Application Connections API provides operations for configuring connections to an app.\n\nOkta supports token-based and OAuth 2.0-based provisioning connections for supported apps.\nThe following available provisioning connections are supported by the indicated apps:\n\n | <div style=\"width:100px\">Connection</div> | Description | <div style=\"width:150px\">Apps supported</div> |\n | -------------------------------- | -------------- | ----------- |\n | Token | The provisioning API connection is based on bearer token authentication. | <ul><li>Okta Org2Org (`okta_org2org`)</li> <li>Zscaler 2.0 (`zscalerbyz`)</li></ul> |\n | OAuth 2.0 | The provisioning API connection is based on OAuth 2.0 authentication. | <ul><li>Google Workspace (`google`)</li> <li>Microsoft Office 365 (`office365`)</li> <li>Okta Org2Org (`okta_org2org`)</li> <li>Slack (`slack`)</li> <li>Zoom (`zoomus`)</li></ul> |\n\n > **Note:** The Okta Org2Org (`okta_org2org`) app isn't available in Okta Integrator Free Plan orgs. If you need to test this feature in your Integrator Free Plan org, contact your Okta account team.\n", + "name": "ApplicationConnections", + "x-displayName": "Application Connections" + }, + { + "description": "The Application Cross App Access Connections API provides operations to configure and manage Cross App Access connections between a requesting app and a resource app.\n\nTo establish the Cross App Access connection, both the requesting app and the resource app must support the `Connect with Okta` App Feature.\n", + "name": "ApplicationCrossAppAccessConnections", + "x-displayName": "Application Cross App Access Connections" + }, + { + "description": "The Application Features API supports operations to configure app provisioning feature settings.\n\nYou must have app provisioning enabled to configure provisioning features. See [Update the default Provisioning Connection](https://developer.okta.com/docs/api/openapi/okta-management/management/applicationconnections/updatedefaultprovisioningconnectionforapplication).\n\nThe following available provisioning features are supported by the indicated apps:\n\n| <div style=\"width:190px\">Feature</div> | Description | <div style=\"width:150px\">Apps supported</div> |\n| -------------------- | -------------- | ----------- |\n| `USER_PROVISIONING` | Similar to the app **Provisioning** > **To App** setting in the Admin Console, user profiles are pushed from Okta to the third-party app. You can configure rules for creating users, deactivating users, and syncing passwords. | <ul><li>Google Workspace (`google`)</li> <li>Microsoft Office 365 (`office365`)</li> <li>Okta Org2Org (`okta_org2org`)</li> <li>Slack (`slack`)</li> <li>Zoom (`zoomus`)</li> <li>Zscaler 2.0 (`zscalerbyz`)</li></ul> |\n| `INBOUND_PROVISIONING` | Similar to the app **Provisioning** > **To Okta** provisioning setting in the Admin Console, user profiles are imported from the third-party app into Okta. You can schedule user import and configure rules for user creation and matching. | <ul><li>Google Workspace (`google`)</li> <li>Microsoft Office 365 (`office365`)</li> <li>Okta Org2Org (`okta_org2org`)</li> <li>Slack (`slack`)</li> <li>Zoom (`zoomus`)</li></ul> |\n\n> **Note:** The Okta Org2Org (`okta_org2org`) app isn't available in Okta Integrator Free Plan orgs. If you need to test this feature in your Integrator Free Plan org, contact your Okta account team.\n", + "name": "ApplicationFeatures", + "x-displayName": "Application Features" + }, + { + "description": "The Application Grants API provides a set of operations to manage scope consent grants for an app.\n\nA scope consent grant represents an app's permission to include specific Okta scopes in OAuth 2.0 Bearer tokens.\nIf the app doesn't have permission to grant consent for a particular Okta scope, token requests that contain the scope are denied.\n", + "name": "ApplicationGrants", + "x-displayName": "Application Grants" + }, + { + "description": "The Application Groups API provides a set of operations to manage group assignment for an app.", + "name": "ApplicationGroups", + "x-displayName": "Application Groups" + }, + { + "description": "<x-lifecycle-container><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>Resource to manage interclient trust mappings for an app", + "name": "ApplicationInterclientTrustMappings", + "x-displayName": "Application Interclient Trust Mappings", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "EA" + } + }, + { + "description": "Provides a resource to manage the application instance logo", + "name": "ApplicationLogos", + "x-displayName": "Application Logos" + }, + { + "description": "The Application Policies API provides a resource to manage app sign-in policies associated with an app.", + "name": "ApplicationPolicies", + "x-displayName": "Application Policies" + }, + { + "description": "Provides a Single Sign-On (SSO) resource for an application", + "name": "ApplicationSSO", + "x-displayName": "Application SSO" + }, + { + "description": "The Application Key Credentials API provides a set of operations to manage an app's key store credentials.\n", + "name": "ApplicationSSOCredentialKey", + "x-displayName": "Application Key Credentials" + }, + { + "description": "The federated claims for an application\n", + "name": "ApplicationSSOFederatedClaims", + "x-displayName": "Application Federated Claims" + }, + { + "description": "The Application Public Keys API provides a set of operations to manage public JSON keys used for OAuth 2.0 client authentication as described in [Client authentication methods](https://developer.okta.com/docs/api/openapi/okta-oauth/guides/client-auth/) or for encrypting ID tokens. Encrypting ID tokens is self-service [Early Access](https://developer.okta.com/docs/api/openapi/okta-management/guides/release-lifecycle/#early-access-ea).\n", + "name": "ApplicationSSOPublicKeys", + "x-displayName": "Application Public Keys" + }, + { + "description": "Resource to manage OAuth 2.0 tokens for an app\n> **Note:** To configure refresh tokens for an app, see\n> [grant_types](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/application/other/createapplication!path=4/settings/oauthClient/grant_types&t=request)\n> and [refresh_token](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/application/other/createapplication!path=4/settings/oauthClient/refresh_token&t=request).\n", + "name": "ApplicationTokens", + "x-displayName": "Application Tokens" + }, + { + "description": "The Application Users API provides operations to manage app users and their assignments.\nThe object returned from assigning a user to an app is known as the application user.\n\nYou can assign users to apps for:\n * SSO only\n * SSO and provisioning\n", + "name": "ApplicationUsers", + "x-displayName": "Application Users" + }, + { + "description": "<x-lifecycle-container><x-lifecycle class=\"oie\"></x-lifecycle></x-lifecycle-container>The Associated Domain Customizations API provides operations to manage associated domain customizations in your org. You can create associations between your custom domains and three well-known endpoints:\n* `/.well-known/apple-app-site-association`\n* `/.well-known/assetlinks.json`\n* `/.well-known/webauthn`\n\nSee [Customize associated domains](https://developer.okta.com/docs/guides/custom-well-known-uri/main/) for more information about the endpoints and how to customize them.\n\n> **Notes:**\n> * You can't update the well-known URI files for the default brand.\n> * The maximum file size of each well-known URI file is 100 KB.", + "name": "AssociatedDomainCustomizations", + "x-displayName": "Associated Domain Customizations", + "x-okta-lifecycle": { + "SKUs": [ + "Okta Identity Engine" + ], + "isGenerallyAvailable": false, + "lifecycle": "LIMITED_GA" + } + }, + { + "description": "The Attack Protection API provides operations to configure the User Lockout Settings and the Authenticator Settings in your org to protect against password abuse.", + "name": "AttackProtection", + "x-displayName": "Attack Protection" + }, + { + "description": "The Authenticators Administration API provides operations to configure which authenticators are available to end users for use when they sign in to apps.\n\nEnd users are required to use one or more authenticators based on the security requirements of the app sign-in policy.\n\nOkta Identity Engine currently supports authenticators for the following factors:\n\n**Knowledge-based:**\n* Password\n* Security Question\n* Temporary access code (TAC)\n\n**Possession-based:**\n* Phone (SMS, voice call)\n* Email\n* Passkey (FIDO2 WebAuthn)\n* Duo\n* Custom app\n\n### Passkey (FIDO2 WebAuthn) authenticator\n\nAs of the `2026.04.0` release, the FIDO2 (WebAuthn) authenticator is now called Passkey (FIDO2 WebAuthn), and there are new settings and updates to the authenticator page layout. There have been no changes to any existing parameter names, values, or endpoint paths. For example, the authenticator `key` for the Passkey (FIDO2 WebAuthn) authenticator is still `webauthn`.\n\nSee [Passkeys and WebAuthn](https://developer.okta.com/docs/guides/authenticators-web-authn/aspnet/main/#passkeys-and-webauthn).\n\n> **Note:** There are several limitations when you create or modify a `webauthn` authenticator. See [Passkey (FIDO2 WebAuthn) support and behavior](https://help.okta.com/okta_help.htm?type=oie&id=webauthn-compatability).", + "name": "Authenticator", + "x-displayName": "Authenticators" + }, + { + "description": "Authorization Servers generate OAuth 2.0 and OpenID Connect tokens, including access tokens and ID tokens. The Okta Management API gives you the ability to configure and manage Authorization Servers and the security policies that are attached to them.\n\n**Work with the Default Authorization Server**\n\nOkta provides a pre-configured Custom Authorization Server with the name `default`. This Default Authorization Server includes a basic access policy and rule, which you can edit to control access. It allows you to specify `default` instead of the `authorizationServerId` in requests to it:\n\n`https://${yourOktaDomain}/api/v1/authorizationServers/default`\n\nvs\n\n`https://${yourOktaDomain}/api/v1/authorizationServers/${authorizationServerId}` for other Custom Authorization Servers", + "name": "AuthorizationServer", + "x-displayName": "Authorization Servers" + }, + { + "description": "Associated authorization servers allow you to designate a trusted authorization server that you associate with another authorization server. This type of association provides a way to configure [token exchange](https://developer.okta.com/docs/guides/set-up-token-exchange/main/#trusted-servers) between other authorization servers under the same Okta tenant.", + "name": "AuthorizationServerAssoc", + "x-displayName": "Authorization Server Associated Servers" + }, + { + "description": "Provides operations to manage custom token claims for the given `authServerId` and `claimId`", + "name": "AuthorizationServerClaims", + "x-displayName": "Authorization Server Claims" + }, + { + "description": "These endpoints allow you to manage tokens issued by an authorization server for a particular client. For example, you can revoke every active refresh token for a specific client. You can also revoke specific tokens or manage tokens at the user level.\n\nRead [Validate access tokens](https://developer.okta.com/docs/guides/validate-access-tokens/dotnet/main/) and [Validate ID tokens](https://developer.okta.com/docs/guides/validate-id-tokens/main/) to understand more about how OAuth 2.0 tokens work.", + "name": "AuthorizationServerClients", + "x-displayName": "Authorization Server Clients" + }, + { + "description": "Provides operations to manage [JSON Web Key](https://datatracker.ietf.org/doc/html/rfc7517) credentials for the given `authServerId`.\n\n> **Note:** Looking for how to obtain the jwks_uri for your org or custom authorization server? See the [well-known OpenID metadata endpoint](https://developer.okta.com/docs/api/openapi/okta-oauth/oauth/customas/getwellknownopenidconfigurationcustomas) and the [well-known OAuth 2.0 metadata endpoint](https://developer.okta.com/docs/api/openapi/okta-oauth/oauth/customas/getwellknownoauthconfigurationcustomas).", + "name": "AuthorizationServerKeys", + "x-displayName": "Authorization Server Keys" + }, + { + "description": "Provides operations to manage policies for the given `authServerId`.", + "name": "AuthorizationServerPolicies", + "x-displayName": "Authorization Server Policies" + }, + { + "description": "Provides operations to manage policy rules for the given `authServerId`, `policyId`, and `ruleId`.", + "name": "AuthorizationServerRules", + "x-displayName": "Authorization Server Rules" + }, + { + "description": "Provides operations to manage custom token scopes for the given `authServerId` and `scopeId`. See [scope properties](https://developer.okta.com/docs/api/openapi/okta-oauth/guides/overview/#scope-properties).", + "name": "AuthorizationServerScopes", + "x-displayName": "Authorization Server Scopes" + }, + { + "description": "The Behavior Rules API provides operations to manage the behavior detection rules for your organization.", + "name": "Behavior", + "x-displayName": "Behavior Rules" + }, + { + "description": "Provides operations to manage the bot protection configuration for your org.\n\nBot protection helps prevent automated attacks by detecting bots and triggering enforcement during user sign-in flows, self-service registration, and self-service password recovery flows.", + "name": "BotProtection", + "x-displayName": "Bot Protection" + }, + { + "description": "These endpoints allow you to manage Brands, and their metadata, in your orgs. With Brands, you can customize the following:\n* [The Okta-hosted sign-in page](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/CustomPages/)\n* [The sign-out page](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/CustomPages/)\n* [Error pages](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/CustomPages/)\n* [Email templates](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/CustomTemplates/)\n* [The Okta End-User Dashboard](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Themes/)\n\n> **Note:** Some of the curl code examples on this page include SSWS API token authentication. However, Okta recommends using scoped OAuth 2.0 and OIDC access tokens to authenticate with Okta management APIs. OAuth 2.0 and OIDC access tokens provide fine-grain control over the bearer's actions on specific endpoints. See [Okta API authentication methods](https://developer.okta.com/docs/api/openapi/okta-oauth/guides/overview/).", + "name": "Brands", + "x-displayName": "Brands" + }, + { + "description": "As an option to increase org security, Okta supports CAPTCHA services to prevent automated sign-in attempts. You can integrate one of two providers: [hCaptcha](https://www.hcaptcha.com/) or [reCAPTCHA v2](https://developers.google.com/recaptcha/docs/invisible).\n\nThe vendor implementations supported by Okta are both invisible. They each run risk-analysis software in the background during user sign in to determine the likelihood that the user is a bot. This risk analysis is based on the settings that you configure with the provider that you choose.\n\nBefore you configure your org to use CAPTCHA, sign in to the vendor of your choice or sign up for an account. For more details, refer to [CAPTCHA integration](https://help.okta.com/okta_help.htm?type=oie&id=csh-captcha).", + "name": "CAPTCHA", + "x-displayName": "CAPTCHAs" + }, + { + "description": "The Custom Domains API provides operations to manage custom domains for your organization.", + "name": "CustomDomain", + "x-displayName": "Custom Domains" + }, + { + "description": "These endpoints allow you to customize the contents of various pages, including:\n* The Okta-hosted sign-in page\n* Error pages\n* The sign-out page\n\n> **Note:** Some of the curl code examples on this page include SSWS API token authentication. However, Okta recommends using scoped OAuth 2.0 and OIDC access tokens to authenticate with Okta management APIs. OAuth 2.0 and OIDC access tokens provide fine-grain control over the bearer's actions on specific endpoints. See [Okta API authentication methods](https://developer.okta.com/docs/api/openapi/okta-oauth/guides/overview/).", + "name": "CustomPages", + "x-displayName": "Custom Pages" + }, + { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle>\n\nThe Custom Telephony Provider API provides operations to manage your custom telephony providers and their credentials. Creating a custom telephony provider enables you to use the Phone authenticator. See [Use your own telephony provider](https://help.okta.com/okta_help.htm?type=oie&id=configure-telephony-providers) to learn more about using your own telephony provider.\n\nTo create a custom telephony provider, you must first create an account with a supported telephony provider. After you have an account, you can use this API to add and then manage your provider credentials. [Twilio](https://www.twilio.com/) and [Telesign](https://www.telesign.com/) are the only supported telephony providers at this time.", + "name": "CustomTelephonyProvider", + "x-displayName": "Custom Telephony Provider" + }, + { + "description": "These endpoints allow you to programmatically manage email customizations.\n\nOkta provides many customizable email templates. For example, the `UserActivation` email template allows users to activate their account. Use email customizations to override a template's default content. See the [list of email templates](https://developer.okta.com/docs/guides/custom-email/main/#use-customizable-email-templates).\n\nEach template has default content that Okta translates to any one of the supported languages. The following settings determine the language for emails sent from Okta to a user, if the user hasn't selected a specific display language:\n* The user's locale property value (if specified)\n* The org's display language\n\nSee [Supported languages](https://developer.okta.com/docs/guides/custom-email/main/#supported-languages).\n\nThe following constraints apply to email customizations:\n* If an email template has any customizations at all, exactly one of them must be the default (where `isDefault` is `true`). Okta uses the default customization when no other customization applies to the user's language settings.\n* Each email template can have only one customization for each supported language.\n\n### Enable other locales\n<ApiLifecycle access=\"ea\"></ApiLifecycle>\n\nUse the [BCP 47 format](https://www.rfc-editor.org/info/bcp47) to enable more locales than Okta's 27 default languages.\n\nOnce you create a customization with the new locale, the locale appears in the Admin Console along with the default-supported locales.\n\nInclude `null` in the subject or body of the email customization. Okta replaces `null` with a default value based on the following order of priority:\n\n- An existing default email customization, if one exists\n- Okta-provided translated content for the specified language, if one exists\n- Okta-provided translated content for the brand locale, if it's set\n- Okta-provided content in English", + "name": "CustomTemplates", + "x-displayName": "Custom Email Templates" + }, + { + "description": "The Okta Devices API provides a centralized integration platform to fetch and manage device information. Okta administrators can use these APIs to manage workforce identity Device object information.\n\nThe Devices API supports the following device operations:\n* GET or DELETE device objects\n* Perform lifecycle transitions on the device objects. Device lifecycle is defined as transitions of the device status by the associated operations. The device object follows a predefined lifecycle transition flow. Device lifecycle operations are idempotent and its calls are synchronous.\n\nThe Devices API supports the following authorization schemes:\n* SSWS: [API tokens](https://developer.okta.com/docs/reference/core-okta-api/#authentication)\n* Bearer: [OAuth2.0 and OpenID Connect](https://developer.okta.com/docs/concepts/oauth-openid/)\n\n> **Notes:**\n> * For devices to enroll in Okta and show up in the Devices API, the following actions are required:\n> * Admins: Enable Okta FastPass. See [Enable FastPass](https://help.okta.com/okta_help.htm?type=oie&id=ext-fp-enable).\n> * End users with existing mobile Okta Verify enrollments: After you upgrade your org to Okta Identity Engine, direct end users with existing Okta Verify enrollments to use [FastPass](https://help.okta.com/okta_help.htm?type=oie&id=csh-fp-main).\n> * End users with a new enrollment in Okta Verify on an Okta Identity Engine org have a device record created in the device inventory by default.\n> See [Device Registration](https://help.okta.com/okta_help.htm?type=oie&id=csh-device-registration) and [Login Using Okta Verify](https://help.okta.com/okta_help.htm?type=eu&id=ext-ov-user-overview).", + "name": "Device", + "x-displayName": "Devices" + }, + { + "description": "The Device Assurance Policies API provides operations to manage device assurance policies in your organization.", + "name": "DeviceAssurance", + "x-displayName": "Device Assurance Policies" + }, + { + "description": "The Device Integrations API provides operations to retrieve, and activate or deactivate, an endpoint security integration in your organization. Examples of device integrations include the following:\n* Device Posture Provider\n* Windows Security Center\n* Chrome Device Trust\n* OSQuery\n* Android Device Trust", + "name": "DeviceIntegrations", + "x-displayName": "Device Integrations" + }, + { + "description": "The Device Posture Checks API provides operations to manage custom device posture checks for use in device assurance policies in your organization.", + "name": "DevicePostureCheck", + "x-displayName": "Device Posture Checks" + }, + { + "description": "The Directories Integration API provides operations to manage Active Directory (AD) and Lightweight Directory Access Protocol (LDAP) objects in a connected on-premises directory through Okta.\n \nOkta can only manage group memberships for users and groups imported into Okta using the AD or LDAP integration. You can't use this API to manage users and groups that weren't imported through an AD or LDAP integration or are outside of the integration's org unit scope.", + "name": "DirectoriesIntegration", + "x-displayName": "Directories Integration" + }, + { + "description": "<x-lifecycle class=\"ea\"></x-lifecycle><br>\n> **Note:** Enhanced Disaster Recovery is a [self-service Early Access (EA)](/docs/concepts/feature-lifecycle-management/#self-service-features) feature. See [Manage Early Access and Beta features](https://help.okta.com/okta_help.htm?id=ext_secur_manage_ea_bata) to enable the feature.\n\nThe Enhanced Disaster Recovery API provides operations to perform disaster recovery for your org. It ensures service continuity during total regional infrastructure outages, allowing users to remain signed in. The self-service failover and failback processes complete in under five minutes.\n\nThe API supports the following operations:\n\n* Failover\n* Failback\n* Status of your org domains\n\nWhen you use the Enhanced Disaster Recovery APIs:\n\n* The base URL for the Disaster Recovery APIs is `https://drapp.{yourOrgSubDomain}.okta.com/`. Replace `{yourOrgSubDomain}` with your Okta org subdomain. For example, if your Okta domain is `https://example.okta.com`, use `https://drapp.example.okta.com/` as the base URL.\n\n* Disaster Recovery operations are idempotent, which means that if you attempt multiple failovers or failbacks on the same domain(s) the outcome remains the same.\n\nThe Disaster Recovery API supports the following authorization scheme:\n* Bearer - [OAuth2.0 and OpenID Connect](https://developer.okta.com/docs/concepts/oauth-openid/)\n\nSee also:\n* [Manage org recovery with Okta Enhanced Disaster Recovery](https://developer.okta.com/docs/guides/manage-orgs-okta-edr/main/)\n* [Enhanced Disaster Recovery](https://help.okta.com/okta_help.htm?type=oie&id=enhanced-disaster-recovery)", + "name": "DisasterRecovery", + "x-displayName": "Enhanced Disaster Recovery" + }, + { + "description": "The Org Email Settings API provides operations to modify the email bounce list for your Okta org.", + "name": "EmailCustomization", + "x-displayName": "Org Email Settings" + }, + { + "description": "The Email Domains API provides operations to manage email domains for your organization.", + "name": "EmailDomain", + "x-displayName": "Email Domains" + }, + { + "description": "The Email Servers API allows you to configure a custom external email provider to send email notifications. By default, notifications such as the welcome email or an account recovery email are sent through an Okta-managed SMTP server. Adding a custom email provider gives you more control over your email delivery.\n\nWhen you configure a custom email provider with an OAuth 2.0 authentication method, review [Custom email providers with OAuth 2.0](https://developer.okta.com/docs/guides/custom-smtp/main/).", + "name": "EmailServer", + "x-displayName": "Email Servers" + }, + { + "description": "The Event Hooks API provides operations to manage event hooks for your organization.\n\nFor general information on event hooks and how to create and use them, see [Event hooks](https://developer.okta.com/docs/concepts/event-hooks/). The following documentation is only for the management API, which provides a CRUD interface for registering event hooks.\n\nFor a step-by-step guide on implementing an example event hook, see the [Event hook](https://developer.okta.com/docs/guides/event-hook-implementation/) guide.\n\nWhen you create an event hook, you need to specify which events you want to subscribe to. To see the list of event types currently eligible for use in event hooks, use the [Event Types](https://developer.okta.com/docs/reference/api/event-types/#catalog) catalog and search with the parameter `event-hook-eligible`.", + "name": "EventHook", + "x-displayName": "Event Hooks" + }, + { + "description": "The Okta Features API provides operations to manage self-service Early Access (EA) and Beta features in your org.\n\n> **Note:** Important background information for this API is available on the [Feature Lifecycle Management](https://developer.okta.com/docs/concepts/feature-lifecycle-management/) page.", + "name": "Feature", + "x-displayName": "Features" + }, + { + "description": "The IAM Governance Bundle API provides operations for managing governance entitlement bundles, including roles and resources associated with the bundles, for the Admin Console.\nFor details on governance bundles for the Admin Console, see [Govern Okta admin roles](https://help.okta.com/okta_help.htm?type=oie&id=csh-governance-admin-roles) and [Entitlement Management](https://help.okta.com/okta_help.htm?type=oie&id=ext-entitlement-mgt).", + "name": "GovernanceBundle", + "x-displayName": "IAM Governance Bundles" + }, + { + "description": "The Groups API provides operations to manage Okta groups and their user members in your org.", + "name": "Group", + "x-displayName": "Groups" + }, + { + "description": "The Group Owners API provides operations to manage owners of Okta groups in your org.\n\n> **Note**: This API is only available if you're subscribed to Okta Identity Governance. Contact Okta Support for more information.", + "name": "GroupOwner", + "x-displayName": "Group Owners" + }, + { + "description": "The Group Push Mappings API provides operations to manage group push mappings for your org. You must have provisioning enabled in the target app to use group push mappings. See [Manage Group Push](https://help.okta.com/okta_help.htm?type=oie&id=ext-manage-group-push).", + "name": "GroupPushMapping", + "x-displayName": "Group Push Mappings" + }, + { + "description": "The Group Rules API provides operations to manage rules for Okta groups in your org.", + "name": "GroupRule", + "x-displayName": "Group Rules" + }, + { + "description": "The Okta Key Management API provides a CRUD interface for JSON Web Keys (JWK) used with other parts of the application, such as inline hooks. For information on how to create inline hooks, see [inline hooks](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/inlinehook/).\n\n> **Note:** Some of the curl code examples on this page include SSWS API token authentication. However, Okta recommends using scoped OAuth 2.0 and OIDC access tokens to authenticate with Okta management APIs. OAuth 2.0 and OIDC access tokens provide fine-grain control over the bearer's actions on specific endpoints. See [Okta API authentication methods](https://developer.okta.com/docs/api/openapi/okta-oauth/guides/overview/).", + "name": "HookKey", + "x-displayName": "Hook Keys" + }, + { + "description": "The Identity Providers API provides operations to manage federations with external identity providers (IdPs). For example, your app can support signing in with credentials from Apple, Facebook, Google, LinkedIn, Microsoft, an enterprise IdP using SAML 2.0, or an IdP using the OpenID Connect (`OIDC`) protocol.", + "name": "IdentityProvider", + "x-displayName": "Identity Providers" + }, + { + "description": "The Identity Provider Keys API provides operations to manage key credentials for identity providers (IdPs).", + "name": "IdentityProviderKeys", + "x-displayName": "Identity Provider Keys" + }, + { + "description": "The Identity Provider Signing Keys API provides operations to manage signing key credentials and certificate signing requests (CSRs) for identity providers (IdPs).\n> **Note:** Okta currently uses the same key for both request signing and the decryption of SAML assertions that the IdP encrypts. Changing your signing key also changes your decryption key.", + "name": "IdentityProviderSigningKeys", + "x-displayName": "Identity Provider Signing Keys" + }, + { + "description": "The Identity Provider Users API provides operations to manage identity provider (IdP) users.", + "name": "IdentityProviderUsers", + "x-displayName": "Identity Provider Users" + }, + { + "description": "The Okta Identity Source API provides a mechanism to synchronize an HR source (the custom identity source) with Okta user profiles in an org. See [Build an Anything-as-a-Source custom client integration](https://developer.okta.com/docs/guides/anything-as-a-source/).", + "name": "IdentitySource", + "x-displayName": "Identity Sources" + }, + { + "description": "The Inline Hooks API provides operations to manage inline hooks for your organization.\n\nFor general information on inline hooks and how to create and use them, see [inline hooks](https://developer.okta.com/docs/concepts/inline-hooks/). The following documentation is only for the management API, which provides a CRUD interface for registering inline hooks.", + "name": "InlineHook", + "x-displayName": "Inline Hooks" + }, + { + "description": "Users have relationships to each other, like manager and subordinate or customer and sales representative. You can create users with relationships by using the Linked Objects API to represent the relationship.\n\n1. Create a linked object definition such as Manager:Subordinate or Case Worker:Client. These pairs are represented by a `primary` attribute and an `associated` attribute.\n2. Link users together to create the relationship between the two. You create a linked object value with a single request that links one `primary` and one `associated` user.\n\nFor each relationship:\n\n* A user has at most one `primary` link (a user has a single manager), but can have many `associated` links (a user can have many subordinates).\n* A user can be the `primary` in one relationship and the `associated` in another.\n* A user can be both the `primary` and `associated` in the same relationship.\n\nOkta Expression Language function for [linked objects](https://developer.okta.com/docs/reference/okta-expression-language/#linked-object-function) provides access to the details about a linked user.\n\n> **Note:** The linked objects feature isn't available for OpenID Connect claims.\n\n## Example usage\n\nOkta allows you to create up to 200 linked object definitions. These definitions are one-to-many, for example:\n\n* A manager has many subordinates. Each subordinate has one manager.\n* A sales representative has many customers. Each customer has one sales rep.\n* A case worker has many clients. Each client has one case worker.\n\nMost orgs have more than one manager or sales representative. You can create the linked object definition once, and then assign the `primary` relationship to as many users as you have people in that relationship.\n\nYou can assign the `associated` relationship for a single `primary` user to as many users as needed. The `associated` user can be related to only one `primary` per linked object definition. But you can assign a user to more than one linked object definition.\n\nFor example, assume that you've created one linked object definition for manager (`primary`) and for subordinates (`associated`):\n\n* Joe is Frank's manager.\n* Bob is Joe's manager, but Jane's subordinate.\n* Jane is the CEO, so she reports to herself.\n\nThus, you can create chains of relationships (Jane > Bob > Joe > Frank) or terminal relationships (Jane is both `primary` and `associated` user).\n\nThen, if you create another linked object relationship for scrum team membership, you could assign relationships to the same four users:\n\n* Bob is the scrum lead for the Identity Scrum team.\n* Joe and Frank are both contributors to the team.\n\nBob can be the `primary` for a Manager:Subordinate, an `associated` user for that same linked object definition, and also the `primary` for the Scrumlead:Contributor linked object definition.\n\nTo represent a relationship, create a linked object definition that specifies a `primary` (parent) relationship and an `associated` (child) relationship, and then add a link in which the appropriate user is assigned to each side of that link type.\n\n## Links between user types\n\nIf you created multiple user types (see [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/)), they all share the same linked object definitions. For example, if you have separate user types for employees and contractors, a link could designate an employee as the manager for a contractor, with the contractor being a subordinate of that employee.\n\n## Link definition operations\n\nLink definition operations allow you to manage the creation and removal of the link definitions. If you remove a link definition, links based on that definition are unavailable.\n\n> **Note:** Links reappear if you recreate the definition. However, Okta is likely to change this behavior so that links don't reappear. Don't rely on this behavior in production environments.", + "name": "LinkedObject", + "x-displayName": "Linked Objects" + }, + { + "description": "The Log Streaming API provides operations to manage log stream configurations for an org. You can configure up to two log stream integrations per org.", + "name": "LogStream", + "x-displayName": "Log Streaming" + }, + { + "description": "The Network Zones API provides operations to manage system default and custom zones in your Okta org.\nNetwork Zones are configurable boundaries that you can use to grant or restrict access to resources in your organization.\nThey're used for two purposes:\n* `POLICY`: Network Zones used to guide policy decisions\n* `BLOCKLIST`: Network Zones used to deny access from certain IP addresses, locations, Autonomous System Numbers (ASNs), proxy types, or IP service categories before policy evaluation\n> **Note:** The Network Zone blocklist applies to all URLs for the org.\n\nSee [Network zones](https://help.okta.com/okta_help.htm?id=ext_Security_Network) in the Okta product documentation.\n\nYour Okta org provides the following default system Network Zones that you can modify and use:\n* `LegacyIpZone`: The system default IP Network Zone\n* `BlockedIpZone`: The system default IP Blocklist Network Zone\n* `DefaultEnhancedDynamicZone`: The system default Enhanced Dynamic Network Zone\n\nYou can create and use the following custom Network Zones:\n* IP Network Zone (`IP`): Allows you to define network perimeters around a set of IPs\n* Dynamic Network Zone (`DYNAMIC`): Allows you to define network perimeters around location, IP type, or ASNs\n* Enhanced Dynamic Network Zone (`DYNAMIC_V2`): Extends the Dynamic Network Zone and allows you to include or exclude specific locations, ASNs, or IP service categories\n\n> **Note:** To create multiple Network Zones, you must have Adaptive MFA enabled in your Okta org.", + "name": "NetworkZone", + "x-displayName": "Network Zones" + }, + { + "description": "Provides operations to manage public [JSON Web Key](https://datatracker.ietf.org/doc/html/rfc7517) credentials used for encrypting tokens minted by the custom authorization server.", + "name": "OAuth2ResourceServerCredentialsKeys", + "x-displayName": "Authorization Server Public Keys", + "x-okta-lifecycle": { + "isGenerallyAvailable": true, + "lifecycle": "GA" + } + }, + { + "description": "The Okta Application Settings API provides operations to manage settings for Okta apps in your org.", + "name": "OktaApplicationSettings", + "x-displayName": "Okta Application Settings" + }, + { + "description": "The Okta Managed User Accounts API provides operations to manage user accounts in Okta Universal Directory with Okta Privileged Access (OPA).\n\nYou can also manage Okta users with Okta Privileged Access through the Admin Console. Okta users designated with privileged access are treated as service accounts and appear in the **Service Accounts** section of the Admin Console. You can then use Okta Privileged Access to implement security measures for the user account that's designated as a service account. See [Manage service accounts](https://help.okta.com/okta_help.htm?type=oie&id=ud-privileged-acnt).\n\n> **Note:** This feature is available only if you're subscribed to Okta Privileged Access. Ensure that you've set up the Okta Privileged Access app before managing Okta user accounts through this API.", + "name": "OktaManagedUserAccount", + "x-displayName": "Okta Managed User Accounts" + }, + { + "description": "The Okta Personal Settings API provides operations to manage the [Okta Personal](https://www.okta.com/products/okta-personal/workforce) settings of your Okta org.", + "name": "OktaPersonalSettings", + "x-displayName": "Okta Personal Settings" + }, + { + "description": "> **Note:** You need to have the **Platform—Multi-org Deployment** product to enable the **Org Creator API** feature. Contact your Okta account team for more information.\n\nThe Org Creator API provides an operation to create Okta orgs (child orgs) based on features from your current org (the parent org). See [Org Creator](https://developer.okta.com/docs/concepts/org-creator/).", + "name": "OrgCreator", + "x-displayName": "Org Creator" + }, + { + "description": "The Org Admin Settings API provides operations to manage the admin settings for your Okta org.", + "name": "OrgSettingAdmin", + "x-displayName": "Org Admin Settings" + }, + { + "description": "The Org Communication Settings API provides operations to manage the communication settings for your Okta org. For example, opt users in or out of communication emails.", + "name": "OrgSettingCommunication", + "x-displayName": "Org Communication Settings" + }, + { + "description": "The Org Contacts API provides operations to manage the contact types of your Okta org.", + "name": "OrgSettingContact", + "x-displayName": "Org Contacts" + }, + { + "description": "The Org Customization API provides operations to retrieve and modify custom settings for your Okta org.", + "name": "OrgSettingCustomization", + "x-displayName": "Org Customization" + }, + { + "description": "The Org General Settings API provides operations to manage the general settings of your Okta org.", + "name": "OrgSettingGeneral", + "x-displayName": "Org General Settings" + }, + { + "description": "The Org Metadata API provides operation to fetch metadata for your Okta org.", + "name": "OrgSettingMetadata", + "x-displayName": "Org Metadata" + }, + { + "description": "The Org Support Settings API provides operations to manage the support settings for your Okta org.", + "name": "OrgSettingSupport", + "x-displayName": "Org Support Settings" + }, + { + "description": "The Okta Policy API enables an administrator to perform policy and policy rule operations. The policy framework is used by Okta to control rules and settings that govern many things:\n- user session lifetime\n- whether multi-factor authentication is required when signing in\n- what MFA factors may be employed\n- password complexity requirements\n- what types of self-service operations are permitted under various circumstances\n- which identity provider to route users to\n\nPolicy settings for a particular policy type, such as `OKTA_SIGN_ON` policy, consist of one or more policy objects, each of which contains one or more policy rules. Policies and rules contain conditions that determine whether they are applicable to a particular user at a particular time.\n\nSee:\n* [Authenticator enrollment policies](https://developer.okta.com/docs/concepts/policies/#authenticator-enrollment-policies): `MFA_ENROLL`\n* [App sign-in policies](https://developer.okta.com/docs/concepts/policies/#app-sign-in-policies): `ACCESS_POLICY`\n* [Client update policies](https://developer.okta.com/docs/concepts/policies/#client-update-policies): `CLIENT_UPDATE`\n* <x-lifecycle class=\"ea\"></x-lifecycle>[Device signal collection policies](https://developer.okta.com/docs/guides/device-signal-collection-policies/main/): `DEVICE_SIGNAL_COLLECTION`\n* [Entity risk policies](https://developer.okta.com/docs/concepts/policies/#identity-threat-protection-policies): `ENTITY_RISK`\n* [Global session policies](https://developer.okta.com/docs/concepts/policies/#global-session-policies): `OKTA_SIGN_ON`\n* [IdP discovery policies](https://developer.okta.com/docs/concepts/policies/#route-to-other-identity-providers): `IDP_DISCOVERY`\n* <x-lifecycle class=\"ea\"></x-lifecycle> [Identity claims sourcing policy](https://developer.okta.com/docs/concepts/policies/#identity-claims-sourcing-policy): `IDENTITY_CLAIM_SOURCING`\n* [Password policies](https://developer.okta.com/docs/concepts/policies/#password-policies): `PASSWORD`\n* [Session violation enforcement policy](https://developer.okta.com/docs/concepts/policies/#identity-threat-protection-policies): `POST_AUTH_SESSION`\n* [Session violation detection policy](https://developer.okta.com/docs/concepts/policies/#identity-threat-protection-policies): `SESSION_VIOLATION_DETECTION`\n* [User profile policies](https://developer.okta.com/docs/concepts/policies/#user-profile-policies): `PROFILE_ENROLLMENT`\n\n### Policy evaluation\nWhen a policy needs to be retrieved for a particular user, for example when the user attempts to sign in to Okta, or when the user initiates a self-service operation, then a policy evaluation takes place.\nDuring policy evaluation each policy of the appropriate type is considered in turn, in the order indicated by the policy priority.\n\nEach of the conditions associated with the policy is evaluated. If one or more of the conditions can't be met, then the next policy in the list is considered. If the conditions can be met, then each of the rules associated with the policy is considered in turn, in the order specified by the rule priority.\nEach of the conditions associated with a given rule is evaluated. If all of the conditions associated with a rule are met, then the settings contained in the rule, and in the associated policy, are applied to the user. If none of the policy rules have conditions that can be met, then the next policy in the list is considered.\n\n### Rule priority\nRules have a priority that govern the order that they are considered during evaluation. The highest priority rule has a priority of `1`. For example, if a particular policy had two rules:\n* Rule A has priority `1` and applies to LDAP API scenarios.\n* Rule B has priority `2` and applies to ANYWHERE (network connection) scenarios.\n\nIf a request came in from the LDAP endpoint, the action in rule A is taken, and rule B isn't evaluated. This occurs because even though requests coming from anywhere match the ANYWHERE location condition of rule B, rule A has higher priority and is evaluated first.\n\n### Default rules\nOnly the default policy contains a default rule. In Identity Engine, you can't delete default rules, but can edit them, except for:\n * The property `usePersistentCookie` of the default global session policy's default rule, which is read-only.\n * The default identity provider routing rule and the default rule of the default authenticator enrollment policy, which are also read-only.\n\n#### Policy limitations\nDifferent policy types control settings for different operations. All policy types share a common framework, message structure, and API, but have different policy settings and rule data. Keep in mind the following policy-specific limitations.\n\n#### App sign-in policy\nThe app sign-in policy has the following limitations:\n* You can have a maximum of 5000 app sign-in policies in an org. There is a max limit of 100 rules allowed per policy. When you create an app sign-in policy, you automatically also create a default policy rule with the lowest priority of `99`. The highest priority that you can set an app sign-in policy rule to is `0`.\n* When you [merge duplicate app sign-in policies](https://help.okta.com/oie/en-us/content/topics/identity-engine/policies/consolidate-auth-policies.htm?cshid=ext-merge-auth-policies), policy and mapping CRUD operations may be unavailable during the consolidation. When the consolidation is complete, you receive an email.\n\n#### IdP discovery policy\nThe IdP discovery policy has the following limitations:\n* You can add up to 10 providers to a single `idp` policy action.\n* You can define only one provider for the following IdP types: `AgentlessDSSO`, `IWA`, `X509`.\n* You can't define a provider if `idpSelectionType` is `DYNAMIC`.\n* You can't define a `providerExpression` if `idpSelectionType` is `SPECIFIC`.\n* If a user identifier condition is defined together with an `OKTA` provider, sign-in requests are handled by Okta exclusively.\n\n#### Password policy\nThe password policy is enforced only for Okta and AD-sourced users. For AD-sourced users, ensure that your Active Directory policies don't conflict with the Okta policies.\n\n#### User profile policy\nThe user profile policy has the following limitations:\n* You can't update or delete the required base attributes in the default user profile: `email`, `firstName`, or `lastName`.\n* You can have a maximum of 500 user profile policies in an org. A user profile policy can only have one rule associated with it. Adding more rules isn't allowed.\n\nThe default rule is required and is always the last rule in the priority order. If you add rules to the default policy, they have a higher priority than the default rule. The `system` object determines whether a rule is created by a system or by a user. The default rule is the only rule that has this attribute. See [Configure multiple identifiers](https://developer.okta.com/docs/guides/multiple-identifiers/main/).", + "name": "Policy", + "x-displayName": "Policies" + }, + { + "description": "The Principal Rate Limits API provides operations to manage Principal Rate Limits for your organization.", + "name": "PrincipalRateLimit", + "x-displayName": "Principal Rate Limits" + }, + { + "description": "The Mappings API provides operations to manage the mapping of profile properties between an Okta user and an app user using [Okta Expression Language](https://developer.okta.com/docs/reference/okta-expression-language). You can find more information on Okta user and app user profiles in Okta's [User profiles](https://developer.okta.com/docs/concepts/user-profiles/#what-is-the-okta-universal-directory).", + "name": "ProfileMapping", + "x-displayName": "Profile Mappings" + }, + { + "description": "The Okta Push Providers API provides a centralized integration platform to fetch and manage push provider configurations. Okta administrators can use these APIs to provide their push provider credentials, for example from APNs and FCM, so that Okta can send push notifications to their own custom app authenticator applications.\n\nThe Push Providers API supports the following **Authorization Schemes**:\n* SSWS - [API tokens](https://developer.okta.com/docs/reference/core-okta-api/#authentication)\n* Bearer - [OAuth2.0 and OpenID Connect](https://developer.okta.com/docs/concepts/oauth-openid/)\n\n> **Notes:**\n> * Some of the curl code examples on this page include SSWS API token authentication. However, Okta recommends using scoped OAuth 2.0 and OIDC access tokens to authenticate with Okta management APIs. OAuth 2.0 and OIDC access tokens provide fine-grain control over the bearer's actions on specific endpoints. See [Okta API authentication methods](https://developer.okta.com/docs/reference/core-okta-api/#authentication).\n> * You can use the Push Providers API as part of the \"Create a custom authenticator\" flow. See the [Custom authenticator integration guide](https://developer.okta.com/docs/guides/authenticators-custom-authenticator/android/main/).", + "name": "PushProvider", + "x-displayName": "Push Providers", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + { + "description": "The Rate Limit Settings APIs provide operations to manage settings and configurations surrounding rate limiting in your Okta organization.", + "name": "RateLimitSettings", + "x-displayName": "Rate Limit Settings" + }, + { + "description": "> **Note:** This API is only available if you're subscribed to Okta Identity Governance, Secure Partner Access, or Advanced Directory Management. Contact Okta Support for more information.\n\nThe Realms API provides operations to manage realms. See [Manage realms](https://help.okta.com/okta_help.htm?type=oie&id=csh-realms).", + "name": "Realm", + "x-displayName": "Realms" + }, + { + "description": "> **Note:** This API is only available if you're subscribed to Okta Identity Governance or Secure Partner Access, or Advanced Directory Management. Contact Okta Support for more information.\n\nThe Realm Assignments API provides operations to manage realm assignments. See [Realm assignments](https://help.okta.com/okta_help.htm?type=oie&id=csh-realms-assignment) and [Manage realms](https://help.okta.com/okta_help.htm?type=oie&id=csh-realms).\n\n> **Note:** When you create realm assignments in bulk, realm assignment priorities must be unique.", + "name": "RealmAssignment", + "x-displayName": "Realm Assignments" + }, + { + "description": "The User Role Assignments APIs allow you to assign roles and designate third-party admin status to users.", + "name": "RoleAssignmentAUser", + "x-displayName": "User Role Assignments" + }, + { + "description": "The Group Role Assignments APIs allow you to assign roles and designate third-party admin status to groups.", + "name": "RoleAssignmentBGroup", + "x-displayName": "Group Role Assignments" + }, + { + "description": "The Client Role Assignments APIs allow you to assign roles and designate third-party admin status to public client apps.", + "name": "RoleAssignmentClient", + "x-displayName": "Client Role Assignments" + }, + { + "description": "User role targets are a way of limiting the app or group resources for a [standard role](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#standard-roles) that's assigned to an admin user within your org.\nYou can define admin roles to target groups, apps, and app instances.\n\n* **Group targets:** Grant an admin permission to manage only a specified group. For example, an admin role may be assigned to manage only the IT group.\n* **App targets:** Grant an admin permission to manage all instances of an OIN-cataloged app integration. For example, an admin role can manage all customer instances of an OIN-cataloged app, such as Salesforce or Facebook.\n* **App instance targets:** Grant an admin permission to manage an instance of an OIN-catalog app. For example, there may be a few Salesforce app instances configured for each sales region of an org. You can configure an admin to manage two Salesforce instances in a specific region and not the other regional Salesforce instances.\n\n> **Note:** You can only use the User Role Targets API with [standard roles](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#standard-roles). For custom roles, use [Resource Sets](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/RoleCResourceSet/) to define specific targets. See the [Role Assignments concept](https://developer.okta.com/docs/concepts/role-assignment/).", + "name": "RoleBTargetAdmin", + "x-displayName": "User Role Targets" + }, + { + "description": "Group role targets allow you to limit the app or group resources for a [standard role](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#standard-roles) that's assigned to a group within your org.\nYou can define admin roles to target groups, apps, and app instances.\n\n* **Group targets:** Grant an admin permission to manage only a specified group. For example, an admin role may be assigned to manage only the IT group.\n* **App targets:** Grant an admin permission to manage all instances of an OIN-cataloged app integration. For example, an admin role can manage all customer instances of an OIN-cataloged app, such as Salesforce or Facebook.\n* **App instance targets:** Grant an admin permission to manage an instance of an OIN-catalog app. For example, there may be a few Salesforce app instances configured for each sales region of an org. You can configure an admin to manage two Salesforce instances in a specific region and not the other regional Salesforce instances.\n\n> **Note:** You can only use the Group Role Targets API with [standard roles](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#standard-roles). For custom roles, use [Resource Sets](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/RoleCResourceSet/) to define specific targets. See the [Role Assignments concept](https://developer.okta.com/docs/concepts/role-assignment/).", + "name": "RoleBTargetBGroup", + "x-displayName": "Group Role Targets" + }, + { + "description": "Client role targets allow you to limit the app or group resources for a [standard role](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#standard-roles) that's assigned to a client (app) within your org.\nYou can define admin roles to target groups, apps, and app instances.\n\n* **Group targets:** Grant an admin permission to manage only a specified group. For example, an admin role may be assigned to manage only the IT group.\n* **App targets:** Grant an admin permission to manage all instances of an OIN-cataloged app integration. For example, an admin role can manage all customer instances of an OIN-cataloged app, such as Salesforce or Facebook.\n* **App instance targets:** Grant an admin permission to manage an instance of an OIN-catalog app. For example, there may be a few Salesforce app instances configured for each sales region of an org. You can configure an admin to manage two Salesforce instances in a specific region and not the other regional Salesforce instances.\n\n> **Note:** You can only use the Client Role Targets API with [standard roles](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#standard-roles). For custom roles, use [Resource Sets](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/RoleCResourceSet/) to define specific targets. See the [Role Assignments concept](https://developer.okta.com/docs/concepts/role-assignment/).", + "name": "RoleBTargetClient", + "x-displayName": "Client Role Targets" + }, + { + "description": "The Resource Sets API provides operations to manage resource sets as a custom set of resources. See [Supported resources](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#supported-resources).", + "name": "RoleCResourceSet", + "x-displayName": "Resource Sets" + }, + { + "description": "The Resource Set Resources API provides operations to manage resources within a resource set. You can add or remove resources in resource sets. See [Supported resources](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#supported-resources).", + "name": "RoleCResourceSetResource", + "x-displayName": "Resource Set Resources" + }, + { + "description": "The Role Resource Set Bindings API provides operations to assign members to a [Custom Role](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/roleecustom/) that targets resources in a [Resource Set](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/RoleCResourceSet/). These operations allow you to assign custom roles to admins who are scoped to the designated resources in a resource set.\n\nThe returned role resource set binding is a single unique combination of a resource set, a custom role, and members.\n\n> **Note:** If you use a custom role with permissions that don't apply to the resources in the resource set, it doesn't affect the admin role. For example,\n the `okta.users.userprofile.manage` permission gives the admin no privileges if it's granted to a resource set that only includes `https://{yourOktaDomain}/api/v1/groups/{targetGroupId}`\n resources. If you want the admin to be able to manage the users within the group, the resource set must include the corresponding `https://{yourOktaDomain}/api/v1/groups/{targetGroupId}/users` resources.", + "name": "RoleDResourceSetBinding", + "x-displayName": "Role Resource Set Bindings" + }, + { + "description": "The Role Resource Set Binding Members API provides operations to manage members in a [Role Resource Set Binding](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/RoleDResourceSetBinding/).", + "name": "RoleDResourceSetBindingMember", + "x-displayName": "Role Resource Set Binding Members" + }, + { + "description": "The Custom Roles API provides operations to manage custom roles that limit an admin's access to a subset of permissions and resources.", + "name": "RoleECustom", + "x-displayName": "Custom Roles" + }, + { + "description": "The Custom Role Permissions API provides operations to manage the permissions assigned to a custom role.", + "name": "RoleECustomPermission", + "x-displayName": "Custom Role Permissions" + }, + { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle>\n> This is a feature of Identity Threat Protection with Okta AI. It's also offered with limited support to orgs with [Adaptive MFA](https://okta.my.salesforce.com/sfc/p/#A0000000KWYD/a/4z000000rJ1i/OTjS8PbMNZItVbs4ER6XpO0s72javcjMUHhaRU3CYnY) enabled, where you must be directly assigned the super admin role to perform tasks.\n\nOkta uses the [Shared Signals Framework (SSF)](https://sharedsignals.guide/) to receive security-related events and other data-subject signals from third-party security vendors. In this scenario, commonly used terms for third-party vendors that send signals are \"transmitters\", Okta is the \"receiver\", and the connection between the two entities is referred to as a \"stream.\"\n\nThe SSF Receiver API allows you to manage SSF vendor stream configurations between the transmitter and Okta. A stream is configured by [creating a Security Events Provider](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/SSFReceiver/#tag/SSFReceiver/operation/createSecurityEventsProviderInstance) object in your Okta org. You can create a Security Events Provider object in Okta with a published well-known URL or an issuer-and-JWKS combination.\n\nAfter the Security Events Provider object is created for a transmitter, the provider can use the [SSF Security Event Tokens](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/SSFSecurityEventToken/) API to publish events to Okta. While the SSF allows ingestion through push and poll-based operations, Okta currently supports only push-based operations.", + "name": "SSFReceiver", + "x-displayName": "SSF Receiver" + }, + { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle>\n> This feature is only available with Identity Threat Protection in Identity Engine.\n\nThe Shared Signals Framework (SSF) Security Event Tokens API allows third-party security event providers to send Security Event Tokens (SETs) to Okta. The provider must be configured in Okta as a Security Events Provider instance before transmitting a SET to Okta. See [Create a Security Events Provider](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/SSFReceiver/#tag/SSFReceiver/operation/createSecurityEventsProviderInstance). After the token is verified, any appropriate action is performed upon ingestion.\n\nOkta uses the Shared Signals Framework (SSF) defined by the [OpenID Shared Signals and Events Framework specification](https://openid.net/specs/openid-sse-framework-1_0.html). A risk signal is ingested as a Security Event Token (SET), a type of JSON Web Token (JWT) that must comply with the SET RFC: [RFC 8417 - Security Event Token(SET)](https://datatracker.ietf.org/doc/html/rfc8417). The `security.events.provider.receive_event` System Log event is created when a SET is published to Okta successfully.", + "name": "SSFSecurityEventToken", + "x-displayName": "SSF Security Event Tokens" + }, + { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle>\n\nOkta uses the [Shared Signals Framework (SSF)](https://openid.net/specs/openid-sharedsignals-framework-1_0-ID3.html) to send security-related events and other data-subject signals to third-party security vendors. In this scenario, commonly used terms for third-party vendors that receive signals are \"receivers\", Okta is the \"transmitter\", and the connection between the two entities is referred to as a \"stream.\"\n\nThe SSF Transmitter API allows you to manage SSF stream configurations between the receiver that receives signals transmitted by Okta. Okta sends signals in the form of [Security Event Tokens (SETs)](https://datatracker.ietf.org/doc/html/rfc8417) to a third-party SSF receiver.\n\nOkta's SSF Transmitter currently supports two types of CAEP events: [Session Revoked](https://openid.net/specs/openid-caep-1_0-ID2.html#name-session-revoked) and [Credential Change](https://openid.net/specs/openid-caep-1_0-ID2.html#name-credential-change).\n\nThe following Okta events are mapped to the CAEP Session Revoked event:\n - user.session.end\n\nThe following Okta events are mapped to the CAEP Credential Change event:\n - user.mfa.factor.activate\n - user.mfa.factor.deactivate\n - user.mfa.factor.suspend\n - user.mfa.factor.unsuspend\n - user.mfa.factor.update\n - user.mfa.factor.reset_all\n - user.account.reset_password\n - user.account.update_password\n\nTo enable the transmission of signals from Okta, you must create an SSF Stream using the SSF Transmitter API and configure the third-party receiver to accept signals from Okta.", + "name": "SSFTransmitter", + "x-displayName": "SSF Transmitter" + }, + { + "description": "The Schemas API provides operations to manage custom user profiles as well as endpoints to discover the structure of the log stream configuration.\n\nOkta's [Universal Directory](https://help.okta.com/okta_help.htm?id=ext_About_Universal_Directory) allows admins to define custom user profiles for Okta users and apps.\nOkta adopts a subset of [JSON Schema Draft 4](https://tools.ietf.org/html/draft-zyp-json-schema-04) as the schema language to describe and validate extensible user profiles.\nFor log stream schemas, Okta uses [JSON Schema Draft 2020-12](https://json-schema.org/specification.html).\n[JSON Schema](http://json-schema.org/) is a lightweight declarative format for describing the structure, constraints, and validation of JSON documents.\n\n> **Note:** Okta implements only a subset of [JSON Schema Draft 4](https://tools.ietf.org/html/draft-zyp-json-schema-04) and [JSON Schema Draft 2020-12](https://json-schema.org/specification.html). This document describes which parts apply to Okta, and any extensions Okta has made to [JSON Schema Draft 4](https://tools.ietf.org/html/draft-zyp-json-schema-04) and [JSON Schema Draft 2020-12](https://json-schema.org/specification.html).\n\n### Unique Attributes\nYou can enforce uniqueness for custom properties in Okta user profiles or the Okta group profile, such as an employee identification number. You can declare a maximum of five unique properties for each user type and five unique properties in the Okta group profile. Different user types can have the same or different unique properties (up to the limit of five per type).\n\nUnique properties in Okta user profiles share a single namespace across all [user types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) in an org. If user types A and B both contain the property `ice cream` and you identify it as unique in both profiles, then if a user of type A has the value `chocolate`, no other users of type A or B (or any other user type that declares `ice cream` as unique) can have that value.\n\nProperties that aren't unique also aren't tracked for uniqueness. Suppose the property `candy` is unique in type E and not unique in type F. If a user of type E has the value `caramel` for the `candy` property, no other users of type E can also have the value `caramel`, but any number of users of type F can already have or later be assigned the value `caramel`. Furthermore, because `candy` is not unique in type F, any values users of type F may have are not considered when enforcing uniqueness for users of type E. No matter how many users of type F already have the value `cotton`, it might be assigned to a user of type E as long as no other such user already has that value.\n\nIf you attempt to create or update a user with a duplicate value for a custom user property with a uniqueness restriction, the user creation or update operation fails. The user isn't created or updated until you enter a unique value. Similarly, creating or updating a group fails when the request contains a value for a unique custom group property that is duplicated by another group.\n\n`null` values don't enter into the uniqueness calculation. If the unique property isn't also specified as being required, you can also omit the value entirely. Multiple users or groups can omit the property and not violate uniqueness.\n\nTo enforce uniqueness for custom properties, you can either add new unique custom properties or update existing custom properties to be unique.\n\n#### Add new unique custom property\n\nYou can use the [add property to user profile schema](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/updateUserProfile) request or the [add property to group profile schema](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/updateGroupSchema) request to add one or more unique custom user or group properties. Specify `\"unique\": true` on the properties to be marked as unique. The response shows the properties with `\"unique\": \"UNIQUE_VALIDATED\"` and uniqueness is then enforced on those properties.\n\n#### Update existing custom property to be unique\n\nYou can use the [update user profile schema property](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/updateUserProfile) request or the [update group profile schema property](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/updateGroupSchema) request to mark existing custom user or group properties as unique by specifying `\"unique\": true` on the properties to be marked as unique.\n\nAfter the request to mark existing custom properties as unique is submitted, an asynchronous validation check is performed to make sure that there are no existing duplicate entries. If you have a significant number of users or groups, the validation can take some time.\n\nA uniqueness status of `\"unique\": \"PENDING_UNIQUENESS\"` indicates that the validation check is still in progress. Use the Universal Directory page in the Admin Console (**Directory** > **Directory Integrations**) to track the status of the validation check. After the validation completes, if you submit a retrieve user schema request or a retreive group schema request, the property's uniqueness status changes to `UNIQUE_VALIDATED` if no duplicate records are found, and uniqueness is then enforced on that property. Otherwise, if duplicate records are found, the `unique` attribute of the schema property isn't shown in the get schema request and uniqueness isn't enforced on the schema property.\n\n#### Update existing unique custom property to be non-unique\n\nYou can use the [update user profile schema property](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/updateUserProfile) request or the [update group profile schema property](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/updateGroupSchema) request to change existing unique custom user or group properties to be non-unique by specifying `\"unique\": false` on the properties to be changed to non-unique. The response shows the properties without the `unique` attribute and the uniqueness constraint is then removed on those properties.\n\n**Note:** If multiple user types declare a property as unique and you remove the uniqueness constraint on one type, there may be a delay before users of other types that declare the property as unique can be assigned values formerly held by users of the first type.", + "name": "Schema", + "x-displayName": "Schemas" + }, + { + "description": "The Service Accounts API provides operations to manage SaaS or On-Prem Provisioning (OPP) app accounts as service accounts.\n\n> **Note:** This feature is available only if you're subscribed to Okta Privileged Access. Ensure that you've set up the Okta Privileged Access app before managing app accounts through this API.\n\nSee [Manage service accounts](https://help.okta.com/okta_help.htm?type=oie&id=ud-privileged-acnt).", + "name": "ServiceAccount", + "x-displayName": "Service Accounts" + }, + { + "description": "Okta uses a cookie-based authentication mechanism to maintain a user's authentication Session across web requests. The Okta Sessions API provides operations to create and manage authentication Sessions for users in your Okta organization.\n\n>**Notes:**\n> * Some browsers block third-party cookies by default, which disrupts Okta functionality in certain flows. See [Mitigate the impact of third-party cookie deprecation](https://help.okta.com/okta_help.htm?type=oie&id=ext-third-party-cookies).\n> * The Sessions API doesn't support direct authentication. Direct authentication is supported through the [Authentication API](https://developer.okta.com/docs/reference/api/authn/#authentication-operations) or through OIDC using the [Resource Owner Password flow](https://developer.okta.com/docs/guides/implement-grant-type/ropassword/main/).\n\n### Session cookie\n\nOkta uses an HTTP session cookie to provide access to your Okta organization and applications across web requests for an interactive user agent such as a web browser. A session cookie has an expiration configurable by an administrator for the organization and is valid until the cookie expires or the user closes the Session (logout) or browser application.\n\n### Session token\n\nA [session token](https://developer.okta.com/docs/reference/api/authn/#session-token) is a one-time bearer token that provides proof of authentication and may be redeemed for an interactive SSO session in Okta in a user agent. Session tokens can only be used **once** to establish a Session for a user and are revoked when the token expires.\n\nOkta provides a very rich [Authentication API](https://developer.okta.com/docs/reference/api/authn/) to validate a [user's primary credentials](https://developer.okta.com/docs/reference/api/authn/#primary-authentication) and secondary [MFA factor](https://developer.okta.com/docs/reference/api/authn/#verify-factor). A session token is returned after successful authentication, which can be later exchanged for a session cookie that uses one of the following flows:\n\n- [Retrieve a session cookie by visiting the OpenID Connect Authorization Endpoint](https://developer.okta.com/docs/guides/session-cookie/main/#retrieve-a-session-cookie-through-the-openid-connect-authorization-endpoint)\n- [Retrieve a session cookie by visiting a session redirect link](https://developer.okta.com/docs/guides/session-cookie/main/#retrieve-a-session-cookie-by-visiting-a-session-redirect-link)\n- [Retrieve a session cookie by visiting an application embed link](https://developer.okta.com/docs/guides/session-cookie/main/#retrieve-a-session-cookie-by-visiting-an-application-embed-link)\n\n>**Note:** **Session tokens** are secrets and should be protected at rest and during transit. A session token for a user is equivalent to having the user's actual credentials.", + "name": "Session", + "x-displayName": "Sessions" + }, + { + "description": "The Subscriptions API provides operations to manage email subscription settings for Okta administrator notifications.", + "name": "Subscription", + "x-displayName": "Subscriptions" + }, + { + "description": "The Okta System Log records system events that are related to your organization in order to provide an audit trail that can be used to understand platform activity and to diagnose problems.\n\nThe System Log API provides near real-time, read-only access to your organization's System Log and is the programmatic counterpart of the [System Log UI](https://help.okta.com/okta_help.htm?id=ext_Reports_SysLog).\n\nThe terms \"event\" and \"log event\" are often used interchangeably. In the context of this API, an \"event\" is an occurrence of interest within the system, and a \"log\" or \"log event\" is the recorded fact.\n\nThe System Log API supports these primary use cases:\n\n * Event data export into a security information and event management system (SIEM)\n * System monitoring\n * Development debugging\n * Event introspection and audit\n\n> **Note:** Some of the curl code examples on this page include SSWS API token authentication. However, Okta recommends using scoped OAuth 2.0 and OIDC access tokens to authenticate with Okta management APIs. OAuth 2.0 and OIDC access tokens provide fine-grain control over the bearer's actions on specific endpoints. See [Okta API authentication methods](https://developer.okta.com/docs/api/openapi/okta-oauth/guides/overview/).\n\nFor further details and examples, see [System Log query](https://developer.okta.com/docs/reference/system-log-query/).", + "name": "SystemLog", + "x-displayName": "System Log" + }, + { + "description": "The SMS Templates API provides operations to manage custom SMS templates for verification.\n\n> **Note:** Only SMS custom Templates are available through the API.\n\nSMS Templates customize the SMS message that is sent to users. One default SMS Template is provided. All custom Templates must have the variable `${code}` as part of the text. The `${code}` variable is replaced with the actual SMS code when the message is sent. Optionally, you can also use the variable `${org.name}`. If a Template contains `${org.name}`, it is replaced with the organization name before the SMS message is sent.\n\n### SMS Template macros\n\nOnly two macros are supported for SMS Templates:\n\n| <div style=\"width:200px\">Type</div> | Description |\n| -------------------- | ----------- |\n| ${code} | The one-time verification code that's required for a user to sign in. |\n| ${org.name} | The Okta org name that the user is trying to authenticate into. |\n\n>**Note:** The length of your SMS message can't exceed 160 characters. If the verification code portion of the message falls outside of the 160-character limit, your message isn't sent.", + "name": "Template", + "x-displayName": "SMS Templates" + }, + { + "description": "These endpoints allow you to customize the look and feel of pages and templates, including the following:\n* The Okta-hosted sign-in page\n* The sign-out page\n* Error pages\n* Email templates\n* The Okta End-User Dashboard\n\nEach new org contains Okta default branding. You can upload your own assets (colors, background image, logo, and favicon) to replace the default assets. Then you can publish these assets directly to your pages and templates.\n\n> **Notes:**\n> * Some of the curl code examples on this page include SSWS API token authentication. However, Okta recommends scoped OAuth 2.0 and OIDC access tokens to authenticate with Okta management APIs. OAuth 2.0 and OIDC access tokens provide fine-grain control over the bearer's actions on specific endpoints. See [Okta API authentication methods](https://developer.okta.com/docs/api/openapi/okta-oauth/guides/overview/).\n> * Okta optimizes the `primaryColorContrastHex` and `secondaryColorContrastHex` properties for the highest contrast between the font color and the background or button color. To disable or override the contrast auto-detection, update either contrast value with an accepted contrast hex code. Any update disables future automatic optimizations for the contrast hex.\n> * Contrast color is used by pages to optimize the opacity of text color when primary or secondary color is used as the background.", + "name": "Themes", + "x-displayName": "Themes" + }, + { + "description": "[Okta ThreatInsight](https://help.okta.com/okta_help.htm?id=ext_threatinsight) maintains a\nconstantly evolving list of IP addresses that consistently exhibit malicious activity.\nAuthentication requests that are associated with an IP in this list can be logged to the\n[System Log](https://help.okta.com/okta_help.htm?id=ext_Reports_SysLog) and blocked.\nThreatInsight also covers non-authentication requests in limited capacity depending on the attack patterns of these malicious IPs.\n\nThe ThreatInsight API provides operations to manage your org ThreatInsight configuration.\n\n> **Note:** To prevent abuse, Okta ThreatInsight works in a limited capacity for free trial edition orgs. Contact Okta Support if fully functional Okta ThreatInsight is required.", + "name": "ThreatInsight", + "x-displayName": "ThreatInsight" + }, + { + "description": "The Trusted Origins API provides operations to manage Trusted Origins and sources.\n\nWhen external URLs are requested during sign-in, sign-out, or recovery operations, Okta checks those URLs against the allowed list of Trusted Origins. Trusted Origins also enable browser-based applications to access Okta APIs from JavaScript (CORS). If the origins aren't specified, the related operation (redirect or Okta API access) isn't permitted.\n\nYou can also configure Trusted Origins to allow iFrame embedding of Okta resources, such as Okta sign-in pages and the Okta End-User Dashboard, within that origin.\n\n> **Notes:**\n> * This feature is supported for Okta domains only. It isn't currently supported for custom domains.\n> * Some of the curl code examples on this page include SSWS API token authentication. However, Okta recommends using scoped OAuth 2.0 and OIDC access tokens to authenticate with Okta management APIs. OAuth 2.0 and OIDC access tokens provide fine-grain control over the bearer's actions on specific endpoints. See [Okta API authentication methods](https://developer.okta.com/docs/api/openapi/okta-oauth/guides/overview/).", + "name": "TrustedOrigin", + "x-displayName": "Trusted Origins" + }, + { + "description": "The Okta UI Schema API allows you to control how inputs appear on an enrollment form. The UI Schema API is only available as a part of Okta Identity Engine.\n\nIf you're not sure which solution you're using, check the footer on any page of the Admin Console. The version number is appended with E for Identity Engine orgs and C for Classic Engine orgs.", + "name": "UISchema", + "x-displayName": "UI Schema" + }, + { + "description": "The Users API provides operations to manage users in your org.\n> **Note:** Some of the curl code examples on this page include SSWS API token authentication. However, Okta recommends using scoped OAuth 2.0 and OIDC access tokens to authenticate with Okta management APIs.\n> OAuth 2.0 and OIDC access tokens provide fine-grain control over the bearer's actions on specific endpoints. See [Okta API authentication methods](https://developer.okta.com/docs/api/openapi/okta-oauth/guides/overview/).\n\n### User status\nThe following diagram shows the flow of user status:\n\n<img alt=\"Example\" src=\"https://developer.okta.com/docs/api/images/users/okta-user-status.png\" width=\"1000\"/>\n\n### User creation scenarios\n\n The following table describes the user experience and expectation of user status and welcome screen, depending on which options (security question and answer, password, and activate query) are defined during user creation.\n\n **User creation details and outcomes**\n\n | Security Q & A | Password | Activate Query Parameter | User Status | Login Credential | Welcome Screen |\n | ----- | -------- | ------------------------ | ------------- | ---------------------- | -------------- |\n | | | FALSE | `STAGED` | | |\n | | | TRUE | `PROVISIONED` or `ACTIVE` | One-Time Token (Email) or Email | X |\n | X | | FALSE | `STAGED` | | |\n | X | | TRUE | `PROVISIONED` or `ACTIVE` | One-Time Token (Email) or Email | X |\n | | X | FALSE | `STAGED` | | |\n | | X | TRUE | `ACTIVE` | Password | X |\n | X | X | FALSE | `STAGED` | | |\n | X | X | TRUE | `ACTIVE` | Password | |\n\nCreating users with a `FEDERATION` or `SOCIAL` provider sets the user status to either `ACTIVE` or `STAGED` based on the `activate` query parameter since these two providers don't support a `password` or `recovery_question` credential.\n\nMore information about the use cases are in the following sections and in the examples for [Create a user](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#tag/User/operation/createUser).\n\n#### Create user with optional password\n\nWhen making the password optional, the user status following user creation can be affected by the enrollment policy. See [Create an authenticator enrollment policy](https://help.okta.com/okta_help.htm?type=oie&id=ext-create-mfa-policy).\n\nBased on the group memberships that are specified when the user is created, a password may or may not be required to make the user's status `ACTIVE`. The groups assigned to the user determines the enrollment policy applied to the user. If the enrollment policy has the password authenticator set to `required`, then the user's status is determined by if the user is created with a password:\n\n* Created with a password - the user status is set to `PROVISIONED` and a One-Time Token is sent to the user through email\n* Created without a password - the user status is set to `ACTIVE` and they can immediately sign in using their password authenticator\n\nIf the user doesn't have an enrolled authenticator, Okta sets the user to `PROVISIONED` and sends an activation link. The user must click the activation link before they can sign in. The activation link provides a baseline assurance that can be used to enroll in other authenticators. If the user has one or more enrolled authenticators at activation time, they're set to `ACTIVE` and can sign in directly.\n\nSee [Passwordless authentication](https://help.okta.com/okta_help.htm?type=oie&id=ext-passwordless-auth) in the help documentation.\n\n#### Create user without credentials\n\nCreates a user without a `password` or a recovery `question` and `answer`.\n\nIf appropriate, when the user is activated, an email is sent to the user with an activation token that the user can use to complete the activation process.\n\nThis is the default flow for new user registration using the Admin Console.\n\n#### Create user with recovery question\n\nCreates a user without a `password`.\n\nWhen the user is activated, an email is sent to the user with an activation token that can be used to complete the activation process.\nThis flow is useful if migrating users from an existing user store.\n\n#### Create user with password\n\nCreates a user without a recovery `question` and `answer`.\n\nThe new user is able to sign in after activation with the assigned password. This flow is common when developing a custom user registration experience.\n> **Important:** Don't generate or send a one-time activation token when activating users with an assigned password. Users should sign in with their assigned password.\n\n> **Note:** You can also use this scenario to create a user without sending an activation email. See this [Knowledge Base article](https://support.okta.com/help/s/article/How-to-Avoid-Sending-a-Welcome-Email?language=en_US#:~:text=For%20users%20imported%20from%20the,t%20send%20new%20user%20activation).\n\n#### Create user with imported hashed password\n\nCreates a user with a specified hashed password.\n\nThe new user is able to sign in after activation with the specified password.\n\nThis flow is common when migrating users from another data store in cases where we want to allow the users to retain their current passwords.\n> **Important:** Do not generate or send a one-time activation token when activating users with an imported password. Users should login with their imported password.\n\n#### Create user with password import inline hook\n\nCreates a user with a `Password Hook` object specifying that a password inline hook should be used to handle password verification.\n\nThe password inline hook is triggered to handle verification of the end user's password the first time the user tries to sign in, with Okta calling the password inline hook to check that the password the user supplied is valid. If the password is valid, Okta stores the hash of the password that was provided and can authenticate the user independently from then on. See [Create a password import inline hook](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/inlinehook/#tag/InlineHook/operation/createPasswordImportInlineHook) for more details.\n\nThe new user is able to sign in after activation with the valid password. This flow supports migrating users from another data store in cases where we wish to allow the users to retain their current passwords.\n> **Important:** Don't generate or send a one-time activation token when activating users with an password inline hook. Users should sign in with their existing password to be imported using the password import inline hook.\n\n#### Create user with password and recovery question\n\nCreates a new user with a password and recovery `question` and `answer`.\n\nThe new user is able to log in with the assigned password after activation. This flow is common when developing a custom user-registration experience.\n> **Important:** Don't generate or send a one-time activation token when activating users with an assigned password. Users should login with their assigned password.\n\n#### Create user with authentication provider\n\nCreates a new passwordless user with a `SOCIAL` or `FEDERATION` authentication provider that must be authenticated through a trusted identity provider.\n\n#### Create user in group\n\nCreates a user that is added to the specified groups upon creation.\n\nUse this in conjunction with other create operations for a group admin that's scoped to create users only in specified groups. The request can specify up to 20 group IDs. (This limit applies only when creating a user. You can add the user later to more groups.)\n\n#### Create user with non-default user type\n\nCreates a user with a specified user type. You can include the type specification with any of the above Create user operations. This example demonstrates creating a user without credentials.\nThe user type determines which [Schema](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/) applies to that user. After you create a user, you can assign the user a different user type using the full replacement [PUT operation](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/#tag/UserType/operation/replaceUserType).\n\n### Links object\n\nThe links object specifies link relations. See [`_links`](https://developer.okta.com/docs/api/openapi/okta-management/management/user/listusers!c=200&path=_links&t=response).\n\n> **Note:** This links object is different from [linked objects](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/LinkedObject/).\n\n#### Individual users versus collection of users\n\nFor an individual user result, the links object contains a full set of link relations available for that user as determined by your policies. For a collection of users, the links object contains only the `self` link. Operations that return a collection of users include [List all users](https://developer.okta.com/docs/api/openapi/okta-management/management/user/listusers) and [List all member users](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/listGroupUsers).\n\nThe following table shows some links that may be available on a user, as determined by your policies:\n\n| Link Relation Type | Description |\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|self\t | A self-referential link to this user |\n|activate\t | Lifecycle action to [activate the user](https://developer.okta.com/docs/api/openapi/okta-management/management/userlifecycle/activateuser) |\n|deactivate |\tLifecycle action to [deactivate the user](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserLifecycle/#tag/UserLifecycle/operation/deactivateUser) |\n|suspend |\tLifecycle action to [suspend the user](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserLifecycle/#tag/UserLifecycle/operation/suspendUser) |\n|unsuspend |\tLifecycle action to [unsuspend the user](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserLifecycle/#tag/UserLifecycle/operation/unsuspendUser) |\n|resetPassword |\tLifecycle action to [trigger a password reset](https://developer.okta.com/docs/api/openapi/okta-management/management/usercred/resetpassword) |\n|expirePassword |\tLifecycle action to [expire the user's password](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserCred/#tag/UserCred/operation/expirePassword) |\n|resetFactors |\tLifecycle action to [reset all MFA factors](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserLifecycle/#tag/UserLifecycle/operation/resetFactors) |\n|unlock |\tLifecycle action to [unlock a locked-out user](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserLifecycle/#tag/UserLifecycle/operation/unlockUser) |\n|forgotPassword |\t[Resets a user's password](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserCred/#tag/UserCred/operation/forgotPassword) by validating the user's recovery credential. |\n|changePassword |\t[Changes a user's password](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserCred/#tag/UserCred/operation/changePassword) validating the user's current password |\n|changeRecoveryQuestion |\t[Changes a user's recovery credential](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserCred/#tag/UserCred/operation/changeRecoveryQuestion) by validating the user's current password |", + "name": "User", + "x-displayName": "Users" + }, + { + "description": "The Authenticator Enrollments API provides operations for admins to manage the authenticator enrollments of their users.\n\nAn authenticator enrollment is the specific instance of an authenticator that a user has enrolled. For example, if a user enrolls an `sms` method with a phone number, they can use both `sms` and `voice` methods. The Authenticator Enrollments API allows admins to manage both of those user enrollments.", + "name": "UserAuthenticatorEnrollments", + "x-displayName": "User Authenticator Enrollments" + }, + { + "description": "The User Classification API provides operations to manage user classifications in your org.", + "name": "UserClassification", + "x-displayName": "User Classification" + }, + { + "description": "The User Credentials API provides operations to manage user credentials in your org.", + "name": "UserCred", + "x-displayName": "User Credentials" + }, + { + "description": "The Factors API provides operations to enroll, manage, and verify factors for multifactor authentication (MFA). Generally, authentication involves verifying a different one-time passcode (OTP). Manage both administration and end-user accounts, or verify an individual factor at any time.\nOkta supports several different types of factors:\n\n| Factor Type | Description |\n|-----------------------|-------------|\n| `call` | Software OTP sent using a voice call to a registered phone number |\n| `sms` | Software OTP sent using SMS to a registered phone number |\n| `email` | Software OTP sent using email |\n| `question` | Additional knowledge-based security question |\n| `push` | Out-of-band verification using a push notification to a device and transaction verification with digital signature |\n| `token` | Software or hardware OTP sent to a device |\n| `token:hardware` | Hardware OTP sent to a device |\n| `token:hotp` | Custom [TOTP](https://www.ietf.org/rfc/rfc6238.txt) factor that uses an extension of the [HMAC (Hash-Based Message Authentication Codes)](https://www.okta.com/identity-101/hmac/)-based one-time passcode (HOTP) algorithm |\n| `token:software:totp` | Software time-based one-time passcode (TOTP) |\n| `u2f` | Hardware Universal 2nd Factor (U2F) device |\n| `web` | HTML inline frame (iframe) for embedding verification from a third party |\n| `webauthn` | Hardware WebAuthn device |\n| `signed_nonce` | Okta Fastpass (device-bound authentication). This is available for OIE orgs if the org has users that have enrolled with Okta Verify after the org started using OIE. The `signed_nonce` factor type can only be retrieved using GET operations or deleted using the [DELETE](https://developer.okta.com/docs/api/openapi/okta-management/management/userfactor/unenrollfactor) operation. It cannot be enrolled, activated, or verified through other HTTP methods with the Factors API. |\n\n> **Note:** As of the `2026.04.0` release, the FIDO2 (WebAuthn) authenticator is now called Passkey (FIDO2 WebAuthn), and there are new settings and updates to the authenticator page layout. There have been no changes to any existing parameter names, values, or endpoint paths. For example, the `factorType` for the Passkey (FIDO2 WebAuthn) authenticator is still `webauthn`.\n>\n> See [Passkeys and WebAuthn](/docs/guides/authenticators-web-authn/aspnet/main/#passkeys-and-webauthn).", + "name": "UserFactor", + "x-displayName": "User Factors" + }, + { + "description": "The User Grants API provides operations to manage user consent grants in your org.\n\nA consent represents a user's explicit permission to allow an app to access resources protected by scopes. Consent grants are different from tokens because a consent can outlast a token. Also, there can be multiple tokens with varying sets of scopes derived from a single consent. When an app comes back and needs to get a new access token, it may not need to prompt the user for consent. This happens if they've already consented to the specified scopes. Consent grants remain valid until the user manually revokes them, or until the user, app, authorization server, or scope is deactivated or deleted.\n\n> **Hint:** For all grant operations, you can use `me` instead of the `userId` in an endpoint that contains `/users`, in an active session with no SSWS token (API token). For example: `https://${yourOktaDomain}/api/v1/users/me/grants` returns all the grants for the active session user.\n\n> **Note:** Some browsers have begun blocking third-party cookies by default, disrupting Okta functionality in certain flows. For more information, see [FAQ: How Blocking Third Party Cookies Can Potentially Impact Your Okta Environment](https://support.okta.com/help/s/article/FAQ-How-Blocking-Third-Party-Cookies-Can-Potentially-Impact-Your-Okta-Environment).", + "name": "UserGrant", + "x-displayName": "User Grants" + }, + { + "description": "The User Lifecycle API provides lifecycle operations, which are non-idempotent operations that initiate a state transition for a user's status. Some operations are asynchronous while others are synchronous.\nThe user's current status limits what operations are allowed.", + "name": "UserLifecycle", + "x-displayName": "User Lifecycle" + }, + { + "description": "The User Linked Objects API provides operations to manage user linked objects in your org.\nUse link value operations to assign users to a relationship, represented by a pair of `primary` and `associated` links. See also the [Linked Objects API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/LinkedObject/).\n\nFor these operations, the examples use consistent IDs so that you can follow the operations more easily:\n* `manager` is the `primary` relationship and is assigned `00u5t60iloOHN9pBi0h7`\n* `subordinate` is the `associated` relationship and is assigned to IDs `00u5zex6ztMbOZhF50h7` and `00u1tsf0nQKavLDUh0g5`", + "name": "UserLinkedObject", + "x-displayName": "User Linked Objects" + }, + { + "description": "The User OAuth 2.0 Token Management API provides operations to manage tokens issued by an authorization server for a particular user and client in your org. For example, you can revoke every active refresh token for a user in the context of a specific client. You can also [revoke specific tokens](https://developer.okta.com/docs/guides/revoke-tokens/main/) or [manage tokens at the authorization server level](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/AuthorizationServer/).\n\nRead [Validate Access Tokens](https://developer.okta.com/docs/guides/validate-access-tokens/) to understand more about how OAuth 2.0 tokens work.", + "name": "UserOAuth", + "x-displayName": "User OAuth 2.0 Token Management" + }, + { + "description": "The User Resources API provides operations related to user resources.", + "name": "UserResources", + "x-displayName": "User Resources" + }, + { + "description": "<x-lifecycle class=\"oie\"></x-lifecycle>\n> This feature is only available with Identity Threat Protection in Identity Engine.\n\nThe User Risk API enables you to manage a user's risk level within Okta.", + "name": "UserRisk", + "x-displayName": "User Risk", + "x-okta-lifecycle": { + "SKUs": [], + "isGenerallyAvailable": false, + "lifecycle": "GA" + } + }, + { + "description": "The User Sessions API provides operations to manage user sessions in your org.", + "name": "UserSessions", + "x-displayName": "User Sessions" + }, + { + "description": "The User Types API provides operations to manage user types. The user type determines which schema applies to that user. See the user object's [`type`](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#tag/User/operation/createUser!path=type&t=request) property and the [Schemas](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/) API.", + "name": "UserType", + "x-displayName": "User Types" + }, + { + "description": "The WebAuthn Preregistration API provides a flow to initiate and set up WebAuthn preregistration authenticator enrollments through third-party fulfillment providers.\n\n> **Note:** For information about using WebAuthn preregistration with YubiKeys, see [Require phishing-resistant authentication with pre-enrolled YubiKey](https://help.okta.com/okta_help.htm?type=oie&id=csh-preenrolled-yubikey-main).\n\nUse the following sequence of endpoints to set up WebAuthn preregistration authenticator enrollments.\n\n 1. [Generate a fulfillment request](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/WebAuthnPreregistration/#tag/WebAuthnPreregistration/operation/generateFulfillmentRequest)\n 2. [Enroll a preregistered WebAuthn factor](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/WebAuthnPreregistration/#tag/WebAuthnPreregistration/operation/enrollPreregistrationEnrollment)\n 3. [Activate a preregistered WebAuthn factor](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/WebAuthnPreregistration/#tag/WebAuthnPreregistration/operation/activatePreregistrationEnrollment)\n\nAfter you set up the preregistered WebAuthn factor, you can send the PIN to the user.\n\n> **Note:** As of the `2026.04.0` release, the FIDO2 (WebAuthn) authenticator is now called Passkey (FIDO2 WebAuthn), and there are new settings and updates to the authenticator page layout. There have been no changes to any existing parameter names, values, or endpoint paths. For example, the authenticator `key` for the Passkey (FIDO2 WebAuthn) authenticator is still `webauthn`.\n>\n> See [Passkeys and WebAuthn](/docs/guides/authenticators-web-authn/aspnet/main/#passkeys-and-webauthn).", + "name": "WebAuthnPreregistration", + "x-displayName": "WebAuthn Preregistration" + } + ], + "x-tagGroups": [ + { + "name": "Access Controls", + "tags": [ + "ApiToken", + "AttackProtection", + "Behavior", + "BotProtection", + "CAPTCHA", + "NetworkZone", + "Policy", + "Session", + "ThreatInsight", + "TrustedOrigin" + ] + }, + { + "name": "Admin Roles", + "tags": [ + "RoleAssignmentAUser", + "RoleAssignmentBGroup", + "RoleAssignmentClient", + "RoleBTargetAdmin", + "RoleBTargetBGroup", + "RoleBTargetClient", + "RoleCResourceSet", + "RoleCResourceSetResource", + "RoleDResourceSetBinding", + "RoleDResourceSetBindingMember", + "RoleECustom", + "RoleECustomPermission", + "GovernanceBundle", + "Subscription" + ] + }, + { + "name": "Applications", + "tags": [ + "Application", + "ApplicationConnections", + "ApplicationCrossAppAccessConnections", + "ApplicationFeatures", + "ApplicationGrants", + "ApplicationGroups", + "ApplicationInterclientTrustMappings", + "ApplicationLogos", + "ApplicationPolicies", + "ApplicationSSO", + "ApplicationSSOCredentialKey", + "ApplicationSSOPublicKeys", + "ApplicationSSOFederatedClaims", + "ApplicationTokens", + "ApplicationUsers", + "ApiServiceIntegrations", + "OktaApplicationSettings", + "GroupPushMapping" + ] + }, + { + "name": "Authenticators", + "tags": [ + "Authenticator", + "WebAuthnPreregistration", + "PushProvider" + ] + }, + { + "name": "Authorization Servers", + "tags": [ + "AuthorizationServer", + "AuthorizationServerAssoc", + "AuthorizationServerClaims", + "AuthorizationServerClients", + "AuthorizationServerKeys", + "OAuth2ResourceServerCredentialsKeys", + "AuthorizationServerPolicies", + "AuthorizationServerRules", + "AuthorizationServerScopes" + ] + }, + { + "name": "Customizations", + "tags": [ + "AssociatedDomainCustomizations", + "Brands", + "CustomDomain", + "CustomPages", + "CustomTelephonyProvider", + "CustomTemplates", + "EmailDomain", + "EmailServer", + "Template", + "Themes" + ] + }, + { + "name": "Devices", + "tags": [ + "Device", + "DeviceAssurance", + "DeviceIntegrations", + "DevicePostureCheck" + ] + }, + { + "name": "External Identity Sources", + "tags": [ + "AgentPools", + "DirectoriesIntegration", + "IdentityProvider", + "IdentityProviderKeys", + "IdentityProviderSigningKeys", + "IdentityProviderUsers", + "IdentitySource" + ] + }, + { + "name": "Groups", + "tags": [ + "Group", + "GroupOwner", + "GroupRule" + ] + }, + { + "name": "Hooks", + "tags": [ + "EventHook", + "HookKey", + "InlineHook" + ] + }, + { + "name": "Org Management", + "tags": [ + "OktaPersonalSettings", + "OrgSettingAdmin", + "OrgSettingCommunication", + "OrgSettingContact", + "OrgSettingCustomization", + "OrgSettingGeneral", + "OrgSettingMetadata", + "OrgSettingSupport", + "Feature", + "EmailCustomization", + "OrgCreator", + "DisasterRecovery" + ] + }, + { + "name": "Rate Limits", + "tags": [ + "RateLimitSettings", + "PrincipalRateLimit" + ] + }, + { + "name": "Realms", + "tags": [ + "Realm", + "RealmAssignment" + ] + }, + { + "name": "Schemas", + "tags": [ + "Schema", + "LinkedObject", + "UISchema" + ] + }, + { + "name": "Service Accounts", + "tags": [ + "ServiceAccount", + "OktaManagedUserAccount" + ] + }, + { + "name": "Signal Sharing", + "tags": [ + "SSFReceiver", + "SSFSecurityEventToken", + "SSFTransmitter" + ] + }, + { + "name": "System Log", + "tags": [ + "SystemLog", + "LogStream" + ] + }, + { + "name": "Users", + "tags": [ + "User", + "UserAuthenticatorEnrollments", + "UserClassification", + "UserCred", + "UserFactor", + "UserGrant", + "UserLifecycle", + "UserLinkedObject", + "UserOAuth", + "UserResources", + "UserRisk", + "UserSessions", + "UserType", + "ProfileMapping" + ] + } + ], + "x-webhooks": { + "CreatePasswordImportInlineHook": { + "post": { + "description": "Creates a password import inline hook request, one type of inline hook supported by Okta. This is an automated request from Okta to your third-party service endpoint. This reference provides sample JSON objects that are contained in the outbound request from Okta to your external service,\nand sample JSON objects that you can include in your response. The objects that you return in the JSON payload of your response to this Okta request are an array of one or more objects,\nwhich specify the Okta commands to execute.\n\n>**Note:** The size of your response payload must be less than 256 KB.\n\nThe password import inline hook allows you to migrate users from another data store where you want the users to retain their current passwords.\nUse this hook with the [Create user with password import inline hook flow](/openapi/okta-management/management/user/create-user-with-imported-hashed-password#user/Create-user-with-password-import-inline-hook) that's described in the [Users API](/openapi/okta-management/management/tags/user).\n\nThe password import inline hook is triggered when the user tries to sign in to Okta for the first time. Okta sends your external service the password that the user supplied. Your external service then needs to send a response to Okta indicating whether the password supplied by the end user is valid.\n\nIf your service returns a response that indicates that the password is valid, Okta sets the password for the user. The password import inline hook won't need to call your service again.\nHowever, if the Okta service is in read-only mode, it might not be possible to set the password. Okta then needs to call your service again the next time the user attempts to sign in.\nSee [Password inline hook and Okta read-only mode](#password-inline-hook-and-okta-read-only-mode) and [Removing password from existing user store](#password-removal-from-an-existing-user-store).\n\n>**Notes:**\n> * Password policies don't apply to the password import inline hook. That is, if your external service validates the password, the password is imported even if it doesn't meet the Okta password policy requirements.\n> * You can create only one password import inline hook per org.\n\nSee also:\n\n * [Inline hooks](https://developer.okta.com/docs/concepts/inline-hooks/) for a general introduction to Okta inline hooks\n * [Inline Hooks Management API](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/inlinehook/) for information on the API for registering external service endpoints with Okta\n * [Add an inline hook](https://help.okta.com/okta_help.htm?type=oie&id=ext-add-inline-hook) for steps to enable this inline hook in the Admin Console\n * [Password import inline hook](https://developer.okta.com/docs/guides/password-import-inline-hook/nodejs/main/) for an example implementation of this inline hook\n\n### Enable a password import inline hook\n\nTo enable a password import inline hook, you first need to register your external service endpoint with Okta and configure it as an inline hook of type `com.okta.user.credential.password.import`.\nYou can enable the hook using the Admin Console, see [Add an inline hook](https://help.okta.com/okta_help.htm?type=oie&id=ext-add-inline-hook) or through the [Inline Hooks Management API](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/inlinehook/).\nWhen creating a user with the Users API, you need to use the [Create User with password import inline hook](/openapi/okta-management/management/user/create-user-with-imported-hashed-password#user/Create-user-with-password-import-inline-hook) use case.\nThis involves specifying a `credentials.password.hook` property in the request body.\n\nWhen the user that you have added attempts to sign in to Okta for the first time, the hook is triggered and Okta calls your external service. The call sends the credentials that the end user provided. Your service can check\nthe credentials and respond with a command to indicate whether the credentials are valid or not.\n\n### Password inline hook and Okta read-only mode\n\nIf your external service responds to Okta indicating that the credentials are valid, Okta saves the password and can authenticate the user independently from then on. However, if your Okta org is in a special [read-only mode](https://support.okta.com/help/s/article/What-is-Oktas-Readonly-Mode)\nat the time the user signs in, then saving the password might not be possible. The next time the end user attempts to sign in, the password import inline hook needs to be called again.\n\n### Password removal from an existing user store\n\nBecause of the possibility of your org being in a special service mode, you shouldn't attempt to permanently delete user passwords from your existing user store until you can verify the success of the password import . An Okta System Log Event, `user.import.password`, is available for this purpose. An event of this type is created every time a password import inline hook is fired, with its `Event.Outcome` property providing a status of `FAILURE` or `SUCCESS` for the password import operation. \nIf the status is `SUCCESS`, Okta has successfully saved the end user's password, and it's safe to delete it from your previous user store.\n\nYou can configure an [Event hook](https://developer.okta.com/docs/concepts/event-hooks/) to send this event type to you for use when triggering automated cleanup of end-user\npasswords after successful migration.", + "operationId": "createPasswordImportInlineHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "PasswordImportPayloadExample": { + "$ref": "#/components/examples/PasswordImportPayloadExample" + } + }, + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/PasswordImportRequest" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "PasswordImportUnVerifiedResponse": { + "$ref": "#/components/examples/PasswordImportUnVerifiedResponse" + }, + "PasswordImportVerifiedResponse": { + "$ref": "#/components/examples/PasswordImportVerifiedResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/PasswordImportResponse" + } + } + }, + "description": "Successful response" + }, + "204": { + "description": "No content - Unverified user response" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [] + } + ], + "summary": "Create a password import inline hook", + "tags": [ + "InlineHook" + ] + } + }, + "CreateTelephonyInlineHook": { + "post": { + "description": "Creates an Okta telephony inline hook request. This is an automated request from Okta to your third-party service endpoint.\n\nThe objects that you return in the JSON payload of your response to this Okta request are an array of one or more objects,\nwhich specify the Okta commands to execute.\n\n>**Note:** The size of your response payload must be less than 256 KB.\n\nSee also:\n* For a general introduction to Okta inline hooks, see [Inline hooks](https://developer.okta.com/docs/concepts/inline-hooks/)\n* For information on the API for registering external service endpoints with Okta, see [Inline Hooks Management API](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/inlinehook/)\n* For an example implementation of a telephony inline hook, see [Telephony inline hook ](https://developer.okta.com/docs/guides/telephony-inline-hook)\n\n### About\n\nThe Okta telephony inline hook allows you to integrate your own custom code into Okta flows that send SMS or voice call messages. You can integrate this hook with enrollment, authentication, and recovery flows that involve the phone authenticator. Okta uses your external provider to deliver the one-time passcode (OTP) to the Requester. The provider can respond with commands that indicate if the delivery was successful or not.\n\nYou can have only one active telephony inline hook per org.\n\nWhen you create a telephony inline hook, you must include the `authScheme` parameter. See [Create inline hook](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/inlinehook/#tag/InlineHook/operation/createInlineHook) and the [authScheme object](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/inlinehook/#tag/InlineHook/operation/createInlineHook!path=channel/0/config/authScheme&t=request).\n\n### Time-out behavior\n\nIf the provider response times out:\n\n* Okta attempts to send the OTP using the Okta telephony providers. See [Troubleshoot](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/inlinehook/#tag/InlineHook/operation/createTelephonyInlineHook/#troubleshoot).\n\n >**Note:** The failover mechanism that uses the Okta telephony providers is heavily rate-limited.\n\n* The telephony inline hook isn't retried.\n\n### Troubleshoot\n\nThis section explains several common causes of failure for telephony inline hooks.\n\nNote: Administrators can use the [Okta System Log](https://developer.okta.com/docs/reference/api/system-log/) to view errors. See the Troubleshooting section in the inline hooks topic for details on events captured by the Okta System Log.\n\n| Issue | Impact | Error Visibility | \n|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|-------------------------------------------|\n|External service fails to communicate or times out | Inline hook operation is skipped, OTP is sent to the Requester using an Okta telephony provider. The telephony inline hook isn't retried. | Administrators only |\n|External service responds with any HTTP status code besides `200` | Inline hook operation is skipped, OTP is sent to the Requester using an Okta telephony provider | Administrators only | \n|External service returns an error object | Inline hook operation fails, OTP is sent to the Requester using an Okta telephony provider | Administrators, developers, and end users |\n|Hook response is malformed or can't be mapped to the expected API response | Inline hook operation is skipped | Administrators only |\n|Request header doesn't include an `authScheme` | Inline hook operation is skipped | Administrators only |\n|Response uses an invalid status | Inline hook operation is skipped | Administrators only |\n|Operation adds an active telephony inline hook when a hook exists | Inline hook operation is skipped | Administrators only |", + "operationId": "createTelephonyInlineHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "TelephonyPayloadExample": { + "$ref": "#/components/examples/TelephonyPayloadExample" + } + }, + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/TelephonyRequest" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "TelephonyFailureResponse": { + "$ref": "#/components/examples/TelephonyFailureResponse" + }, + "TelephonySuccessResponse": { + "$ref": "#/components/examples/TelephonySuccessResponse" + } + }, + "schema": { + "$ref": "#/components/schemas/TelephonyResponse" + } + } + }, + "description": "Successful response" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [] + } + ], + "summary": "Create a telephony inline hook", + "tags": [ + "InlineHook" + ] + } + }, + "CreateUserImportInlineHook": { + "post": { + "description": "Creates a user import inline hook request, one type of inline hook supported by Okta. This is an automated request from Okta to your third-party service endpoint. \nThis reference provides sample JSON objects that are contained in the outbound request from Okta to your external service, and sample JSON objects that you can include \nin your response. The objects that you return in the JSON payload of your response to this Okta request are an array of one or more objects, which specify the Okta commands to execute.\n\nThe user import inline hook enables you to add custom logic to the process of importing new users into Okta from an app. You can resolve conflicts in user name or other profile attributes, \nmodify values of profile attributes, and control whether the imported user is treated as a match for an existing user or not. The hook is invoked for each user being imported, \nat the point immediately after any applicable profile attribute mappings have been applied, and any potential matches with existing users have been found, but before the Okta user profile is created.\n\n>**Note:** If the external service times out after receiving an Okta request, the Okta process flow continues and the user is created.\n\nSee also:\n* [Inline hooks](https://developer.okta.com/docs/concepts/inline-hooks/) for a general introduction to Okta inline hooks\n* [Inline Hooks Management API](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/inlinehook/) for information on the API for registering external service endpoints with Okta\n* [Add an inline hook](https://help.okta.com/okta_help.htm?type=oie&id=ext-add-inline-hook) for steps to enable this inline hook in the Admin Console\n\n>**Note:** The procedure for associating a user import inline hook with an app using the Admin Console can't be used with AD or LDAP.", + "operationId": "createUserImportInlineHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "UserImportPayloadExample": { + "$ref": "#/components/examples/UserImportPayloadExample" + } + }, + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/UserImportRequest" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "UserImportChangeAppUserProfileExample": { + "$ref": "#/components/examples/UserImportChangeAppUserProfileExample" + }, + "UserImportChangeUserProfileExample": { + "$ref": "#/components/examples/UserImportChangeUserProfileExample" + }, + "UserImportCreateANewUserExample": { + "$ref": "#/components/examples/UserImportCreateANewUserExample" + }, + "UserImportErrorExample": { + "$ref": "#/components/examples/UserImportErrorExample" + }, + "UserImportMatchExample": { + "$ref": "#/components/examples/UserImportMatchExample" + } + }, + "schema": { + "$ref": "#/components/schemas/UserImportResponse" + } + } + }, + "description": "Successful response" + }, + "204": { + "description": "No content - Use the default action" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [] + } + ], + "summary": "Create a user import inline hook", + "tags": [ + "InlineHook" + ] + } + }, + "create-registration-hook": { + "post": { + "description": "Creates a registration inline hook request, one type of inline hook supported by Okta. This is an automated request from Okta to your third-party service endpoint. This reference provides sample JSON objects that are contained in the outbound request from Okta to your external service,\nand sample JSON objects that you can include in your response. The objects that you return in the JSON payload of your response to this Okta request are an array of one or more objects,\nwhich specify the Okta commands to execute.\n\nThe Okta registration inline hook allows you to integrate your own custom code into Okta's [Profile Enrollment](https://help.okta.com/okta_help.htm?type=oie&id=ext-create-profile-enrollment) flow. The hook is triggered after Okta receives the registration or profile update request. Your custom code can:\n- Allow or deny the registration attempt, based on your own validation of the information the user has submitted\n- Set or override the values that are populated in attributes of the user's Okta profile\n> **Note:** Profile Enrollment and self-service registration (SSR) inline hooks only work with the [Okta Sign-In Widget](https://developer.okta.com/code/javascript/okta_sign-in_widget/) version 4.5 or later.\n\nSee also:\n* [Inline hooks](https://developer.okta.com/docs/concepts/inline-hooks/) for a general introduction to Okta inline hooks\n* [Inline Hooks Management API](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/inlinehook/) for information on the API for registering external service endpoints with Okta\n* [Add an inline hook](https://help.okta.com/okta_help.htm?type=oie&id=ext-add-inline-hook) for steps to enable this inline hook in the Admin Console\n* [Registration inline hook](https://developer.okta.com/docs/guides/registration-inline-hook) for an example implementation of this inline hook", + "operationId": "create-registration-hook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "ProfileEnrollmentRequest": { + "$ref": "#/components/examples/ProfileEnrollmentRequest" + }, + "ProgressiveProfileRequest": { + "$ref": "#/components/examples/ProgressiveProfileRequest" + } + }, + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/RegistrationInlineHookRequest" + } + ], + "x-okta-ignore-redocly-rules-for-sdk": true + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "ProfileEnrollmentResponse": { + "$ref": "#/components/examples/ProfileEnrollmentResponse" + }, + "ProfileEnrollmentResponseDeny": { + "$ref": "#/components/examples/ProfileEnrollmentResponseDeny" + }, + "ProgressiveProfileResponse": { + "$ref": "#/components/examples/ProgressiveProfileResponse" + }, + "ProgressiveProfileResponseDeny": { + "$ref": "#/components/examples/ProgressiveProfileResponseDeny" + } + }, + "schema": { + "$ref": "#/components/schemas/RegistrationResponse" + } + } + }, + "description": "Successful response" + }, + "204": { + "description": "No content - Allow registration to proceed without any update." + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [] + } + ], + "summary": "Create a registration inline hook", + "tags": [ + "InlineHook" + ], + "x-okta-no-scope-required": true + } + }, + "create-saml-hook": { + "post": { + "description": "Creates a SAML assertion inline hook request, one type of inline hook supported by Okta. This is an automated request from Okta to your third-party service endpoint. This reference provides sample JSON objects that are contained in the outbound request from Okta to your external service, and sample JSON objects that you can include in your response. The objects that you return in the JSON payload of your response to this Okta request are an array of one or more objects, which specify the Okta commands to execute.\n\nThis type of inline hook is triggered when Okta generates a SAML assertion in response to an authentication request. Before sending the SAML assertion to the app that will consume it, Okta calls out to your external service. Your external service can respond with commands to add attributes to the assertion or to modify its existing attributes.\n\nYou can use this functionality to add data to assertions, which might be data that is sensitive, calculated at runtime, or complexly-structured and not appropriate for storing in Okta user profiles. Data added this way is never logged or stored by Okta. As an example, SAML assertions generated for a medical app could be augmented with confidential patient data provided by your external service and not stored in Okta.\n\nThis inline hook works only when using custom SAML apps, not apps from the OIN.\n\nSee also:\n * [Inline hooks](https://developer.okta.com/docs/concepts/inline-hooks/) for a general introduction to Okta inline hooks\n * [Inline Hooks Management API](/openapi/okta-management/management/tags/inlinehook/) for information on the API for registering external service endpoints with Okta\n * For a use case example of how to implement a SAML assertion inline hook, see [SAML assertion inline hook](https://developer.okta.com/docs/guides/saml-inline-hook)\n * For steps to enable this inline hook, see [Add an inline hook](https://help.okta.com/okta_help.htm?type=oie&id=ext-add-inline-hook).\n\n### Specify location within the assertion\n\nSpecify the location within the assertion where you want to apply your operation using a slash-delimited path, which follows JSON Patch conventions.\n\nWhen you perform an `add` op to add a new attribute statement, begin with `/claims/` and follow that with the name of the new attribute that you're adding.\n\nWhen you modify an existing assertions statement, begin the path with `/subject/`, `/authentication/`, `/conditions/`, or `/claims/`, depending on which part of the assertion you want to modify. You then look deeper within the child elements using slash-delimited element names, for example, `/claims/array/attributeValues/1/value`. (The `/1/` in the path indicates the index of the array, using zero-based indexing.)\n\n### URI claims\n\nOkta supports URI claims with SAML assertion hooks. When you need to replace or add a URI claim, encode the claim name within the command per the [JavaScript Object Notation (JSON) Pointer](https://tools.ietf.org/html/rfc6901) specification. Specifically, this replaces `~` with `~0` and `/` with `~1`.\n\n### SessionNotOnOrAfter support\n\nIn some scenarios, your service provider may require the `SessionNotOnOrAfter` attribute for the `<saml:AuthnStatement>` in the SAML assertion, which sets the provider session time correctly. Use `add` op with the path `/authentication/sessionLifetime` and a value for session lifetime in seconds to add this attribute. Okta calculates `SessionNotOnOrAfter` by adding the `/authentication/sessionLifetime` value to the `issueInstant` attribute and returns it in the SAML `data.assertion.", + "operationId": "createSAMLAssertionInlineHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "SAMLPayloadExample": { + "$ref": "#/components/examples/SAMLPayLoadExample" + } + }, + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/InlineHookBasePayload" + }, + { + "$ref": "#/components/schemas/SAMLPayLoad" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "SAMLHookResponseExample": { + "$ref": "#/components/examples/SAMLHookResponseExample" + }, + "SAMLHookResponseWithURIFormat": { + "$ref": "#/components/examples/SAMLHookResponseWithURIFormat" + } + }, + "schema": { + "$ref": "#/components/schemas/SAMLHookResponse" + } + } + }, + "description": "Successful response" + }, + "204": { + "description": "No content - Use the default action" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [] + } + ], + "summary": "Create a SAML assertion inline hook", + "tags": [ + "InlineHook" + ] + } + }, + "create-token-hook": { + "post": { + "description": "Creates a token inline hook request, one type of inline hook supported by Okta. This is an automated request from Okta to your third-party service endpoint. This reference provides sample JSON objects that are contained in the outbound request from Okta to your external service, and sample JSON objects that you can include in your response.\n\nThis type of inline hook is triggered when OAuth 2.0 and OpenID Connect (OIDC) tokens are minted by your Okta custom authorization server. Before sending the token to the requester, Okta calls out to your external service. Your service can then respond with commands to add custom claims to the token or to modify existing claims.\n\nUse this functionality to add data that is sensitive, calculated at runtime, or complexly structured and not appropriate for storing in Okta user profiles. Okta never logs nor stores data that is added this way. As an example, tokens minted for a medical app could be augmented with confidential patient data provided by your external service and not stored in Okta.\n\nIn addition to adding custom claims, you can modify or remove an existing custom claim or an OIDC standard profile claim. You can also update how long an access token or an ID token is valid.\n\nThis inline hook works only when using an [Okta custom authorization server](https://developer.okta.com/docs/guides/customize-authz-server/main/#create-an-authorization-server), not the built-in Okta org authorization server.\n\nSee also:\n * [Inline hooks](https://developer.okta.com/docs/concepts/inline-hooks/) for a general introduction to Okta inline hooks\n * [Inline Hooks Management API](/openapi/okta-management/management/tags/inlinehook) for information on the API for registering external service endpoints with Okta\n * For an example implementation of this inline hook, see [Token inline hook](https://developer.okta.com/docs/guides/token-inline-hook)\n\n### Timeout behavior\nAfter receiving the Okta request, if there's a response timeout, the Okta process flow proceeds with the original token returned. The token inline hook isn't retried.\n\n### Enabling a token inline hook\nTo activate the inline hook, you first need to register your external service endpoint with Okta using the [Inline Hooks Management API](/openapi/okta-management/management/tags/inlinehook).\nYou then need to associate the registered inline hook with a custom authorization server policy rule by completing the following steps:\n1. Go to **Security** > **API** > **Authorization Servers.**\n2. Select a custom authorization server from the list.\n3. Select **Access Policies** and select a policy to use with the hook. In most cases, pick the Default Policy.\n4. One of the policy's rules needs to trigger the inline hook. Click the pencil icon for a rule to edit it. If you only have one rule, edit the Default Policy Rule.\n5. Click the **Use this Inline Hook** dropdown menu. Any inline hooks that you have registered are listed. Select the hook that you would like to use.\n6. Click **Update Rule**.\n\n> **Note:** You can associate only one inline hook with each rule.\n\n### Troubleshoot\nThis section covers what happens when a token inline hook flow fails either due to the external inline hook service returning an error object or not returning a successful response, or the inline hook patch fails.\n> **Note:** Administrators can use the [Okta System Log](https://developer.okta.com/docs/reference/api/system-log/) to view errors. See the [Troubleshooting](https://developer.okta.com/docs/concepts/inline-hooks/#troubleshooting) section in the inline hooks concept piece for more information on the events related to inline hooks that the Okta System Log captures.\n- When there's a communication failure with the external service, a timeout for example, the inline hook operation is skipped. The token is generated without any modification from the inline hook. The token inline hook isn't retried.\n\n **Who can see this error?** Administrators\n\n- When the external service returns a response with any other HTTP status code besides `200`, the inline hook operation is skipped. The token is generated without any modification from the inline hook.\n\n **Who can see this error?** Administrators\n\n- When the external service returns an error object in the response, the entire token inline hook flow fails with no token generated.\n\n **Who can see this error?** Administrators, developers, and end users. When the OAuth 2.0 client receives the error, the client developer can see that error if the client has the debug information. What the end user sees depends on how errors are handled within the client.\n > **Note:** See the [error](https://developer.okta.com/docs/reference/token-hook/#error) section on this page for more information on what to include in the error object of your response and what the OAuth 2.0 error includes that Okta returns to the requestor of the token.\n\n- When a hook command (for example, updating, adding, and deleting claims) can't be performed, the inline hook operation is skipped. The token is generated without any modification from the inline hook.\n\n **Who can see this error?** Administrators\n\n The following actions result in an error:\n - Using an invalid command. For example, if only an ID token is requested, the `commands` array shouldn't contain commands of the type `com.okta.access.patch`.\n - Using an invalid operation\n - Attempting to remove a system-specific claim\n - Attempting to update a claim that doesn't exist\n - Attempting to update an element within an array that doesn't exist or specifying an invalid index\n - Attempting to remove a claim that doesn't exist", + "operationId": "createTokenInlineHook", + "requestBody": { + "content": { + "application/json": { + "examples": { + "TokenPayLoadExample": { + "$ref": "#/components/examples/TokenPayLoadExample" + } + }, + "schema": { + "$ref": "#/components/schemas/TokenRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "TokenHookErrorExample": { + "$ref": "#/components/examples/TokenHookErrorExample" + }, + "TokenHookModifyLifetime": { + "$ref": "#/components/examples/TokenHookModifyLifetime" + }, + "TokenHookRemoveClaim": { + "$ref": "#/components/examples/TokenHookRemoveClaim" + }, + "TokenHookRemoveFromArray": { + "$ref": "#/components/examples/TokenHookRemoveFromArray" + }, + "TokenHookRemoveFromObject": { + "$ref": "#/components/examples/TokenHookRemoveFromObject" + }, + "TokenHookReplaceExisting": { + "$ref": "#/components/examples/TokenHookReplaceExisting" + }, + "TokenHookReplaceInPath": { + "$ref": "#/components/examples/TokenHookReplaceInPath" + }, + "TokenHookResponse": { + "$ref": "#/components/examples/TokenHookResponse" + }, + "TokenHookResponseAppendArray": { + "$ref": "#/components/examples/TokenHookResponseAppendArray" + }, + "TokenHookResponseWithURIFormat": { + "$ref": "#/components/examples/TokenHookResponseWithURIFormat" + } + }, + "schema": { + "$ref": "#/components/schemas/TokenHookResponse" + } + } + }, + "description": "Successful response" + }, + "204": { + "description": "No content - Unverified user response" + }, + "403": { + "$ref": "#/components/responses/ErrorAccessDenied403" + } + }, + "security": [ + { + "apiToken": [] + }, + { + "oauth2": [] + } + ], + "summary": "Create a token inline hook", + "tags": [ + "InlineHook" + ] + } + } + } +} diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..086fbda --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +# a2a-pack is installed by the platform base image. +deepagents>=0.5.0 +langchain>=0.3 +langchain-openai>=0.2 +langchain-core>=0.3 +langgraph>=0.6 +httpx>=0.27 diff --git a/skills/agent-pools/SKILL.md b/skills/agent-pools/SKILL.md new file mode 100644 index 0000000..794021a --- /dev/null +++ b/skills/agent-pools/SKILL.md @@ -0,0 +1,155 @@ +--- +name: agent-pools-routes +description: Handle 14 OpenAPI operation(s) under /api/v1/agentPools for the agentPools route group. +--- + +# agentPools API Routes + +Handle 14 OpenAPI operation(s) under /api/v1/agentPools for the agentPools route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_agent_pools + +- Operation ID: `list_agent_pools` +- Route: `GET /api/v1/agentPools` +- Mode: READ +- Summary: List all agent pools +- Parameters: + - `limitPerPoolType` in `query` + - `poolType` in `query` + - `after` in `query` + +### list_agent_pools_updates + +- Operation ID: `list_agent_pools_updates` +- Route: `GET /api/v1/agentPools/{poolId}/updates` +- Mode: READ +- Summary: List all agent pool updates +- Parameters: + - `poolId` in `path` required + - `scheduled` in `query` + +### create_agent_pools_update + +- Operation ID: `create_agent_pools_update` +- Route: `POST /api/v1/agentPools/{poolId}/updates` +- Mode: WRITE +- Summary: Create an agent pool update +- Parameters: + - `poolId` in `path` required +- Body: JSON request body accepted. + +### get_agent_pools_update_settings + +- Operation ID: `get_agent_pools_update_settings` +- Route: `GET /api/v1/agentPools/{poolId}/updates/settings` +- Mode: READ +- Summary: Retrieve an agent pool update's settings +- Parameters: + - `poolId` in `path` required + +### update_agent_pools_update_settings + +- Operation ID: `update_agent_pools_update_settings` +- Route: `POST /api/v1/agentPools/{poolId}/updates/settings` +- Mode: WRITE +- Summary: Update an agent pool update settings +- Parameters: + - `poolId` in `path` required +- Body: JSON request body accepted. + +### get_agent_pools_update_instance + +- Operation ID: `get_agent_pools_update_instance` +- Route: `GET /api/v1/agentPools/{poolId}/updates/{updateId}` +- Mode: READ +- Summary: Retrieve an agent pool update by ID +- Parameters: + - `poolId` in `path` required + - `updateId` in `path` required + +### update_agent_pools_update + +- Operation ID: `update_agent_pools_update` +- Route: `POST /api/v1/agentPools/{poolId}/updates/{updateId}` +- Mode: WRITE +- Summary: Update an agent pool update by ID +- Parameters: + - `poolId` in `path` required + - `updateId` in `path` required +- Body: JSON request body accepted. + +### delete_agent_pools_update + +- Operation ID: `delete_agent_pools_update` +- Route: `DELETE /api/v1/agentPools/{poolId}/updates/{updateId}` +- Mode: WRITE +- Summary: Delete an agent pool update +- Parameters: + - `poolId` in `path` required + - `updateId` in `path` required + +### activate_agent_pools_update + +- Operation ID: `activate_agent_pools_update` +- Route: `POST /api/v1/agentPools/{poolId}/updates/{updateId}/activate` +- Mode: WRITE +- Summary: Activate an agent pool update +- Parameters: + - `poolId` in `path` required + - `updateId` in `path` required + +### deactivate_agent_pools_update + +- Operation ID: `deactivate_agent_pools_update` +- Route: `POST /api/v1/agentPools/{poolId}/updates/{updateId}/deactivate` +- Mode: WRITE +- Summary: Deactivate an agent pool update +- Parameters: + - `poolId` in `path` required + - `updateId` in `path` required + +### pause_agent_pools_update + +- Operation ID: `pause_agent_pools_update` +- Route: `POST /api/v1/agentPools/{poolId}/updates/{updateId}/pause` +- Mode: WRITE +- Summary: Pause an agent pool update +- Parameters: + - `poolId` in `path` required + - `updateId` in `path` required + +### resume_agent_pools_update + +- Operation ID: `resume_agent_pools_update` +- Route: `POST /api/v1/agentPools/{poolId}/updates/{updateId}/resume` +- Mode: WRITE +- Summary: Resume an agent pool update +- Parameters: + - `poolId` in `path` required + - `updateId` in `path` required + +### retry_agent_pools_update + +- Operation ID: `retry_agent_pools_update` +- Route: `POST /api/v1/agentPools/{poolId}/updates/{updateId}/retry` +- Mode: WRITE +- Summary: Retry an agent pool update +- Parameters: + - `poolId` in `path` required + - `updateId` in `path` required + +### stop_agent_pools_update + +- Operation ID: `stop_agent_pools_update` +- Route: `POST /api/v1/agentPools/{poolId}/updates/{updateId}/stop` +- Mode: WRITE +- Summary: Stop an agent pool update +- Parameters: + - `poolId` in `path` required + - `updateId` in `path` required diff --git a/skills/api-tokens/SKILL.md b/skills/api-tokens/SKILL.md new file mode 100644 index 0000000..0b79aee --- /dev/null +++ b/skills/api-tokens/SKILL.md @@ -0,0 +1,56 @@ +--- +name: api-tokens-routes +description: Handle 5 OpenAPI operation(s) under /api/v1/api-tokens for the api tokens route group. +--- + +# api tokens API Routes + +Handle 5 OpenAPI operation(s) under /api/v1/api-tokens for the api tokens route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_api_tokens + +- Operation ID: `list_api_tokens` +- Route: `GET /api/v1/api-tokens` +- Mode: READ +- Summary: List all API token metadata + +### revoke_current_api_token + +- Operation ID: `revoke_current_api_token` +- Route: `DELETE /api/v1/api-tokens/current` +- Mode: WRITE +- Summary: Revoke the current API token + +### get_api_token + +- Operation ID: `get_api_token` +- Route: `GET /api/v1/api-tokens/{apiTokenId}` +- Mode: READ +- Summary: Retrieve an API token's metadata +- Parameters: + - `apiTokenId` in `path` required + +### upsert_api_token + +- Operation ID: `upsert_api_token` +- Route: `PUT /api/v1/api-tokens/{apiTokenId}` +- Mode: WRITE +- Summary: Upsert an API token network condition +- Parameters: + - `apiTokenId` in `path` required +- Body: JSON request body accepted. + +### revoke_api_token + +- Operation ID: `revoke_api_token` +- Route: `DELETE /api/v1/api-tokens/{apiTokenId}` +- Mode: WRITE +- Summary: Revoke an API token +- Parameters: + - `apiTokenId` in `path` required diff --git a/skills/apps/SKILL.md b/skills/apps/SKILL.md new file mode 100644 index 0000000..ab450ed --- /dev/null +++ b/skills/apps/SKILL.md @@ -0,0 +1,812 @@ +--- +name: apps-routes +description: Handle 77 OpenAPI operation(s) under /api/v1/apps for the apps route group. +--- + +# apps API Routes + +Handle 77 OpenAPI operation(s) under /api/v1/apps for the apps route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_applications + +- Operation ID: `list_applications` +- Route: `GET /api/v1/apps` +- Mode: READ +- Summary: List all applications +- Parameters: + - `q` in `query` + - `after` in `query` + - `useOptimization` in `query` + - `alwaysIncludeVpnSettings` in `query` + - `limit` in `query` + - `filter` in `query` + - `expand` in `query` + - `includeNonDeleted` in `query` + +### create_application + +- Operation ID: `create_application` +- Route: `POST /api/v1/apps` +- Mode: WRITE +- Summary: Create an application +- Parameters: + - `activate` in `query` + - `OktaAccessGateway-Agent` in `header` +- Body: JSON request body accepted. + +### get_application + +- Operation ID: `get_application` +- Route: `GET /api/v1/apps/{appId}` +- Mode: READ +- Summary: Retrieve an application +- Parameters: + - `appId` in `path` required + - `expand` in `query` + +### replace_application + +- Operation ID: `replace_application` +- Route: `PUT /api/v1/apps/{appId}` +- Mode: WRITE +- Summary: Replace an application +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### delete_application + +- Operation ID: `delete_application` +- Route: `DELETE /api/v1/apps/{appId}` +- Mode: WRITE +- Summary: Delete an application +- Parameters: + - `appId` in `path` required + +### get_default_provisioning_connection_for_application + +- Operation ID: `get_default_provisioning_connection_for_application` +- Route: `GET /api/v1/apps/{appId}/connections/default` +- Mode: READ +- Summary: Retrieve the default provisioning connection +- Parameters: + - `appId` in `path` required + +### update_default_provisioning_connection_for_application + +- Operation ID: `update_default_provisioning_connection_for_application` +- Route: `POST /api/v1/apps/{appId}/connections/default` +- Mode: WRITE +- Summary: Update the default provisioning connection +- Parameters: + - `appId` in `path` required + - `activate` in `query` +- Body: JSON request body accepted. + +### get_user_provisioning_connection_jwks + +- Operation ID: `get_user_provisioning_connection_jwks` +- Route: `GET /api/v1/apps/{appId}/connections/default/jwks` +- Mode: READ +- Summary: Retrieve a JSON Web Key Set (JWKS) for the default provisioning connection +- Parameters: + - `appId` in `path` required + +### activate_default_provisioning_connection_for_application + +- Operation ID: `activate_default_provisioning_connection_for_application` +- Route: `POST /api/v1/apps/{appId}/connections/default/lifecycle/activate` +- Mode: WRITE +- Summary: Activate the default provisioning connection +- Parameters: + - `appId` in `path` required + +### deactivate_default_provisioning_connection_for_application + +- Operation ID: `deactivate_default_provisioning_connection_for_application` +- Route: `POST /api/v1/apps/{appId}/connections/default/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate the default provisioning connection +- Parameters: + - `appId` in `path` required + +### list_csrs_for_application + +- Operation ID: `list_csrs_for_application` +- Route: `GET /api/v1/apps/{appId}/credentials/csrs` +- Mode: READ +- Summary: List all certificate signing requests +- Parameters: + - `appId` in `path` required + +### generate_csr_for_application + +- Operation ID: `generate_csr_for_application` +- Route: `POST /api/v1/apps/{appId}/credentials/csrs` +- Mode: WRITE +- Summary: Generate a certificate signing request +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### get_csr_for_application + +- Operation ID: `get_csr_for_application` +- Route: `GET /api/v1/apps/{appId}/credentials/csrs/{csrId}` +- Mode: READ +- Summary: Retrieve a certificate signing request +- Parameters: + - `appId` in `path` required + - `csrId` in `path` required + +### revoke_csr_from_application + +- Operation ID: `revoke_csr_from_application` +- Route: `DELETE /api/v1/apps/{appId}/credentials/csrs/{csrId}` +- Mode: WRITE +- Summary: Revoke a certificate signing request +- Parameters: + - `appId` in `path` required + - `csrId` in `path` required + +### publish_csr_from_application + +- Operation ID: `publish_csr_from_application` +- Route: `POST /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish` +- Mode: WRITE +- Summary: Publish a certificate signing request +- Parameters: + - `appId` in `path` required + - `csrId` in `path` required +- Body: JSON request body accepted. + +### list_jwk + +- Operation ID: `list_jwk` +- Route: `GET /api/v1/apps/{appId}/credentials/jwks` +- Mode: READ +- Summary: List all the OAuth 2.0 client JSON Web Keys +- Parameters: + - `appId` in `path` required + +### add_jwk + +- Operation ID: `add_jwk` +- Route: `POST /api/v1/apps/{appId}/credentials/jwks` +- Mode: WRITE +- Summary: Add a JSON Web Key +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### get_jwk + +- Operation ID: `get_jwk` +- Route: `GET /api/v1/apps/{appId}/credentials/jwks/{keyId}` +- Mode: READ +- Summary: Retrieve an OAuth 2.0 client JSON Web Key +- Parameters: + - `appId` in `path` required + - `keyId` in `path` required + +### deletejwk + +- Operation ID: `deletejwk` +- Route: `DELETE /api/v1/apps/{appId}/credentials/jwks/{keyId}` +- Mode: WRITE +- Summary: Delete an OAuth 2.0 client JSON Web Key +- Parameters: + - `appId` in `path` required + - `keyId` in `path` required + +### activate_o_auth2_client_json_web_key + +- Operation ID: `activate_o_auth2_client_json_web_key` +- Route: `POST /api/v1/apps/{appId}/credentials/jwks/{keyId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate an OAuth 2.0 client JSON Web Key +- Parameters: + - `appId` in `path` required + - `keyId` in `path` required + +### deactivate_o_auth2_client_json_web_key + +- Operation ID: `deactivate_o_auth2_client_json_web_key` +- Route: `POST /api/v1/apps/{appId}/credentials/jwks/{keyId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate an OAuth 2.0 client JSON Web Key +- Parameters: + - `appId` in `path` required + - `keyId` in `path` required + +### list_application_keys + +- Operation ID: `list_application_keys` +- Route: `GET /api/v1/apps/{appId}/credentials/keys` +- Mode: READ +- Summary: List all key credentials +- Parameters: + - `appId` in `path` required + +### generate_application_key + +- Operation ID: `generate_application_key` +- Route: `POST /api/v1/apps/{appId}/credentials/keys/generate` +- Mode: WRITE +- Summary: Generate a key credential +- Parameters: + - `appId` in `path` required + - `validityYears` in `query` required + +### get_application_key + +- Operation ID: `get_application_key` +- Route: `GET /api/v1/apps/{appId}/credentials/keys/{keyId}` +- Mode: READ +- Summary: Retrieve a key credential +- Parameters: + - `appId` in `path` required + - `keyId` in `path` required + +### clone_application_key + +- Operation ID: `clone_application_key` +- Route: `POST /api/v1/apps/{appId}/credentials/keys/{keyId}/clone` +- Mode: WRITE +- Summary: Clone a key credential +- Parameters: + - `appId` in `path` required + - `keyId` in `path` required + - `targetAid` in `query` required + +### list_o_auth2_client_secrets + +- Operation ID: `list_o_auth2_client_secrets` +- Route: `GET /api/v1/apps/{appId}/credentials/secrets` +- Mode: READ +- Summary: List all OAuth 2.0 client secrets +- Parameters: + - `appId` in `path` required + +### create_o_auth2_client_secret + +- Operation ID: `create_o_auth2_client_secret` +- Route: `POST /api/v1/apps/{appId}/credentials/secrets` +- Mode: WRITE +- Summary: Create an OAuth 2.0 client secret +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### get_o_auth2_client_secret + +- Operation ID: `get_o_auth2_client_secret` +- Route: `GET /api/v1/apps/{appId}/credentials/secrets/{secretId}` +- Mode: READ +- Summary: Retrieve an OAuth 2.0 client secret +- Parameters: + - `appId` in `path` required + - `secretId` in `path` required + +### delete_o_auth2_client_secret + +- Operation ID: `delete_o_auth2_client_secret` +- Route: `DELETE /api/v1/apps/{appId}/credentials/secrets/{secretId}` +- Mode: WRITE +- Summary: Delete an OAuth 2.0 client secret +- Parameters: + - `appId` in `path` required + - `secretId` in `path` required + +### activate_o_auth2_client_secret + +- Operation ID: `activate_o_auth2_client_secret` +- Route: `POST /api/v1/apps/{appId}/credentials/secrets/{secretId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate an OAuth 2.0 client secret +- Parameters: + - `appId` in `path` required + - `secretId` in `path` required + +### deactivate_o_auth2_client_secret + +- Operation ID: `deactivate_o_auth2_client_secret` +- Route: `POST /api/v1/apps/{appId}/credentials/secrets/{secretId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate an OAuth 2.0 client secret +- Parameters: + - `appId` in `path` required + - `secretId` in `path` required + +### get_all_cross_app_access_connections + +- Operation ID: `get_all_cross_app_access_connections` +- Route: `GET /api/v1/apps/{appId}/cwo/connections` +- Mode: READ +- Summary: Retrieve all Cross App Access connections +- Parameters: + - `appId` in `path` required + - `after` in `query` + - `limit` in `query` + - `status` in `query` + - `requestingAppId` in `query` + - `resourceAppId` in `query` + - `activeAppsOnly` in `query` + - `requestingAppName` in `query` + - `resourceAppName` in `query` + +### create_cross_app_access_connection + +- Operation ID: `create_cross_app_access_connection` +- Route: `POST /api/v1/apps/{appId}/cwo/connections` +- Mode: WRITE +- Summary: Create a Cross App Access connection +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### get_cross_app_access_connection + +- Operation ID: `get_cross_app_access_connection` +- Route: `GET /api/v1/apps/{appId}/cwo/connections/{connectionId}` +- Mode: READ +- Summary: Retrieve a Cross App Access connection +- Parameters: + - `appId` in `path` required + - `connectionId` in `path` required + +### update_cross_app_access_connection + +- Operation ID: `update_cross_app_access_connection` +- Route: `PATCH /api/v1/apps/{appId}/cwo/connections/{connectionId}` +- Mode: WRITE +- Summary: Update a Cross App Access connection +- Parameters: + - `appId` in `path` required + - `connectionId` in `path` required +- Body: JSON request body accepted. + +### delete_cross_app_access_connection + +- Operation ID: `delete_cross_app_access_connection` +- Route: `DELETE /api/v1/apps/{appId}/cwo/connections/{connectionId}` +- Mode: WRITE +- Summary: Delete a Cross App Access connection +- Parameters: + - `appId` in `path` required + - `connectionId` in `path` required + +### list_features_for_application + +- Operation ID: `list_features_for_application` +- Route: `GET /api/v1/apps/{appId}/features` +- Mode: READ +- Summary: List all features +- Parameters: + - `appId` in `path` required + +### get_feature_for_application + +- Operation ID: `get_feature_for_application` +- Route: `GET /api/v1/apps/{appId}/features/{featureName}` +- Mode: READ +- Summary: Retrieve a feature +- Parameters: + - `appId` in `path` required + - `featureName` in `path` required + +### update_feature_for_application + +- Operation ID: `update_feature_for_application` +- Route: `PUT /api/v1/apps/{appId}/features/{featureName}` +- Mode: WRITE +- Summary: Update a feature +- Parameters: + - `appId` in `path` required + - `featureName` in `path` required +- Body: JSON request body accepted. + +### list_federated_claims + +- Operation ID: `list_federated_claims` +- Route: `GET /api/v1/apps/{appId}/federated-claims` +- Mode: READ +- Summary: List all configured federated claims +- Parameters: + - `appId` in `path` required + +### create_federated_claim + +- Operation ID: `create_federated_claim` +- Route: `POST /api/v1/apps/{appId}/federated-claims` +- Mode: WRITE +- Summary: Create a federated claim +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### get_federated_claim + +- Operation ID: `get_federated_claim` +- Route: `GET /api/v1/apps/{appId}/federated-claims/{claimId}` +- Mode: READ +- Summary: Retrieve a federated claim +- Parameters: + - `appId` in `path` required + - `claimId` in `path` required + +### replace_federated_claim + +- Operation ID: `replace_federated_claim` +- Route: `PUT /api/v1/apps/{appId}/federated-claims/{claimId}` +- Mode: WRITE +- Summary: Replace a federated claim +- Parameters: + - `appId` in `path` required + - `claimId` in `path` required +- Body: JSON request body accepted. + +### delete_federated_claim + +- Operation ID: `delete_federated_claim` +- Route: `DELETE /api/v1/apps/{appId}/federated-claims/{claimId}` +- Mode: WRITE +- Summary: Delete a federated claim +- Parameters: + - `appId` in `path` required + - `claimId` in `path` required + +### list_scope_consent_grants + +- Operation ID: `list_scope_consent_grants` +- Route: `GET /api/v1/apps/{appId}/grants` +- Mode: READ +- Summary: List all app grants +- Parameters: + - `appId` in `path` required + - `expand` in `query` + +### grant_consent_to_scope + +- Operation ID: `grant_consent_to_scope` +- Route: `POST /api/v1/apps/{appId}/grants` +- Mode: WRITE +- Summary: Grant consent to scope +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### get_scope_consent_grant + +- Operation ID: `get_scope_consent_grant` +- Route: `GET /api/v1/apps/{appId}/grants/{grantId}` +- Mode: READ +- Summary: Retrieve an app grant +- Parameters: + - `appId` in `path` required + - `grantId` in `path` required + - `expand` in `query` + +### revoke_scope_consent_grant + +- Operation ID: `revoke_scope_consent_grant` +- Route: `DELETE /api/v1/apps/{appId}/grants/{grantId}` +- Mode: WRITE +- Summary: Revoke an app grant +- Parameters: + - `appId` in `path` required + - `grantId` in `path` required + +### list_group_push_mappings + +- Operation ID: `list_group_push_mappings` +- Route: `GET /api/v1/apps/{appId}/group-push/mappings` +- Mode: READ +- Summary: List all group push mappings +- Parameters: + - `appId` in `path` required + - `after` in `query` + - `limit` in `query` + - `lastUpdated` in `query` + - `sourceGroupId` in `query` + - `status` in `query` + +### create_group_push_mapping + +- Operation ID: `create_group_push_mapping` +- Route: `POST /api/v1/apps/{appId}/group-push/mappings` +- Mode: WRITE +- Summary: Create a group push mapping +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### get_group_push_mapping + +- Operation ID: `get_group_push_mapping` +- Route: `GET /api/v1/apps/{appId}/group-push/mappings/{mappingId}` +- Mode: READ +- Summary: Retrieve a group push mapping +- Parameters: + - `appId` in `path` required + - `mappingId` in `path` required + +### update_group_push_mapping + +- Operation ID: `update_group_push_mapping` +- Route: `PATCH /api/v1/apps/{appId}/group-push/mappings/{mappingId}` +- Mode: WRITE +- Summary: Update a group push mapping +- Parameters: + - `appId` in `path` required + - `mappingId` in `path` required +- Body: JSON request body accepted. + +### delete_group_push_mapping + +- Operation ID: `delete_group_push_mapping` +- Route: `DELETE /api/v1/apps/{appId}/group-push/mappings/{mappingId}` +- Mode: WRITE +- Summary: Delete a group push mapping +- Parameters: + - `appId` in `path` required + - `mappingId` in `path` required + - `deleteTargetGroup` in `query` required + +### list_application_group_assignments + +- Operation ID: `list_application_group_assignments` +- Route: `GET /api/v1/apps/{appId}/groups` +- Mode: READ +- Summary: List all application groups +- Parameters: + - `appId` in `path` required + - `q` in `query` + - `after` in `query` + - `limit` in `query` + - `expand` in `query` + +### get_application_group_assignment + +- Operation ID: `get_application_group_assignment` +- Route: `GET /api/v1/apps/{appId}/groups/{groupId}` +- Mode: READ +- Summary: Retrieve an application group +- Parameters: + - `appId` in `path` required + - `groupId` in `path` required + - `expand` in `query` + +### assign_group_to_application + +- Operation ID: `assign_group_to_application` +- Route: `PUT /api/v1/apps/{appId}/groups/{groupId}` +- Mode: WRITE +- Summary: Assign an application group +- Parameters: + - `appId` in `path` required + - `groupId` in `path` required +- Body: JSON request body accepted. + +### update_group_assignment_to_application + +- Operation ID: `update_group_assignment_to_application` +- Route: `PATCH /api/v1/apps/{appId}/groups/{groupId}` +- Mode: WRITE +- Summary: Update an application group +- Parameters: + - `appId` in `path` required + - `groupId` in `path` required +- Body: JSON request body accepted. + +### unassign_application_from_group + +- Operation ID: `unassign_application_from_group` +- Route: `DELETE /api/v1/apps/{appId}/groups/{groupId}` +- Mode: WRITE +- Summary: Unassign an application group +- Parameters: + - `appId` in `path` required + - `groupId` in `path` required + +### list_interclient_allowed_applications + +- Operation ID: `list_interclient_allowed_applications` +- Route: `GET /api/v1/apps/{appId}/interclient-allowed-apps` +- Mode: READ +- Summary: List all allowed apps for a target app +- Parameters: + - `appId` in `path` required + +### create_interclient_trust_mapping + +- Operation ID: `create_interclient_trust_mapping` +- Route: `POST /api/v1/apps/{appId}/interclient-allowed-apps` +- Mode: WRITE +- Summary: Create an allowed app mapping for a target app +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### delete_interclient_trust_mapping + +- Operation ID: `delete_interclient_trust_mapping` +- Route: `DELETE /api/v1/apps/{appId}/interclient-allowed-apps/{allowedAppId}` +- Mode: WRITE +- Summary: Delete an interclient trust mapping +- Parameters: + - `appId` in `path` required + - `allowedAppId` in `path` required + +### list_interclient_target_applications + +- Operation ID: `list_interclient_target_applications` +- Route: `GET /api/v1/apps/{appId}/interclient-target-apps` +- Mode: READ +- Summary: List all target apps for an allowed app +- Parameters: + - `appId` in `path` required + +### activate_application + +- Operation ID: `activate_application` +- Route: `POST /api/v1/apps/{appId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate an application +- Parameters: + - `appId` in `path` required + +### deactivate_application + +- Operation ID: `deactivate_application` +- Route: `POST /api/v1/apps/{appId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate an application +- Parameters: + - `appId` in `path` required + +### upload_application_logo + +- Operation ID: `upload_application_logo` +- Route: `POST /api/v1/apps/{appId}/logo` +- Mode: WRITE +- Summary: Upload an application logo +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### assign_application_policy + +- Operation ID: `assign_application_policy` +- Route: `PUT /api/v1/apps/{appId}/policies/{policyId}` +- Mode: WRITE +- Summary: Assign an app sign-in policy +- Parameters: + - `appId` in `path` required + - `policyId` in `path` required + +### preview_sam_lmetadata_for_application + +- Operation ID: `preview_sam_lmetadata_for_application` +- Route: `GET /api/v1/apps/{appId}/sso/saml/metadata` +- Mode: READ +- Summary: Preview the application SAML metadata +- Parameters: + - `appId` in `path` required + - `kid` in `query` required + +### list_o_auth2_tokens_for_application + +- Operation ID: `list_o_auth2_tokens_for_application` +- Route: `GET /api/v1/apps/{appId}/tokens` +- Mode: READ +- Summary: List all application refresh tokens +- Parameters: + - `appId` in `path` required + - `expand` in `query` + - `after` in `query` + - `limit` in `query` + +### revoke_o_auth2_tokens_for_application + +- Operation ID: `revoke_o_auth2_tokens_for_application` +- Route: `DELETE /api/v1/apps/{appId}/tokens` +- Mode: WRITE +- Summary: Revoke all application tokens +- Parameters: + - `appId` in `path` required + +### get_o_auth2_token_for_application + +- Operation ID: `get_o_auth2_token_for_application` +- Route: `GET /api/v1/apps/{appId}/tokens/{tokenId}` +- Mode: READ +- Summary: Retrieve an application token +- Parameters: + - `appId` in `path` required + - `tokenId` in `path` required + - `expand` in `query` + +### revoke_o_auth2_token_for_application + +- Operation ID: `revoke_o_auth2_token_for_application` +- Route: `DELETE /api/v1/apps/{appId}/tokens/{tokenId}` +- Mode: WRITE +- Summary: Revoke an application token +- Parameters: + - `appId` in `path` required + - `tokenId` in `path` required + +### list_application_users + +- Operation ID: `list_application_users` +- Route: `GET /api/v1/apps/{appId}/users` +- Mode: READ +- Summary: List all application users +- Parameters: + - `appId` in `path` required + - `after` in `query` + - `limit` in `query` + - `q` in `query` + - `expand` in `query` + +### assign_user_to_application + +- Operation ID: `assign_user_to_application` +- Route: `POST /api/v1/apps/{appId}/users` +- Mode: WRITE +- Summary: Assign an application user +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### get_application_user + +- Operation ID: `get_application_user` +- Route: `GET /api/v1/apps/{appId}/users/{userId}` +- Mode: READ +- Summary: Retrieve an application user +- Parameters: + - `appId` in `path` required + - `userId` in `path` required + - `expand` in `query` + +### update_application_user + +- Operation ID: `update_application_user` +- Route: `POST /api/v1/apps/{appId}/users/{userId}` +- Mode: WRITE +- Summary: Update an application user +- Parameters: + - `appId` in `path` required + - `userId` in `path` required +- Body: JSON request body accepted. + +### unassign_user_from_application + +- Operation ID: `unassign_user_from_application` +- Route: `DELETE /api/v1/apps/{appId}/users/{userId}` +- Mode: WRITE +- Summary: Unassign an application user +- Parameters: + - `appId` in `path` required + - `userId` in `path` required + - `sendEmail` in `query` + +### verify_provisioning_connection_for_application + +- Operation ID: `verify_provisioning_connection_for_application` +- Route: `POST /api/v1/apps/{appName}/{appId}/oauth2/callback` +- Mode: WRITE +- Summary: Verify the provisioning connection +- Parameters: + - `appName` in `path` required + - `appId` in `path` required + - `code` in `query` + - `state` in `query` diff --git a/skills/authenticators/SKILL.md b/skills/authenticators/SKILL.md new file mode 100644 index 0000000..3c8ee8b --- /dev/null +++ b/skills/authenticators/SKILL.md @@ -0,0 +1,189 @@ +--- +name: authenticators-routes +description: Handle 18 OpenAPI operation(s) under /api/v1/authenticators for the authenticators route group. +--- + +# authenticators API Routes + +Handle 18 OpenAPI operation(s) under /api/v1/authenticators for the authenticators route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_authenticators + +- Operation ID: `list_authenticators` +- Route: `GET /api/v1/authenticators` +- Mode: READ +- Summary: List all authenticators + +### create_authenticator + +- Operation ID: `create_authenticator` +- Route: `POST /api/v1/authenticators` +- Mode: WRITE +- Summary: Create an authenticator +- Parameters: + - `activate` in `query` +- Body: JSON request body accepted. + +### get_authenticator + +- Operation ID: `get_authenticator` +- Route: `GET /api/v1/authenticators/{authenticatorId}` +- Mode: READ +- Summary: Retrieve an authenticator +- Parameters: + - `authenticatorId` in `path` required + +### replace_authenticator + +- Operation ID: `replace_authenticator` +- Route: `PUT /api/v1/authenticators/{authenticatorId}` +- Mode: WRITE +- Summary: Replace an authenticator +- Parameters: + - `authenticatorId` in `path` required +- Body: JSON request body accepted. + +### list_all_custom_aagui_ds + +- Operation ID: `list_all_custom_aagui_ds` +- Route: `GET /api/v1/authenticators/{authenticatorId}/aaguids` +- Mode: READ +- Summary: List all custom AAGUIDs +- Parameters: + - `authenticatorId` in `path` required + +### create_custom_aaguid + +- Operation ID: `create_custom_aaguid` +- Route: `POST /api/v1/authenticators/{authenticatorId}/aaguids` +- Mode: WRITE +- Summary: Create a custom AAGUID +- Parameters: + - `authenticatorId` in `path` required +- Body: JSON request body accepted. + +### get_custom_aaguid + +- Operation ID: `get_custom_aaguid` +- Route: `GET /api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}` +- Mode: READ +- Summary: Retrieve a custom AAGUID +- Parameters: + - `authenticatorId` in `path` required + - `aaguid` in `path` required + +### replace_custom_aaguid + +- Operation ID: `replace_custom_aaguid` +- Route: `PUT /api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}` +- Mode: WRITE +- Summary: Replace a custom AAGUID +- Parameters: + - `authenticatorId` in `path` required + - `aaguid` in `path` required +- Body: JSON request body accepted. + +### update_custom_aaguid + +- Operation ID: `update_custom_aaguid` +- Route: `PATCH /api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}` +- Mode: WRITE +- Summary: Update a custom AAGUID +- Parameters: + - `authenticatorId` in `path` required + - `aaguid` in `path` required +- Body: JSON request body accepted. + +### delete_custom_aaguid + +- Operation ID: `delete_custom_aaguid` +- Route: `DELETE /api/v1/authenticators/{authenticatorId}/aaguids/{aaguid}` +- Mode: WRITE +- Summary: Delete a custom AAGUID +- Parameters: + - `authenticatorId` in `path` required + - `aaguid` in `path` required + +### activate_authenticator + +- Operation ID: `activate_authenticator` +- Route: `POST /api/v1/authenticators/{authenticatorId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate an authenticator +- Parameters: + - `authenticatorId` in `path` required + +### deactivate_authenticator + +- Operation ID: `deactivate_authenticator` +- Route: `POST /api/v1/authenticators/{authenticatorId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate an authenticator +- Parameters: + - `authenticatorId` in `path` required + +### list_authenticator_methods + +- Operation ID: `list_authenticator_methods` +- Route: `GET /api/v1/authenticators/{authenticatorId}/methods` +- Mode: READ +- Summary: List all methods of an authenticator +- Parameters: + - `authenticatorId` in `path` required + +### get_authenticator_method + +- Operation ID: `get_authenticator_method` +- Route: `GET /api/v1/authenticators/{authenticatorId}/methods/{methodType}` +- Mode: READ +- Summary: Retrieve an authenticator method +- Parameters: + - `authenticatorId` in `path` required + - `methodType` in `path` required + +### replace_authenticator_method + +- Operation ID: `replace_authenticator_method` +- Route: `PUT /api/v1/authenticators/{authenticatorId}/methods/{methodType}` +- Mode: WRITE +- Summary: Replace an authenticator method +- Parameters: + - `authenticatorId` in `path` required + - `methodType` in `path` required +- Body: JSON request body accepted. + +### activate_authenticator_method + +- Operation ID: `activate_authenticator_method` +- Route: `POST /api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate an authenticator method +- Parameters: + - `authenticatorId` in `path` required + - `methodType` in `path` required + +### deactivate_authenticator_method + +- Operation ID: `deactivate_authenticator_method` +- Route: `POST /api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate an authenticator method +- Parameters: + - `authenticatorId` in `path` required + - `methodType` in `path` required + +### verify_rp_id_domain + +- Operation ID: `verify_rp_id_domain` +- Route: `POST /api/v1/authenticators/{authenticatorId}/methods/{webAuthnMethodType}/verify-rp-id-domain` +- Mode: WRITE +- Summary: Verify a Relying Party ID domain +- Parameters: + - `authenticatorId` in `path` required + - `webAuthnMethodType` in `path` required diff --git a/skills/authorization-servers/SKILL.md b/skills/authorization-servers/SKILL.md new file mode 100644 index 0000000..ce62b7f --- /dev/null +++ b/skills/authorization-servers/SKILL.md @@ -0,0 +1,506 @@ +--- +name: authorization-servers-routes +description: Handle 48 OpenAPI operation(s) under /api/v1/authorizationServers for the authorizationServers route group. +--- + +# authorizationServers API Routes + +Handle 48 OpenAPI operation(s) under /api/v1/authorizationServers for the authorizationServers route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_authorization_servers + +- Operation ID: `list_authorization_servers` +- Route: `GET /api/v1/authorizationServers` +- Mode: READ +- Summary: List all authorization servers +- Parameters: + - `q` in `query` + - `limit` in `query` + - `after` in `query` + +### create_authorization_server + +- Operation ID: `create_authorization_server` +- Route: `POST /api/v1/authorizationServers` +- Mode: WRITE +- Summary: Create an authorization server +- Body: JSON request body accepted. + +### get_authorization_server + +- Operation ID: `get_authorization_server` +- Route: `GET /api/v1/authorizationServers/{authServerId}` +- Mode: READ +- Summary: Retrieve an authorization server +- Parameters: + - `authServerId` in `path` required + +### replace_authorization_server + +- Operation ID: `replace_authorization_server` +- Route: `PUT /api/v1/authorizationServers/{authServerId}` +- Mode: WRITE +- Summary: Replace an authorization server +- Parameters: + - `authServerId` in `path` required +- Body: JSON request body accepted. + +### delete_authorization_server + +- Operation ID: `delete_authorization_server` +- Route: `DELETE /api/v1/authorizationServers/{authServerId}` +- Mode: WRITE +- Summary: Delete an authorization server +- Parameters: + - `authServerId` in `path` required + +### list_associated_servers_by_trusted_type + +- Operation ID: `list_associated_servers_by_trusted_type` +- Route: `GET /api/v1/authorizationServers/{authServerId}/associatedServers` +- Mode: READ +- Summary: List all associated authorization servers +- Parameters: + - `authServerId` in `path` required + - `trusted` in `query` + - `q` in `query` + - `limit` in `query` + - `after` in `query` + +### create_associated_servers + +- Operation ID: `create_associated_servers` +- Route: `POST /api/v1/authorizationServers/{authServerId}/associatedServers` +- Mode: WRITE +- Summary: Create an associated authorization server +- Parameters: + - `authServerId` in `path` required +- Body: JSON request body accepted. + +### delete_associated_server + +- Operation ID: `delete_associated_server` +- Route: `DELETE /api/v1/authorizationServers/{authServerId}/associatedServers/{associatedServerId}` +- Mode: WRITE +- Summary: Delete an associated authorization server +- Parameters: + - `authServerId` in `path` required + - `associatedServerId` in `path` required + +### list_o_auth2_claims + +- Operation ID: `list_o_auth2_claims` +- Route: `GET /api/v1/authorizationServers/{authServerId}/claims` +- Mode: READ +- Summary: List all custom token claims +- Parameters: + - `authServerId` in `path` required + +### create_o_auth2_claim + +- Operation ID: `create_o_auth2_claim` +- Route: `POST /api/v1/authorizationServers/{authServerId}/claims` +- Mode: WRITE +- Summary: Create a custom token claim +- Parameters: + - `authServerId` in `path` required +- Body: JSON request body accepted. + +### get_o_auth2_claim + +- Operation ID: `get_o_auth2_claim` +- Route: `GET /api/v1/authorizationServers/{authServerId}/claims/{claimId}` +- Mode: READ +- Summary: Retrieve a custom token claim +- Parameters: + - `authServerId` in `path` required + - `claimId` in `path` required + +### replace_o_auth2_claim + +- Operation ID: `replace_o_auth2_claim` +- Route: `PUT /api/v1/authorizationServers/{authServerId}/claims/{claimId}` +- Mode: WRITE +- Summary: Replace a custom token claim +- Parameters: + - `authServerId` in `path` required + - `claimId` in `path` required +- Body: JSON request body accepted. + +### delete_o_auth2_claim + +- Operation ID: `delete_o_auth2_claim` +- Route: `DELETE /api/v1/authorizationServers/{authServerId}/claims/{claimId}` +- Mode: WRITE +- Summary: Delete a custom token claim +- Parameters: + - `authServerId` in `path` required + - `claimId` in `path` required + +### list_o_auth2_clients_for_authorization_server + +- Operation ID: `list_o_auth2_clients_for_authorization_server` +- Route: `GET /api/v1/authorizationServers/{authServerId}/clients` +- Mode: READ +- Summary: List all client resources for an authorization server +- Parameters: + - `authServerId` in `path` required + +### list_refresh_tokens_for_authorization_server_and_client + +- Operation ID: `list_refresh_tokens_for_authorization_server_and_client` +- Route: `GET /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens` +- Mode: READ +- Summary: List all refresh tokens for a client +- Parameters: + - `authServerId` in `path` required + - `clientId` in `path` required + - `expand` in `query` + - `after` in `query` + - `limit` in `query` + +### revoke_refresh_tokens_for_authorization_server_and_client + +- Operation ID: `revoke_refresh_tokens_for_authorization_server_and_client` +- Route: `DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens` +- Mode: WRITE +- Summary: Revoke all refresh tokens for a client +- Parameters: + - `authServerId` in `path` required + - `clientId` in `path` required + +### get_refresh_token_for_authorization_server_and_client + +- Operation ID: `get_refresh_token_for_authorization_server_and_client` +- Route: `GET /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}` +- Mode: READ +- Summary: Retrieve a refresh token for a client +- Parameters: + - `authServerId` in `path` required + - `clientId` in `path` required + - `tokenId` in `path` required + - `expand` in `query` + +### revoke_refresh_token_for_authorization_server_and_client + +- Operation ID: `revoke_refresh_token_for_authorization_server_and_client` +- Route: `DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}` +- Mode: WRITE +- Summary: Revoke a refresh token for a client +- Parameters: + - `authServerId` in `path` required + - `clientId` in `path` required + - `tokenId` in `path` required + +### list_authorization_server_keys + +- Operation ID: `list_authorization_server_keys` +- Route: `GET /api/v1/authorizationServers/{authServerId}/credentials/keys` +- Mode: READ +- Summary: List all credential keys +- Parameters: + - `authServerId` in `path` required + +### get_authorization_server_key + +- Operation ID: `get_authorization_server_key` +- Route: `GET /api/v1/authorizationServers/{authServerId}/credentials/keys/{keyId}` +- Mode: READ +- Summary: Retrieve an authorization server key +- Parameters: + - `authServerId` in `path` required + - `keyId` in `path` required + +### rotate_authorization_server_keys + +- Operation ID: `rotate_authorization_server_keys` +- Route: `POST /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate` +- Mode: WRITE +- Summary: Rotate all credential keys +- Parameters: + - `authServerId` in `path` required +- Body: JSON request body accepted. + +### activate_authorization_server + +- Operation ID: `activate_authorization_server` +- Route: `POST /api/v1/authorizationServers/{authServerId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate an authorization server +- Parameters: + - `authServerId` in `path` required + +### deactivate_authorization_server + +- Operation ID: `deactivate_authorization_server` +- Route: `POST /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate an authorization server +- Parameters: + - `authServerId` in `path` required + +### list_authorization_server_policies + +- Operation ID: `list_authorization_server_policies` +- Route: `GET /api/v1/authorizationServers/{authServerId}/policies` +- Mode: READ +- Summary: List all policies +- Parameters: + - `authServerId` in `path` required + +### create_authorization_server_policy + +- Operation ID: `create_authorization_server_policy` +- Route: `POST /api/v1/authorizationServers/{authServerId}/policies` +- Mode: WRITE +- Summary: Create a policy +- Parameters: + - `authServerId` in `path` required +- Body: JSON request body accepted. + +### get_authorization_server_policy + +- Operation ID: `get_authorization_server_policy` +- Route: `GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}` +- Mode: READ +- Summary: Retrieve a policy +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required + +### replace_authorization_server_policy + +- Operation ID: `replace_authorization_server_policy` +- Route: `PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}` +- Mode: WRITE +- Summary: Replace a policy +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required +- Body: JSON request body accepted. + +### delete_authorization_server_policy + +- Operation ID: `delete_authorization_server_policy` +- Route: `DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}` +- Mode: WRITE +- Summary: Delete a policy +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required + +### activate_authorization_server_policy + +- Operation ID: `activate_authorization_server_policy` +- Route: `POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate a policy +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required + +### deactivate_authorization_server_policy + +- Operation ID: `deactivate_authorization_server_policy` +- Route: `POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate a policy +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required + +### list_authorization_server_policy_rules + +- Operation ID: `list_authorization_server_policy_rules` +- Route: `GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules` +- Mode: READ +- Summary: List all policy rules +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required + +### create_authorization_server_policy_rule + +- Operation ID: `create_authorization_server_policy_rule` +- Route: `POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules` +- Mode: WRITE +- Summary: Create a policy rule +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required +- Body: JSON request body accepted. + +### get_authorization_server_policy_rule + +- Operation ID: `get_authorization_server_policy_rule` +- Route: `GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}` +- Mode: READ +- Summary: Retrieve a policy rule +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required + - `ruleId` in `path` required + +### replace_authorization_server_policy_rule + +- Operation ID: `replace_authorization_server_policy_rule` +- Route: `PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}` +- Mode: WRITE +- Summary: Replace a policy rule +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required + - `ruleId` in `path` required +- Body: JSON request body accepted. + +### delete_authorization_server_policy_rule + +- Operation ID: `delete_authorization_server_policy_rule` +- Route: `DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}` +- Mode: WRITE +- Summary: Delete a policy rule +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required + - `ruleId` in `path` required + +### activate_authorization_server_policy_rule + +- Operation ID: `activate_authorization_server_policy_rule` +- Route: `POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate a policy rule +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required + - `ruleId` in `path` required + +### deactivate_authorization_server_policy_rule + +- Operation ID: `deactivate_authorization_server_policy_rule` +- Route: `POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate a policy rule +- Parameters: + - `authServerId` in `path` required + - `policyId` in `path` required + - `ruleId` in `path` required + +### list_o_auth2_resource_server_json_web_keys + +- Operation ID: `list_o_auth2_resource_server_json_web_keys` +- Route: `GET /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys` +- Mode: READ +- Summary: List all Custom Authorization Server Public JSON Web Keys +- Parameters: + - `authServerId` in `path` required + +### add_o_auth2_resource_server_json_web_key + +- Operation ID: `add_o_auth2_resource_server_json_web_key` +- Route: `POST /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys` +- Mode: WRITE +- Summary: Add a JSON Web Key +- Parameters: + - `authServerId` in `path` required +- Body: JSON request body accepted. + +### get_o_auth2_resource_server_json_web_key + +- Operation ID: `get_o_auth2_resource_server_json_web_key` +- Route: `GET /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}` +- Mode: READ +- Summary: Retrieve a Custom Authorization Server Public JSON Web Key +- Parameters: + - `authServerId` in `path` required + - `keyId` in `path` required + +### delete_o_auth2_resource_server_json_web_key + +- Operation ID: `delete_o_auth2_resource_server_json_web_key` +- Route: `DELETE /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}` +- Mode: WRITE +- Summary: Delete a Custom Authorization Server Public JSON Web Key +- Parameters: + - `authServerId` in `path` required + - `keyId` in `path` required + +### activate_o_auth2_resource_server_json_web_key + +- Operation ID: `activate_o_auth2_resource_server_json_web_key` +- Route: `POST /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate a Custom Authorization Server Public JSON Web Key +- Parameters: + - `authServerId` in `path` required + - `keyId` in `path` required + +### deactivate_o_auth2_resource_server_json_web_key + +- Operation ID: `deactivate_o_auth2_resource_server_json_web_key` +- Route: `POST /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate a Custom Authorization Server Public JSON Web Key +- Parameters: + - `authServerId` in `path` required + - `keyId` in `path` required + +### list_o_auth2_scopes + +- Operation ID: `list_o_auth2_scopes` +- Route: `GET /api/v1/authorizationServers/{authServerId}/scopes` +- Mode: READ +- Summary: List all custom token scopes +- Parameters: + - `authServerId` in `path` required + - `q` in `query` + - `filter` in `query` + - `after` in `query` + - `limit` in `query` + +### create_o_auth2_scope + +- Operation ID: `create_o_auth2_scope` +- Route: `POST /api/v1/authorizationServers/{authServerId}/scopes` +- Mode: WRITE +- Summary: Create a custom token scope +- Parameters: + - `authServerId` in `path` required +- Body: JSON request body accepted. + +### get_o_auth2_scope + +- Operation ID: `get_o_auth2_scope` +- Route: `GET /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}` +- Mode: READ +- Summary: Retrieve a custom token scope +- Parameters: + - `authServerId` in `path` required + - `scopeId` in `path` required + +### replace_o_auth2_scope + +- Operation ID: `replace_o_auth2_scope` +- Route: `PUT /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}` +- Mode: WRITE +- Summary: Replace a custom token scope +- Parameters: + - `authServerId` in `path` required + - `scopeId` in `path` required +- Body: JSON request body accepted. + +### delete_o_auth2_scope + +- Operation ID: `delete_o_auth2_scope` +- Route: `DELETE /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}` +- Mode: WRITE +- Summary: Delete a custom token scope +- Parameters: + - `authServerId` in `path` required + - `scopeId` in `path` required diff --git a/skills/behaviors/SKILL.md b/skills/behaviors/SKILL.md new file mode 100644 index 0000000..ea16ed0 --- /dev/null +++ b/skills/behaviors/SKILL.md @@ -0,0 +1,75 @@ +--- +name: behaviors-routes +description: Handle 7 OpenAPI operation(s) under /api/v1/behaviors for the behaviors route group. +--- + +# behaviors API Routes + +Handle 7 OpenAPI operation(s) under /api/v1/behaviors for the behaviors route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_behavior_detection_rules + +- Operation ID: `list_behavior_detection_rules` +- Route: `GET /api/v1/behaviors` +- Mode: READ +- Summary: List all behavior detection rules + +### create_behavior_detection_rule + +- Operation ID: `create_behavior_detection_rule` +- Route: `POST /api/v1/behaviors` +- Mode: WRITE +- Summary: Create a behavior detection rule +- Body: JSON request body accepted. + +### get_behavior_detection_rule + +- Operation ID: `get_behavior_detection_rule` +- Route: `GET /api/v1/behaviors/{behaviorId}` +- Mode: READ +- Summary: Retrieve a behavior detection rule +- Parameters: + - `behaviorId` in `path` required + +### replace_behavior_detection_rule + +- Operation ID: `replace_behavior_detection_rule` +- Route: `PUT /api/v1/behaviors/{behaviorId}` +- Mode: WRITE +- Summary: Replace a behavior detection rule +- Parameters: + - `behaviorId` in `path` required +- Body: JSON request body accepted. + +### delete_behavior_detection_rule + +- Operation ID: `delete_behavior_detection_rule` +- Route: `DELETE /api/v1/behaviors/{behaviorId}` +- Mode: WRITE +- Summary: Delete a behavior detection rule +- Parameters: + - `behaviorId` in `path` required + +### activate_behavior_detection_rule + +- Operation ID: `activate_behavior_detection_rule` +- Route: `POST /api/v1/behaviors/{behaviorId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate a behavior detection rule +- Parameters: + - `behaviorId` in `path` required + +### deactivate_behavior_detection_rule + +- Operation ID: `deactivate_behavior_detection_rule` +- Route: `POST /api/v1/behaviors/{behaviorId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate a behavior detection rule +- Parameters: + - `behaviorId` in `path` required diff --git a/skills/bot-protection/SKILL.md b/skills/bot-protection/SKILL.md new file mode 100644 index 0000000..cf4f549 --- /dev/null +++ b/skills/bot-protection/SKILL.md @@ -0,0 +1,29 @@ +--- +name: bot-protection-routes +description: Handle 2 OpenAPI operation(s) under /api/v1/bot-protection/configuration for the bot protection route group. +--- + +# bot protection API Routes + +Handle 2 OpenAPI operation(s) under /api/v1/bot-protection/configuration for the bot protection route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### get_bot_protection_configuration + +- Operation ID: `get_bot_protection_configuration` +- Route: `GET /api/v1/bot-protection/configuration` +- Mode: READ +- Summary: Retrieve the bot protection configuration + +### update_bot_protection_configuration + +- Operation ID: `update_bot_protection_configuration` +- Route: `POST /api/v1/bot-protection/configuration` +- Mode: WRITE +- Summary: Update the bot protection configuration +- Body: JSON request body accepted. diff --git a/skills/brands/SKILL.md b/skills/brands/SKILL.md new file mode 100644 index 0000000..db671aa --- /dev/null +++ b/skills/brands/SKILL.md @@ -0,0 +1,540 @@ +--- +name: brands-routes +description: Handle 52 OpenAPI operation(s) under /api/v1/brands for the brands route group. +--- + +# brands API Routes + +Handle 52 OpenAPI operation(s) under /api/v1/brands for the brands route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_brands + +- Operation ID: `list_brands` +- Route: `GET /api/v1/brands` +- Mode: READ +- Summary: List all brands +- Parameters: + - `expand` in `query` + - `after` in `query` + - `limit` in `query` + - `q` in `query` + +### create_brand + +- Operation ID: `create_brand` +- Route: `POST /api/v1/brands` +- Mode: WRITE +- Summary: Create a brand +- Body: JSON request body accepted. + +### get_brand + +- Operation ID: `get_brand` +- Route: `GET /api/v1/brands/{brandId}` +- Mode: READ +- Summary: Retrieve a brand +- Parameters: + - `brandId` in `path` required + - `expand` in `query` + +### replace_brand + +- Operation ID: `replace_brand` +- Route: `PUT /api/v1/brands/{brandId}` +- Mode: WRITE +- Summary: Replace a brand +- Parameters: + - `brandId` in `path` required +- Body: JSON request body accepted. + +### delete_brand + +- Operation ID: `delete_brand` +- Route: `DELETE /api/v1/brands/{brandId}` +- Mode: WRITE +- Summary: Delete a brand +- Parameters: + - `brandId` in `path` required + +### list_brand_domains + +- Operation ID: `list_brand_domains` +- Route: `GET /api/v1/brands/{brandId}/domains` +- Mode: READ +- Summary: List all domains associated with a brand +- Parameters: + - `brandId` in `path` required + +### get_error_page + +- Operation ID: `get_error_page` +- Route: `GET /api/v1/brands/{brandId}/pages/error` +- Mode: READ +- Summary: Retrieve the error page sub-resources +- Parameters: + - `brandId` in `path` required + - `expand` in `query` + +### get_customized_error_page + +- Operation ID: `get_customized_error_page` +- Route: `GET /api/v1/brands/{brandId}/pages/error/customized` +- Mode: READ +- Summary: Retrieve the customized error page +- Parameters: + - `brandId` in `path` required + +### replace_customized_error_page + +- Operation ID: `replace_customized_error_page` +- Route: `PUT /api/v1/brands/{brandId}/pages/error/customized` +- Mode: WRITE +- Summary: Replace the customized error page +- Parameters: + - `brandId` in `path` required +- Body: JSON request body accepted. + +### delete_customized_error_page + +- Operation ID: `delete_customized_error_page` +- Route: `DELETE /api/v1/brands/{brandId}/pages/error/customized` +- Mode: WRITE +- Summary: Delete the customized error page +- Parameters: + - `brandId` in `path` required + +### get_default_error_page + +- Operation ID: `get_default_error_page` +- Route: `GET /api/v1/brands/{brandId}/pages/error/default` +- Mode: READ +- Summary: Retrieve the default error page +- Parameters: + - `brandId` in `path` required + +### get_preview_error_page + +- Operation ID: `get_preview_error_page` +- Route: `GET /api/v1/brands/{brandId}/pages/error/preview` +- Mode: READ +- Summary: Retrieve the preview error page preview +- Parameters: + - `brandId` in `path` required + +### replace_preview_error_page + +- Operation ID: `replace_preview_error_page` +- Route: `PUT /api/v1/brands/{brandId}/pages/error/preview` +- Mode: WRITE +- Summary: Replace the preview error page +- Parameters: + - `brandId` in `path` required +- Body: JSON request body accepted. + +### delete_preview_error_page + +- Operation ID: `delete_preview_error_page` +- Route: `DELETE /api/v1/brands/{brandId}/pages/error/preview` +- Mode: WRITE +- Summary: Delete the preview error page +- Parameters: + - `brandId` in `path` required + +### get_sign_in_page + +- Operation ID: `get_sign_in_page` +- Route: `GET /api/v1/brands/{brandId}/pages/sign-in` +- Mode: READ +- Summary: Retrieve the sign-in page sub-resources +- Parameters: + - `brandId` in `path` required + - `expand` in `query` + +### get_customized_sign_in_page + +- Operation ID: `get_customized_sign_in_page` +- Route: `GET /api/v1/brands/{brandId}/pages/sign-in/customized` +- Mode: READ +- Summary: Retrieve the customized sign-in page +- Parameters: + - `brandId` in `path` required + +### replace_customized_sign_in_page + +- Operation ID: `replace_customized_sign_in_page` +- Route: `PUT /api/v1/brands/{brandId}/pages/sign-in/customized` +- Mode: WRITE +- Summary: Replace the customized sign-in page +- Parameters: + - `brandId` in `path` required +- Body: JSON request body accepted. + +### delete_customized_sign_in_page + +- Operation ID: `delete_customized_sign_in_page` +- Route: `DELETE /api/v1/brands/{brandId}/pages/sign-in/customized` +- Mode: WRITE +- Summary: Delete the customized sign-in page +- Parameters: + - `brandId` in `path` required + +### get_default_sign_in_page + +- Operation ID: `get_default_sign_in_page` +- Route: `GET /api/v1/brands/{brandId}/pages/sign-in/default` +- Mode: READ +- Summary: Retrieve the default sign-in page +- Parameters: + - `brandId` in `path` required + +### get_preview_sign_in_page + +- Operation ID: `get_preview_sign_in_page` +- Route: `GET /api/v1/brands/{brandId}/pages/sign-in/preview` +- Mode: READ +- Summary: Retrieve the preview sign-in page preview +- Parameters: + - `brandId` in `path` required + +### replace_preview_sign_in_page + +- Operation ID: `replace_preview_sign_in_page` +- Route: `PUT /api/v1/brands/{brandId}/pages/sign-in/preview` +- Mode: WRITE +- Summary: Replace the preview sign-in page +- Parameters: + - `brandId` in `path` required +- Body: JSON request body accepted. + +### delete_preview_sign_in_page + +- Operation ID: `delete_preview_sign_in_page` +- Route: `DELETE /api/v1/brands/{brandId}/pages/sign-in/preview` +- Mode: WRITE +- Summary: Delete the preview sign-in page +- Parameters: + - `brandId` in `path` required + +### list_all_sign_in_widget_versions + +- Operation ID: `list_all_sign_in_widget_versions` +- Route: `GET /api/v1/brands/{brandId}/pages/sign-in/widget-versions` +- Mode: READ +- Summary: List all Sign-In Widget versions +- Parameters: + - `brandId` in `path` required + +### get_sign_out_page_settings + +- Operation ID: `get_sign_out_page_settings` +- Route: `GET /api/v1/brands/{brandId}/pages/sign-out/customized` +- Mode: READ +- Summary: Retrieve the sign-out page settings +- Parameters: + - `brandId` in `path` required + +### replace_sign_out_page_settings + +- Operation ID: `replace_sign_out_page_settings` +- Route: `PUT /api/v1/brands/{brandId}/pages/sign-out/customized` +- Mode: WRITE +- Summary: Replace the sign-out page settings +- Parameters: + - `brandId` in `path` required +- Body: JSON request body accepted. + +### list_email_templates + +- Operation ID: `list_email_templates` +- Route: `GET /api/v1/brands/{brandId}/templates/email` +- Mode: READ +- Summary: List all email templates +- Parameters: + - `brandId` in `path` required + - `after` in `query` + - `limit` in `query` + - `expand` in `query` + +### get_email_template + +- Operation ID: `get_email_template` +- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}` +- Mode: READ +- Summary: Retrieve an email template +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + - `expand` in `query` + +### list_email_customizations + +- Operation ID: `list_email_customizations` +- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations` +- Mode: READ +- Summary: List all email customizations +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + - `after` in `query` + - `limit` in `query` + +### create_email_customization + +- Operation ID: `create_email_customization` +- Route: `POST /api/v1/brands/{brandId}/templates/email/{templateName}/customizations` +- Mode: WRITE +- Summary: Create an email customization +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required +- Body: JSON request body accepted. + +### delete_all_customizations + +- Operation ID: `delete_all_customizations` +- Route: `DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations` +- Mode: WRITE +- Summary: Delete all email customizations +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + +### get_email_customization + +- Operation ID: `get_email_customization` +- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}` +- Mode: READ +- Summary: Retrieve an email customization +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + - `customizationId` in `path` required + +### replace_email_customization + +- Operation ID: `replace_email_customization` +- Route: `PUT /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}` +- Mode: WRITE +- Summary: Replace an email customization +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + - `customizationId` in `path` required +- Body: JSON request body accepted. + +### delete_email_customization + +- Operation ID: `delete_email_customization` +- Route: `DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}` +- Mode: WRITE +- Summary: Delete an email customization +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + - `customizationId` in `path` required + +### get_customization_preview + +- Operation ID: `get_customization_preview` +- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview` +- Mode: READ +- Summary: Retrieve a preview of an email customization +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + - `customizationId` in `path` required + +### get_email_default_content + +- Operation ID: `get_email_default_content` +- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/default-content` +- Mode: READ +- Summary: Retrieve an email template default content +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + - `language` in `query` + +### get_email_default_preview + +- Operation ID: `get_email_default_preview` +- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview` +- Mode: READ +- Summary: Retrieve a preview of the email template default content +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + - `language` in `query` + +### get_email_settings + +- Operation ID: `get_email_settings` +- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/settings` +- Mode: READ +- Summary: Retrieve the email template settings +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + +### replace_email_settings + +- Operation ID: `replace_email_settings` +- Route: `PUT /api/v1/brands/{brandId}/templates/email/{templateName}/settings` +- Mode: WRITE +- Summary: Replace the email template settings +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required +- Body: JSON request body accepted. + +### send_test_email + +- Operation ID: `send_test_email` +- Route: `POST /api/v1/brands/{brandId}/templates/email/{templateName}/test` +- Mode: WRITE +- Summary: Send a test email +- Parameters: + - `brandId` in `path` required + - `templateName` in `path` required + - `language` in `query` + +### list_brand_themes + +- Operation ID: `list_brand_themes` +- Route: `GET /api/v1/brands/{brandId}/themes` +- Mode: READ +- Summary: List all themes +- Parameters: + - `brandId` in `path` required + +### get_brand_theme + +- Operation ID: `get_brand_theme` +- Route: `GET /api/v1/brands/{brandId}/themes/{themeId}` +- Mode: READ +- Summary: Retrieve a theme +- Parameters: + - `brandId` in `path` required + - `themeId` in `path` required + +### replace_brand_theme + +- Operation ID: `replace_brand_theme` +- Route: `PUT /api/v1/brands/{brandId}/themes/{themeId}` +- Mode: WRITE +- Summary: Replace a theme +- Parameters: + - `brandId` in `path` required + - `themeId` in `path` required +- Body: JSON request body accepted. + +### upload_brand_theme_background_image + +- Operation ID: `upload_brand_theme_background_image` +- Route: `POST /api/v1/brands/{brandId}/themes/{themeId}/background-image` +- Mode: WRITE +- Summary: Upload the background image +- Parameters: + - `brandId` in `path` required + - `themeId` in `path` required +- Body: JSON request body accepted. + +### delete_brand_theme_background_image + +- Operation ID: `delete_brand_theme_background_image` +- Route: `DELETE /api/v1/brands/{brandId}/themes/{themeId}/background-image` +- Mode: WRITE +- Summary: Delete the background image +- Parameters: + - `brandId` in `path` required + - `themeId` in `path` required + +### upload_brand_theme_favicon + +- Operation ID: `upload_brand_theme_favicon` +- Route: `POST /api/v1/brands/{brandId}/themes/{themeId}/favicon` +- Mode: WRITE +- Summary: Upload the favicon +- Parameters: + - `brandId` in `path` required + - `themeId` in `path` required +- Body: JSON request body accepted. + +### delete_brand_theme_favicon + +- Operation ID: `delete_brand_theme_favicon` +- Route: `DELETE /api/v1/brands/{brandId}/themes/{themeId}/favicon` +- Mode: WRITE +- Summary: Delete the favicon +- Parameters: + - `brandId` in `path` required + - `themeId` in `path` required + +### upload_brand_theme_logo + +- Operation ID: `upload_brand_theme_logo` +- Route: `POST /api/v1/brands/{brandId}/themes/{themeId}/logo` +- Mode: WRITE +- Summary: Upload the logo +- Parameters: + - `brandId` in `path` required + - `themeId` in `path` required +- Body: JSON request body accepted. + +### delete_brand_theme_logo + +- Operation ID: `delete_brand_theme_logo` +- Route: `DELETE /api/v1/brands/{brandId}/themes/{themeId}/logo` +- Mode: WRITE +- Summary: Delete the logo +- Parameters: + - `brandId` in `path` required + - `themeId` in `path` required + +### get_all_well_known_ur_is + +- Operation ID: `get_all_well_known_ur_is` +- Route: `GET /api/v1/brands/{brandId}/well-known-uris` +- Mode: READ +- Summary: Retrieve all the well-known URIs +- Parameters: + - `brandId` in `path` required + - `expand` in `query` + +### get_root_brand_well_known_uri + +- Operation ID: `get_root_brand_well_known_uri` +- Route: `GET /api/v1/brands/{brandId}/well-known-uris/{path}` +- Mode: READ +- Summary: Retrieve the well-known URI of a specific brand +- Parameters: + - `brandId` in `path` required + - `path` in `path` required + - `expand` in `query` + +### get_brand_well_known_uri + +- Operation ID: `get_brand_well_known_uri` +- Route: `GET /api/v1/brands/{brandId}/well-known-uris/{path}/customized` +- Mode: READ +- Summary: Retrieve the customized content of the specified well-known URI +- Parameters: + - `brandId` in `path` required + - `path` in `path` required + +### replace_brand_well_known_uri + +- Operation ID: `replace_brand_well_known_uri` +- Route: `PUT /api/v1/brands/{brandId}/well-known-uris/{path}/customized` +- Mode: WRITE +- Summary: Replace the customized well-known URI of the specific path +- Parameters: + - `brandId` in `path` required + - `path` in `path` required +- Body: JSON request body accepted. diff --git a/skills/captchas/SKILL.md b/skills/captchas/SKILL.md new file mode 100644 index 0000000..f1e6aa3 --- /dev/null +++ b/skills/captchas/SKILL.md @@ -0,0 +1,67 @@ +--- +name: captchas-routes +description: Handle 6 OpenAPI operation(s) under /api/v1/captchas for the captchas route group. +--- + +# captchas API Routes + +Handle 6 OpenAPI operation(s) under /api/v1/captchas for the captchas route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_captcha_instances + +- Operation ID: `list_captcha_instances` +- Route: `GET /api/v1/captchas` +- Mode: READ +- Summary: List all CAPTCHA instances + +### create_captcha_instance + +- Operation ID: `create_captcha_instance` +- Route: `POST /api/v1/captchas` +- Mode: WRITE +- Summary: Create a CAPTCHA instance +- Body: JSON request body accepted. + +### get_captcha_instance + +- Operation ID: `get_captcha_instance` +- Route: `GET /api/v1/captchas/{captchaId}` +- Mode: READ +- Summary: Retrieve a CAPTCHA instance +- Parameters: + - `captchaId` in `path` required + +### update_captcha_instance + +- Operation ID: `update_captcha_instance` +- Route: `POST /api/v1/captchas/{captchaId}` +- Mode: WRITE +- Summary: Update a CAPTCHA instance +- Parameters: + - `captchaId` in `path` required +- Body: JSON request body accepted. + +### replace_captcha_instance + +- Operation ID: `replace_captcha_instance` +- Route: `PUT /api/v1/captchas/{captchaId}` +- Mode: WRITE +- Summary: Replace a CAPTCHA instance +- Parameters: + - `captchaId` in `path` required +- Body: JSON request body accepted. + +### delete_captcha_instance + +- Operation ID: `delete_captcha_instance` +- Route: `DELETE /api/v1/captchas/{captchaId}` +- Mode: WRITE +- Summary: Delete a CAPTCHA instance +- Parameters: + - `captchaId` in `path` required diff --git a/skills/device-assurances/SKILL.md b/skills/device-assurances/SKILL.md new file mode 100644 index 0000000..e2b4071 --- /dev/null +++ b/skills/device-assurances/SKILL.md @@ -0,0 +1,57 @@ +--- +name: device-assurances-routes +description: Handle 5 OpenAPI operation(s) under /api/v1/device-assurances for the device assurances route group. +--- + +# device assurances API Routes + +Handle 5 OpenAPI operation(s) under /api/v1/device-assurances for the device assurances route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_device_assurance_policies + +- Operation ID: `list_device_assurance_policies` +- Route: `GET /api/v1/device-assurances` +- Mode: READ +- Summary: List all device assurance policies + +### create_device_assurance_policy + +- Operation ID: `create_device_assurance_policy` +- Route: `POST /api/v1/device-assurances` +- Mode: WRITE +- Summary: Create a device assurance policy +- Body: JSON request body accepted. + +### get_device_assurance_policy + +- Operation ID: `get_device_assurance_policy` +- Route: `GET /api/v1/device-assurances/{deviceAssuranceId}` +- Mode: READ +- Summary: Retrieve a device assurance policy +- Parameters: + - `deviceAssuranceId` in `path` required + +### replace_device_assurance_policy + +- Operation ID: `replace_device_assurance_policy` +- Route: `PUT /api/v1/device-assurances/{deviceAssuranceId}` +- Mode: WRITE +- Summary: Replace a device assurance policy +- Parameters: + - `deviceAssuranceId` in `path` required +- Body: JSON request body accepted. + +### delete_device_assurance_policy + +- Operation ID: `delete_device_assurance_policy` +- Route: `DELETE /api/v1/device-assurances/{deviceAssuranceId}` +- Mode: WRITE +- Summary: Delete a device assurance policy +- Parameters: + - `deviceAssuranceId` in `path` required diff --git a/skills/device-integrations/SKILL.md b/skills/device-integrations/SKILL.md new file mode 100644 index 0000000..6b9ee46 --- /dev/null +++ b/skills/device-integrations/SKILL.md @@ -0,0 +1,48 @@ +--- +name: device-integrations-routes +description: Handle 4 OpenAPI operation(s) under /api/v1/device-integrations for the device integrations route group. +--- + +# device integrations API Routes + +Handle 4 OpenAPI operation(s) under /api/v1/device-integrations for the device integrations route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_device_integrations + +- Operation ID: `list_device_integrations` +- Route: `GET /api/v1/device-integrations` +- Mode: READ +- Summary: List all device integrations + +### get_device_integration + +- Operation ID: `get_device_integration` +- Route: `GET /api/v1/device-integrations/{deviceIntegrationId}` +- Mode: READ +- Summary: Retrieve a device integration +- Parameters: + - `deviceIntegrationId` in `path` required + +### activate_device_integration + +- Operation ID: `activate_device_integration` +- Route: `POST /api/v1/device-integrations/{deviceIntegrationId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate a device integration +- Parameters: + - `deviceIntegrationId` in `path` required + +### deactivate_device_integration + +- Operation ID: `deactivate_device_integration` +- Route: `POST /api/v1/device-integrations/{deviceIntegrationId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate a device integration +- Parameters: + - `deviceIntegrationId` in `path` required diff --git a/skills/device-posture-checks/SKILL.md b/skills/device-posture-checks/SKILL.md new file mode 100644 index 0000000..d11b75f --- /dev/null +++ b/skills/device-posture-checks/SKILL.md @@ -0,0 +1,64 @@ +--- +name: device-posture-checks-routes +description: Handle 6 OpenAPI operation(s) under /api/v1/device-posture-checks for the device posture checks route group. +--- + +# device posture checks API Routes + +Handle 6 OpenAPI operation(s) under /api/v1/device-posture-checks for the device posture checks route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_device_posture_checks + +- Operation ID: `list_device_posture_checks` +- Route: `GET /api/v1/device-posture-checks` +- Mode: READ +- Summary: List all device posture checks + +### create_device_posture_check + +- Operation ID: `create_device_posture_check` +- Route: `POST /api/v1/device-posture-checks` +- Mode: WRITE +- Summary: Create a device posture check +- Body: JSON request body accepted. + +### list_default_device_posture_checks + +- Operation ID: `list_default_device_posture_checks` +- Route: `GET /api/v1/device-posture-checks/default` +- Mode: READ +- Summary: List all default device posture checks + +### get_device_posture_check + +- Operation ID: `get_device_posture_check` +- Route: `GET /api/v1/device-posture-checks/{postureCheckId}` +- Mode: READ +- Summary: Retrieve a device posture check +- Parameters: + - `postureCheckId` in `path` required + +### replace_device_posture_check + +- Operation ID: `replace_device_posture_check` +- Route: `PUT /api/v1/device-posture-checks/{postureCheckId}` +- Mode: WRITE +- Summary: Replace a device posture check +- Parameters: + - `postureCheckId` in `path` required +- Body: JSON request body accepted. + +### delete_device_posture_check + +- Operation ID: `delete_device_posture_check` +- Route: `DELETE /api/v1/device-posture-checks/{postureCheckId}` +- Mode: WRITE +- Summary: Delete a device posture check +- Parameters: + - `postureCheckId` in `path` required diff --git a/skills/devices/SKILL.md b/skills/devices/SKILL.md new file mode 100644 index 0000000..530953b --- /dev/null +++ b/skills/devices/SKILL.md @@ -0,0 +1,89 @@ +--- +name: devices-routes +description: Handle 8 OpenAPI operation(s) under /api/v1/devices for the devices route group. +--- + +# devices API Routes + +Handle 8 OpenAPI operation(s) under /api/v1/devices for the devices route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_devices + +- Operation ID: `list_devices` +- Route: `GET /api/v1/devices` +- Mode: READ +- Summary: List all devices +- Parameters: + - `after` in `query` + - `limit` in `query` + - `search` in `query` + - `expand` in `query` + +### get_device + +- Operation ID: `get_device` +- Route: `GET /api/v1/devices/{deviceId}` +- Mode: READ +- Summary: Retrieve a device +- Parameters: + - `deviceId` in `path` required + +### delete_device + +- Operation ID: `delete_device` +- Route: `DELETE /api/v1/devices/{deviceId}` +- Mode: WRITE +- Summary: Delete a device +- Parameters: + - `deviceId` in `path` required + +### activate_device + +- Operation ID: `activate_device` +- Route: `POST /api/v1/devices/{deviceId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate a device +- Parameters: + - `deviceId` in `path` required + +### deactivate_device + +- Operation ID: `deactivate_device` +- Route: `POST /api/v1/devices/{deviceId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate a device +- Parameters: + - `deviceId` in `path` required + +### suspend_device + +- Operation ID: `suspend_device` +- Route: `POST /api/v1/devices/{deviceId}/lifecycle/suspend` +- Mode: WRITE +- Summary: Suspend a Device +- Parameters: + - `deviceId` in `path` required + +### unsuspend_device + +- Operation ID: `unsuspend_device` +- Route: `POST /api/v1/devices/{deviceId}/lifecycle/unsuspend` +- Mode: WRITE +- Summary: Unsuspend a Device +- Parameters: + - `deviceId` in `path` required + +### list_device_users + +- Operation ID: `list_device_users` +- Route: `GET /api/v1/devices/{deviceId}/users` +- Mode: READ +- Summary: List all users for a device +- Parameters: + - `deviceId` in `path` required diff --git a/skills/directories/SKILL.md b/skills/directories/SKILL.md new file mode 100644 index 0000000..1ea03b1 --- /dev/null +++ b/skills/directories/SKILL.md @@ -0,0 +1,46 @@ +--- +name: directories-routes +description: Handle 3 OpenAPI operation(s) under /api/v1/directories/{appInstanceId}/groups for the directories route group. +--- + +# directories API Routes + +Handle 3 OpenAPI operation(s) under /api/v1/directories/{appInstanceId}/groups for the directories route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### update_group_membership + +- Operation ID: `update_group_membership` +- Route: `POST /api/v1/directories/{appInstanceId}/groups/modify` +- Mode: WRITE +- Summary: Update an external directory group membership +- Parameters: + - `appInstanceId` in `path` required +- Body: JSON request body accepted. + +### submit_group_attribute_query + +- Operation ID: `submit_group_attribute_query` +- Route: `POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query` +- Mode: WRITE +- Summary: Submit a query for AD Group +- Parameters: + - `appInstanceId` in `path` required + - `groupId` in `path` required +- Body: JSON request body accepted. + +### get_group_attribute_query_result + +- Operation ID: `get_group_attribute_query_result` +- Route: `GET /api/v1/directories/{appInstanceId}/groups/{groupId}/query/{resultId}` +- Mode: READ +- Summary: Retrieve the results of an AD group query +- Parameters: + - `appInstanceId` in `path` required + - `groupId` in `path` required + - `resultId` in `path` required diff --git a/skills/domains/SKILL.md b/skills/domains/SKILL.md new file mode 100644 index 0000000..d7e8edd --- /dev/null +++ b/skills/domains/SKILL.md @@ -0,0 +1,76 @@ +--- +name: domains-routes +description: Handle 7 OpenAPI operation(s) under /api/v1/domains for the domains route group. +--- + +# domains API Routes + +Handle 7 OpenAPI operation(s) under /api/v1/domains for the domains route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_custom_domains + +- Operation ID: `list_custom_domains` +- Route: `GET /api/v1/domains` +- Mode: READ +- Summary: List all custom domains + +### create_custom_domain + +- Operation ID: `create_custom_domain` +- Route: `POST /api/v1/domains` +- Mode: WRITE +- Summary: Create a custom domain +- Body: JSON request body accepted. + +### get_custom_domain + +- Operation ID: `get_custom_domain` +- Route: `GET /api/v1/domains/{domainId}` +- Mode: READ +- Summary: Retrieve a custom domain +- Parameters: + - `domainId` in `path` required + +### replace_custom_domain + +- Operation ID: `replace_custom_domain` +- Route: `PUT /api/v1/domains/{domainId}` +- Mode: WRITE +- Summary: Replace a custom domain's brand +- Parameters: + - `domainId` in `path` required +- Body: JSON request body accepted. + +### delete_custom_domain + +- Operation ID: `delete_custom_domain` +- Route: `DELETE /api/v1/domains/{domainId}` +- Mode: WRITE +- Summary: Delete a custom domain +- Parameters: + - `domainId` in `path` required + +### upsert_certificate + +- Operation ID: `upsert_certificate` +- Route: `PUT /api/v1/domains/{domainId}/certificate` +- Mode: WRITE +- Summary: Upsert the custom domain's certificate +- Parameters: + - `domainId` in `path` required +- Body: JSON request body accepted. + +### verify_domain + +- Operation ID: `verify_domain` +- Route: `POST /api/v1/domains/{domainId}/verify` +- Mode: WRITE +- Summary: Verify a custom domain +- Parameters: + - `domainId` in `path` required diff --git a/skills/dr/SKILL.md b/skills/dr/SKILL.md new file mode 100644 index 0000000..3a4abcf --- /dev/null +++ b/skills/dr/SKILL.md @@ -0,0 +1,46 @@ +--- +name: dr-routes +description: Handle 4 OpenAPI operation(s) under /api/v1/dr for the dr route group. +--- + +# dr API Routes + +Handle 4 OpenAPI operation(s) under /api/v1/dr for the dr route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### start_org_failback + +- Operation ID: `start_org_failback` +- Route: `POST /api/v1/dr/failback` +- Mode: WRITE +- Summary: Start the failback of your org +- Body: JSON request body accepted. + +### start_org_failover + +- Operation ID: `start_org_failover` +- Route: `POST /api/v1/dr/failover` +- Mode: WRITE +- Summary: Start the failover of your org +- Body: JSON request body accepted. + +### get_dr_status + +- Operation ID: `get_dr_status` +- Route: `GET /api/v1/dr/status` +- Mode: READ +- Summary: Retrieve the disaster recovery status for all domains + +### get_dr_status_for_domain + +- Operation ID: `get_dr_status_for_domain` +- Route: `GET /api/v1/dr/status/{domain}` +- Mode: READ +- Summary: Retrieve the disaster recovery status for a domain +- Parameters: + - `domain` in `path` required diff --git a/skills/email-domains/SKILL.md b/skills/email-domains/SKILL.md new file mode 100644 index 0000000..061bda7 --- /dev/null +++ b/skills/email-domains/SKILL.md @@ -0,0 +1,73 @@ +--- +name: email-domains-routes +description: Handle 6 OpenAPI operation(s) under /api/v1/email-domains for the email domains route group. +--- + +# email domains API Routes + +Handle 6 OpenAPI operation(s) under /api/v1/email-domains for the email domains route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_email_domains + +- Operation ID: `list_email_domains` +- Route: `GET /api/v1/email-domains` +- Mode: READ +- Summary: List all email domains +- Parameters: + - `expand` in `query` + +### create_email_domain + +- Operation ID: `create_email_domain` +- Route: `POST /api/v1/email-domains` +- Mode: WRITE +- Summary: Create an email domain +- Parameters: + - `expand` in `query` +- Body: JSON request body accepted. + +### get_email_domain + +- Operation ID: `get_email_domain` +- Route: `GET /api/v1/email-domains/{emailDomainId}` +- Mode: READ +- Summary: Retrieve an email domain +- Parameters: + - `emailDomainId` in `path` required + - `expand` in `query` + +### replace_email_domain + +- Operation ID: `replace_email_domain` +- Route: `PUT /api/v1/email-domains/{emailDomainId}` +- Mode: WRITE +- Summary: Replace an email domain +- Parameters: + - `emailDomainId` in `path` required + - `expand` in `query` +- Body: JSON request body accepted. + +### delete_email_domain + +- Operation ID: `delete_email_domain` +- Route: `DELETE /api/v1/email-domains/{emailDomainId}` +- Mode: WRITE +- Summary: Delete an email domain +- Parameters: + - `emailDomainId` in `path` required + - `expand` in `query` + +### verify_email_domain + +- Operation ID: `verify_email_domain` +- Route: `POST /api/v1/email-domains/{emailDomainId}/verify` +- Mode: WRITE +- Summary: Verify an email domain +- Parameters: + - `emailDomainId` in `path` required diff --git a/skills/email-servers/SKILL.md b/skills/email-servers/SKILL.md new file mode 100644 index 0000000..04e59f9 --- /dev/null +++ b/skills/email-servers/SKILL.md @@ -0,0 +1,67 @@ +--- +name: email-servers-routes +description: Handle 6 OpenAPI operation(s) under /api/v1/email-servers for the email servers route group. +--- + +# email servers API Routes + +Handle 6 OpenAPI operation(s) under /api/v1/email-servers for the email servers route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_email_servers + +- Operation ID: `list_email_servers` +- Route: `GET /api/v1/email-servers` +- Mode: READ +- Summary: List all enrolled SMTP servers + +### create_email_server + +- Operation ID: `create_email_server` +- Route: `POST /api/v1/email-servers` +- Mode: WRITE +- Summary: Create a custom SMTP server +- Body: JSON request body accepted. + +### get_email_server + +- Operation ID: `get_email_server` +- Route: `GET /api/v1/email-servers/{emailServerId}` +- Mode: READ +- Summary: Retrieve an SMTP server configuration +- Parameters: + - `emailServerId` in `path` required + +### update_email_server + +- Operation ID: `update_email_server` +- Route: `PATCH /api/v1/email-servers/{emailServerId}` +- Mode: WRITE +- Summary: Update an SMTP server configuration +- Parameters: + - `emailServerId` in `path` required +- Body: JSON request body accepted. + +### delete_email_server + +- Operation ID: `delete_email_server` +- Route: `DELETE /api/v1/email-servers/{emailServerId}` +- Mode: WRITE +- Summary: Delete an SMTP server configuration +- Parameters: + - `emailServerId` in `path` required + +### test_email_server + +- Operation ID: `test_email_server` +- Route: `POST /api/v1/email-servers/{emailServerId}/test` +- Mode: WRITE +- Summary: Test an SMTP server configuration +- Parameters: + - `emailServerId` in `path` required +- Body: JSON request body accepted. diff --git a/skills/event-hooks/SKILL.md b/skills/event-hooks/SKILL.md new file mode 100644 index 0000000..d627ed9 --- /dev/null +++ b/skills/event-hooks/SKILL.md @@ -0,0 +1,84 @@ +--- +name: event-hooks-routes +description: Handle 8 OpenAPI operation(s) under /api/v1/eventHooks for the eventHooks route group. +--- + +# eventHooks API Routes + +Handle 8 OpenAPI operation(s) under /api/v1/eventHooks for the eventHooks route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_event_hooks + +- Operation ID: `list_event_hooks` +- Route: `GET /api/v1/eventHooks` +- Mode: READ +- Summary: List all event hooks + +### create_event_hook + +- Operation ID: `create_event_hook` +- Route: `POST /api/v1/eventHooks` +- Mode: WRITE +- Summary: Create an event hook +- Body: JSON request body accepted. + +### get_event_hook + +- Operation ID: `get_event_hook` +- Route: `GET /api/v1/eventHooks/{eventHookId}` +- Mode: READ +- Summary: Retrieve an event hook +- Parameters: + - `eventHookId` in `path` required + +### replace_event_hook + +- Operation ID: `replace_event_hook` +- Route: `PUT /api/v1/eventHooks/{eventHookId}` +- Mode: WRITE +- Summary: Replace an event hook +- Parameters: + - `eventHookId` in `path` required +- Body: JSON request body accepted. + +### delete_event_hook + +- Operation ID: `delete_event_hook` +- Route: `DELETE /api/v1/eventHooks/{eventHookId}` +- Mode: WRITE +- Summary: Delete an event hook +- Parameters: + - `eventHookId` in `path` required + +### activate_event_hook + +- Operation ID: `activate_event_hook` +- Route: `POST /api/v1/eventHooks/{eventHookId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate an event hook +- Parameters: + - `eventHookId` in `path` required + +### deactivate_event_hook + +- Operation ID: `deactivate_event_hook` +- Route: `POST /api/v1/eventHooks/{eventHookId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate an event hook +- Parameters: + - `eventHookId` in `path` required + +### verify_event_hook + +- Operation ID: `verify_event_hook` +- Route: `POST /api/v1/eventHooks/{eventHookId}/lifecycle/verify` +- Mode: WRITE +- Summary: Verify an event hook +- Parameters: + - `eventHookId` in `path` required diff --git a/skills/features/SKILL.md b/skills/features/SKILL.md new file mode 100644 index 0000000..611302a --- /dev/null +++ b/skills/features/SKILL.md @@ -0,0 +1,59 @@ +--- +name: features-routes +description: Handle 5 OpenAPI operation(s) under /api/v1/features for the features route group. +--- + +# features API Routes + +Handle 5 OpenAPI operation(s) under /api/v1/features for the features route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_features + +- Operation ID: `list_features` +- Route: `GET /api/v1/features` +- Mode: READ +- Summary: List all features + +### get_feature + +- Operation ID: `get_feature` +- Route: `GET /api/v1/features/{featureId}` +- Mode: READ +- Summary: Retrieve a feature +- Parameters: + - `featureId` in `path` required + +### list_feature_dependencies + +- Operation ID: `list_feature_dependencies` +- Route: `GET /api/v1/features/{featureId}/dependencies` +- Mode: READ +- Summary: List all dependencies +- Parameters: + - `featureId` in `path` required + +### list_feature_dependents + +- Operation ID: `list_feature_dependents` +- Route: `GET /api/v1/features/{featureId}/dependents` +- Mode: READ +- Summary: List all dependents +- Parameters: + - `featureId` in `path` required + +### update_feature_lifecycle + +- Operation ID: `update_feature_lifecycle` +- Route: `POST /api/v1/features/{featureId}/{lifecycle}` +- Mode: WRITE +- Summary: Update a feature lifecycle +- Parameters: + - `featureId` in `path` required + - `lifecycle` in `path` required + - `mode` in `query` diff --git a/skills/first-party-app-settings/SKILL.md b/skills/first-party-app-settings/SKILL.md new file mode 100644 index 0000000..2598be0 --- /dev/null +++ b/skills/first-party-app-settings/SKILL.md @@ -0,0 +1,33 @@ +--- +name: first-party-app-settings-routes +description: Handle 2 OpenAPI operation(s) under /api/v1/first-party-app-settings/{appName} for the first party app settings route group. +--- + +# first party app settings API Routes + +Handle 2 OpenAPI operation(s) under /api/v1/first-party-app-settings/{appName} for the first party app settings route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### get_first_party_app_settings + +- Operation ID: `get_first_party_app_settings` +- Route: `GET /api/v1/first-party-app-settings/{appName}` +- Mode: READ +- Summary: Retrieve the Okta application settings +- Parameters: + - `appName` in `path` required + +### replace_first_party_app_settings + +- Operation ID: `replace_first_party_app_settings` +- Route: `PUT /api/v1/first-party-app-settings/{appName}` +- Mode: WRITE +- Summary: Replace the Okta application settings +- Parameters: + - `appName` in `path` required +- Body: JSON request body accepted. diff --git a/skills/groups/SKILL.md b/skills/groups/SKILL.md new file mode 100644 index 0000000..310799f --- /dev/null +++ b/skills/groups/SKILL.md @@ -0,0 +1,341 @@ +--- +name: groups-routes +description: Handle 31 OpenAPI operation(s) under /api/v1/groups for the groups route group. +--- + +# groups API Routes + +Handle 31 OpenAPI operation(s) under /api/v1/groups for the groups route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_groups + +- Operation ID: `list_groups` +- Route: `GET /api/v1/groups` +- Mode: READ +- Summary: List all groups +- Parameters: + - `search` in `query` + - `filter` in `query` + - `q` in `query` + - `after` in `query` + - `limit` in `query` + - `expand` in `query` + - `sortBy` in `query` + - `sortOrder` in `query` + +### add_group + +- Operation ID: `add_group` +- Route: `POST /api/v1/groups` +- Mode: WRITE +- Summary: Add a group +- Body: JSON request body accepted. + +### list_group_rules + +- Operation ID: `list_group_rules` +- Route: `GET /api/v1/groups/rules` +- Mode: READ +- Summary: List all group rules +- Parameters: + - `limit` in `query` + - `after` in `query` + - `search` in `query` + - `expand` in `query` + +### create_group_rule + +- Operation ID: `create_group_rule` +- Route: `POST /api/v1/groups/rules` +- Mode: WRITE +- Summary: Create a group rule +- Body: JSON request body accepted. + +### get_group_rule + +- Operation ID: `get_group_rule` +- Route: `GET /api/v1/groups/rules/{groupRuleId}` +- Mode: READ +- Summary: Retrieve a group rule +- Parameters: + - `groupRuleId` in `path` required + - `expand` in `query` + +### replace_group_rule + +- Operation ID: `replace_group_rule` +- Route: `PUT /api/v1/groups/rules/{groupRuleId}` +- Mode: WRITE +- Summary: Replace a group rule +- Parameters: + - `groupRuleId` in `path` required +- Body: JSON request body accepted. + +### delete_group_rule + +- Operation ID: `delete_group_rule` +- Route: `DELETE /api/v1/groups/rules/{groupRuleId}` +- Mode: WRITE +- Summary: Delete a group rule +- Parameters: + - `groupRuleId` in `path` required + - `removeUsers` in `query` + +### activate_group_rule + +- Operation ID: `activate_group_rule` +- Route: `POST /api/v1/groups/rules/{groupRuleId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate a group rule +- Parameters: + - `groupRuleId` in `path` required + +### deactivate_group_rule + +- Operation ID: `deactivate_group_rule` +- Route: `POST /api/v1/groups/rules/{groupRuleId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate a group rule +- Parameters: + - `groupRuleId` in `path` required + +### get_group + +- Operation ID: `get_group` +- Route: `GET /api/v1/groups/{groupId}` +- Mode: READ +- Summary: Retrieve a group +- Parameters: + - `groupId` in `path` required + +### replace_group + +- Operation ID: `replace_group` +- Route: `PUT /api/v1/groups/{groupId}` +- Mode: WRITE +- Summary: Replace a group +- Parameters: + - `groupId` in `path` required +- Body: JSON request body accepted. + +### delete_group + +- Operation ID: `delete_group` +- Route: `DELETE /api/v1/groups/{groupId}` +- Mode: WRITE +- Summary: Delete a group +- Parameters: + - `groupId` in `path` required + +### list_assigned_applications_for_group + +- Operation ID: `list_assigned_applications_for_group` +- Route: `GET /api/v1/groups/{groupId}/apps` +- Mode: READ +- Summary: List all assigned apps +- Parameters: + - `groupId` in `path` required + - `after` in `query` + - `limit` in `query` + +### list_group_owners + +- Operation ID: `list_group_owners` +- Route: `GET /api/v1/groups/{groupId}/owners` +- Mode: READ +- Summary: List all group owners +- Parameters: + - `groupId` in `path` required + - `search` in `query` + - `after` in `query` + - `limit` in `query` + +### assign_group_owner + +- Operation ID: `assign_group_owner` +- Route: `POST /api/v1/groups/{groupId}/owners` +- Mode: WRITE +- Summary: Assign a group owner +- Parameters: + - `groupId` in `path` required +- Body: JSON request body accepted. + +### delete_group_owner + +- Operation ID: `delete_group_owner` +- Route: `DELETE /api/v1/groups/{groupId}/owners/{ownerId}` +- Mode: WRITE +- Summary: Delete a group owner +- Parameters: + - `groupId` in `path` required + - `ownerId` in `path` required + +### list_group_assigned_roles + +- Operation ID: `list_group_assigned_roles` +- Route: `GET /api/v1/groups/{groupId}/roles` +- Mode: READ +- Summary: List all group role assignments +- Parameters: + - `groupId` in `path` required + - `expand` in `query` + +### assign_role_to_group + +- Operation ID: `assign_role_to_group` +- Route: `POST /api/v1/groups/{groupId}/roles` +- Mode: WRITE +- Summary: Assign a role to a group +- Parameters: + - `groupId` in `path` required + - `disableNotifications` in `query` +- Body: JSON request body accepted. + +### get_group_assigned_role + +- Operation ID: `get_group_assigned_role` +- Route: `GET /api/v1/groups/{groupId}/roles/{roleAssignmentId}` +- Mode: READ +- Summary: Retrieve a group role assignment +- Parameters: + - `groupId` in `path` required + - `roleAssignmentId` in `path` required + +### unassign_role_from_group + +- Operation ID: `unassign_role_from_group` +- Route: `DELETE /api/v1/groups/{groupId}/roles/{roleAssignmentId}` +- Mode: WRITE +- Summary: Unassign a group role +- Parameters: + - `groupId` in `path` required + - `roleAssignmentId` in `path` required + +### list_application_targets_for_application_administrator_role_for_group + +- Operation ID: `list_application_targets_for_application_administrator_role_for_group` +- Route: `GET /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps` +- Mode: READ +- Summary: List all group role app targets +- Parameters: + - `groupId` in `path` required + - `roleAssignmentId` in `path` required + - `after` in `query` + - `limit` in `query` + +### assign_app_target_to_admin_role_for_group + +- Operation ID: `assign_app_target_to_admin_role_for_group` +- Route: `PUT /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}` +- Mode: WRITE +- Summary: Assign a group role app target +- Parameters: + - `groupId` in `path` required + - `roleAssignmentId` in `path` required + - `appName` in `path` required + +### unassign_app_target_to_admin_role_for_group + +- Operation ID: `unassign_app_target_to_admin_role_for_group` +- Route: `DELETE /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}` +- Mode: WRITE +- Summary: Unassign a group role app target +- Parameters: + - `groupId` in `path` required + - `roleAssignmentId` in `path` required + - `appName` in `path` required + +### assign_app_instance_target_to_app_admin_role_for_group + +- Operation ID: `assign_app_instance_target_to_app_admin_role_for_group` +- Route: `PUT /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}` +- Mode: WRITE +- Summary: Assign a group role app instance target +- Parameters: + - `groupId` in `path` required + - `roleAssignmentId` in `path` required + - `appName` in `path` required + - `appId` in `path` required + +### unassign_app_instance_target_to_app_admin_role_for_group + +- Operation ID: `unassign_app_instance_target_to_app_admin_role_for_group` +- Route: `DELETE /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/catalog/apps/{appName}/{appId}` +- Mode: WRITE +- Summary: Unassign a group role app instance target +- Parameters: + - `groupId` in `path` required + - `roleAssignmentId` in `path` required + - `appName` in `path` required + - `appId` in `path` required + +### list_group_targets_for_group_role + +- Operation ID: `list_group_targets_for_group_role` +- Route: `GET /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups` +- Mode: READ +- Summary: List all group role group targets +- Parameters: + - `groupId` in `path` required + - `roleAssignmentId` in `path` required + - `after` in `query` + - `limit` in `query` + +### assign_group_target_to_group_admin_role + +- Operation ID: `assign_group_target_to_group_admin_role` +- Route: `PUT /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups/{targetGroupId}` +- Mode: WRITE +- Summary: Assign a group role group target +- Parameters: + - `groupId` in `path` required + - `roleAssignmentId` in `path` required + - `targetGroupId` in `path` required + +### unassign_group_target_from_group_admin_role + +- Operation ID: `unassign_group_target_from_group_admin_role` +- Route: `DELETE /api/v1/groups/{groupId}/roles/{roleAssignmentId}/targets/groups/{targetGroupId}` +- Mode: WRITE +- Summary: Unassign a group role group target +- Parameters: + - `groupId` in `path` required + - `roleAssignmentId` in `path` required + - `targetGroupId` in `path` required + +### list_group_users + +- Operation ID: `list_group_users` +- Route: `GET /api/v1/groups/{groupId}/users` +- Mode: READ +- Summary: List all member users +- Parameters: + - `groupId` in `path` required + - `after` in `query` + - `limit` in `query` + +### assign_user_to_group + +- Operation ID: `assign_user_to_group` +- Route: `PUT /api/v1/groups/{groupId}/users/{userId}` +- Mode: WRITE +- Summary: Assign a user to a group +- Parameters: + - `groupId` in `path` required + - `userId` in `path` required + +### unassign_user_from_group + +- Operation ID: `unassign_user_from_group` +- Route: `DELETE /api/v1/groups/{groupId}/users/{userId}` +- Mode: WRITE +- Summary: Unassign a user from a group +- Parameters: + - `groupId` in `path` required + - `userId` in `path` required diff --git a/skills/hook-keys/SKILL.md b/skills/hook-keys/SKILL.md new file mode 100644 index 0000000..a090377 --- /dev/null +++ b/skills/hook-keys/SKILL.md @@ -0,0 +1,66 @@ +--- +name: hook-keys-routes +description: Handle 6 OpenAPI operation(s) under /api/v1/hook-keys for the hook keys route group. +--- + +# hook keys API Routes + +Handle 6 OpenAPI operation(s) under /api/v1/hook-keys for the hook keys route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_hook_keys + +- Operation ID: `list_hook_keys` +- Route: `GET /api/v1/hook-keys` +- Mode: READ +- Summary: List all keys + +### create_hook_key + +- Operation ID: `create_hook_key` +- Route: `POST /api/v1/hook-keys` +- Mode: WRITE +- Summary: Create a key +- Body: JSON request body accepted. + +### get_public_key + +- Operation ID: `get_public_key` +- Route: `GET /api/v1/hook-keys/public/{keyId}` +- Mode: READ +- Summary: Retrieve a public key +- Parameters: + - `keyId` in `path` required + +### get_hook_key + +- Operation ID: `get_hook_key` +- Route: `GET /api/v1/hook-keys/{id}` +- Mode: READ +- Summary: Retrieve a key by ID +- Parameters: + - `id` in `path` required + +### replace_hook_key + +- Operation ID: `replace_hook_key` +- Route: `PUT /api/v1/hook-keys/{id}` +- Mode: WRITE +- Summary: Replace a key +- Parameters: + - `id` in `path` required +- Body: JSON request body accepted. + +### delete_hook_key + +- Operation ID: `delete_hook_key` +- Route: `DELETE /api/v1/hook-keys/{id}` +- Mode: WRITE +- Summary: Delete a key +- Parameters: + - `id` in `path` required diff --git a/skills/iam/SKILL.md b/skills/iam/SKILL.md new file mode 100644 index 0000000..69dda15 --- /dev/null +++ b/skills/iam/SKILL.md @@ -0,0 +1,401 @@ +--- +name: iam-routes +description: Handle 40 OpenAPI operation(s) under /api/v1/iam for the iam route group. +--- + +# iam API Routes + +Handle 40 OpenAPI operation(s) under /api/v1/iam for the iam route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_users_with_role_assignments + +- Operation ID: `list_users_with_role_assignments` +- Route: `GET /api/v1/iam/assignees/users` +- Mode: READ +- Summary: List all users with role assignments +- Parameters: + - `after` in `query` + - `limit` in `query` + +### list_governance_bundles + +- Operation ID: `list_governance_bundles` +- Route: `GET /api/v1/iam/governance/bundles` +- Mode: READ +- Summary: List all governance bundles +- Parameters: + - `after` in `query` + - `limit` in `query` + +### create_governance_bundle + +- Operation ID: `create_governance_bundle` +- Route: `POST /api/v1/iam/governance/bundles` +- Mode: WRITE +- Summary: Create a governance bundle +- Body: JSON request body accepted. + +### get_governance_bundle + +- Operation ID: `get_governance_bundle` +- Route: `GET /api/v1/iam/governance/bundles/{bundleId}` +- Mode: READ +- Summary: Retrieve a governance bundle +- Parameters: + - `bundleId` in `path` required + +### replace_governance_bundle + +- Operation ID: `replace_governance_bundle` +- Route: `PUT /api/v1/iam/governance/bundles/{bundleId}` +- Mode: WRITE +- Summary: Replace a governance bundle +- Parameters: + - `bundleId` in `path` required +- Body: JSON request body accepted. + +### delete_governance_bundle + +- Operation ID: `delete_governance_bundle` +- Route: `DELETE /api/v1/iam/governance/bundles/{bundleId}` +- Mode: WRITE +- Summary: Delete a governance bundle +- Parameters: + - `bundleId` in `path` required + +### list_bundle_entitlements + +- Operation ID: `list_bundle_entitlements` +- Route: `GET /api/v1/iam/governance/bundles/{bundleId}/entitlements` +- Mode: READ +- Summary: List all entitlements for a governance bundle +- Parameters: + - `bundleId` in `path` required + - `after` in `query` + - `limit` in `query` + +### list_bundle_entitlement_values + +- Operation ID: `list_bundle_entitlement_values` +- Route: `GET /api/v1/iam/governance/bundles/{bundleId}/entitlements/{entitlementId}/values` +- Mode: READ +- Summary: List all values for a governance bundle entitlement +- Parameters: + - `bundleId` in `path` required + - `entitlementId` in `path` required + - `after` in `query` + - `limit` in `query` + +### get_opt_in_status + +- Operation ID: `get_opt_in_status` +- Route: `GET /api/v1/iam/governance/optIn` +- Mode: READ +- Summary: Retrieve the Admin Console opt-in status + +### opt_in + +- Operation ID: `opt_in` +- Route: `POST /api/v1/iam/governance/optIn` +- Mode: WRITE +- Summary: Opt in the Admin Console to entitlement management + +### opt_out + +- Operation ID: `opt_out` +- Route: `POST /api/v1/iam/governance/optOut` +- Mode: WRITE +- Summary: Opt out the Admin Console from entitlement management + +### list_resource_sets + +- Operation ID: `list_resource_sets` +- Route: `GET /api/v1/iam/resource-sets` +- Mode: READ +- Summary: List all resource sets +- Parameters: + - `after` in `query` + +### create_resource_set + +- Operation ID: `create_resource_set` +- Route: `POST /api/v1/iam/resource-sets` +- Mode: WRITE +- Summary: Create a resource set +- Body: JSON request body accepted. + +### get_resource_set + +- Operation ID: `get_resource_set` +- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}` +- Mode: READ +- Summary: Retrieve a resource set +- Parameters: + - `resourceSetIdOrLabel` in `path` required + +### replace_resource_set + +- Operation ID: `replace_resource_set` +- Route: `PUT /api/v1/iam/resource-sets/{resourceSetIdOrLabel}` +- Mode: WRITE +- Summary: Replace a resource set +- Parameters: + - `resourceSetIdOrLabel` in `path` required +- Body: JSON request body accepted. + +### delete_resource_set + +- Operation ID: `delete_resource_set` +- Route: `DELETE /api/v1/iam/resource-sets/{resourceSetIdOrLabel}` +- Mode: WRITE +- Summary: Delete a resource set +- Parameters: + - `resourceSetIdOrLabel` in `path` required + +### list_bindings + +- Operation ID: `list_bindings` +- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings` +- Mode: READ +- Summary: List all role resource set bindings +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `after` in `query` + +### create_resource_set_binding + +- Operation ID: `create_resource_set_binding` +- Route: `POST /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings` +- Mode: WRITE +- Summary: Create a role resource set binding +- Parameters: + - `resourceSetIdOrLabel` in `path` required +- Body: JSON request body accepted. + +### get_binding + +- Operation ID: `get_binding` +- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}` +- Mode: READ +- Summary: Retrieve a role resource set binding +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `roleIdOrLabel` in `path` required + +### delete_binding + +- Operation ID: `delete_binding` +- Route: `DELETE /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}` +- Mode: WRITE +- Summary: Delete a role resource set binding +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `roleIdOrLabel` in `path` required + +### list_members_of_binding + +- Operation ID: `list_members_of_binding` +- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members` +- Mode: READ +- Summary: List all role resource set binding members +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `roleIdOrLabel` in `path` required + - `after` in `query` + +### add_members_to_binding + +- Operation ID: `add_members_to_binding` +- Route: `PATCH /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members` +- Mode: WRITE +- Summary: Add more role resource set binding members +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `roleIdOrLabel` in `path` required +- Body: JSON request body accepted. + +### get_member_of_binding + +- Operation ID: `get_member_of_binding` +- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members/{memberId}` +- Mode: READ +- Summary: Retrieve a role resource set binding member +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `roleIdOrLabel` in `path` required + - `memberId` in `path` required + +### unassign_member_from_binding + +- Operation ID: `unassign_member_from_binding` +- Route: `DELETE /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/bindings/{roleIdOrLabel}/members/{memberId}` +- Mode: WRITE +- Summary: Unassign a role resource set binding member +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `roleIdOrLabel` in `path` required + - `memberId` in `path` required + +### list_resource_set_resources + +- Operation ID: `list_resource_set_resources` +- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources` +- Mode: READ +- Summary: List all resource set resources +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `after` in `query` + - `limit` in `query` + +### add_resource_set_resource + +- Operation ID: `add_resource_set_resource` +- Route: `POST /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources` +- Mode: WRITE +- Summary: Add a resource set resource with conditions +- Parameters: + - `resourceSetIdOrLabel` in `path` required +- Body: JSON request body accepted. + +### add_resource_set_resources + +- Operation ID: `add_resource_set_resources` +- Route: `PATCH /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources` +- Mode: WRITE +- Summary: Add more resources to a resource set +- Parameters: + - `resourceSetIdOrLabel` in `path` required +- Body: JSON request body accepted. + +### get_resource_set_resource + +- Operation ID: `get_resource_set_resource` +- Route: `GET /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}` +- Mode: READ +- Summary: Retrieve a resource set resource +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `resourceId` in `path` required + +### replace_resource_set_resource + +- Operation ID: `replace_resource_set_resource` +- Route: `PUT /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}` +- Mode: WRITE +- Summary: Replace the resource set resource conditions +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `resourceId` in `path` required +- Body: JSON request body accepted. + +### delete_resource_set_resource + +- Operation ID: `delete_resource_set_resource` +- Route: `DELETE /api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}` +- Mode: WRITE +- Summary: Delete a resource set resource +- Parameters: + - `resourceSetIdOrLabel` in `path` required + - `resourceId` in `path` required + +### list_roles + +- Operation ID: `list_roles` +- Route: `GET /api/v1/iam/roles` +- Mode: READ +- Summary: List all custom roles +- Parameters: + - `after` in `query` + +### create_role + +- Operation ID: `create_role` +- Route: `POST /api/v1/iam/roles` +- Mode: WRITE +- Summary: Create a custom role +- Body: JSON request body accepted. + +### get_role + +- Operation ID: `get_role` +- Route: `GET /api/v1/iam/roles/{roleIdOrLabel}` +- Mode: READ +- Summary: Retrieve a role +- Parameters: + - `roleIdOrLabel` in `path` required + +### replace_role + +- Operation ID: `replace_role` +- Route: `PUT /api/v1/iam/roles/{roleIdOrLabel}` +- Mode: WRITE +- Summary: Replace a custom role +- Parameters: + - `roleIdOrLabel` in `path` required +- Body: JSON request body accepted. + +### delete_role + +- Operation ID: `delete_role` +- Route: `DELETE /api/v1/iam/roles/{roleIdOrLabel}` +- Mode: WRITE +- Summary: Delete a custom role +- Parameters: + - `roleIdOrLabel` in `path` required + +### list_role_permissions + +- Operation ID: `list_role_permissions` +- Route: `GET /api/v1/iam/roles/{roleIdOrLabel}/permissions` +- Mode: READ +- Summary: List all custom role permissions +- Parameters: + - `roleIdOrLabel` in `path` required + +### get_role_permission + +- Operation ID: `get_role_permission` +- Route: `GET /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}` +- Mode: READ +- Summary: Retrieve a custom role permission +- Parameters: + - `roleIdOrLabel` in `path` required + - `permissionType` in `path` required + +### create_role_permission + +- Operation ID: `create_role_permission` +- Route: `POST /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}` +- Mode: WRITE +- Summary: Create a custom role permission +- Parameters: + - `roleIdOrLabel` in `path` required + - `permissionType` in `path` required +- Body: JSON request body accepted. + +### replace_role_permission + +- Operation ID: `replace_role_permission` +- Route: `PUT /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}` +- Mode: WRITE +- Summary: Replace a custom role permission +- Parameters: + - `roleIdOrLabel` in `path` required + - `permissionType` in `path` required +- Body: JSON request body accepted. + +### delete_role_permission + +- Operation ID: `delete_role_permission` +- Route: `DELETE /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}` +- Mode: WRITE +- Summary: Delete a custom role permission +- Parameters: + - `roleIdOrLabel` in `path` required + - `permissionType` in `path` required diff --git a/skills/identity-sources/SKILL.md b/skills/identity-sources/SKILL.md new file mode 100644 index 0000000..dd218b1 --- /dev/null +++ b/skills/identity-sources/SKILL.md @@ -0,0 +1,255 @@ +--- +name: identity-sources-routes +description: Handle 23 OpenAPI operation(s) under /api/v1/identity-sources/{identitySourceId} for the identity sources route group. +--- + +# identity sources API Routes + +Handle 23 OpenAPI operation(s) under /api/v1/identity-sources/{identitySourceId} for the identity sources route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### create_identity_source_groups + +- Operation ID: `create_identity_source_groups` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/groups` +- Mode: WRITE +- Summary: Create an identity source group +- Parameters: + - `identitySourceId` in `path` required +- Body: JSON request body accepted. + +### get_identity_source_group + +- Operation ID: `get_identity_source_group` +- Route: `GET /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}` +- Mode: READ +- Summary: Retrieve an identity source group +- Parameters: + - `identitySourceId` in `path` required + - `groupOrExternalId` in `path` required + +### update_identity_source_groups + +- Operation ID: `update_identity_source_groups` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}` +- Mode: WRITE +- Summary: Update an identity source group +- Parameters: + - `identitySourceId` in `path` required + - `groupOrExternalId` in `path` required +- Body: JSON request body accepted. + +### delete_identity_source_group + +- Operation ID: `delete_identity_source_group` +- Route: `DELETE /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}` +- Mode: WRITE +- Summary: Delete an identity source group +- Parameters: + - `identitySourceId` in `path` required + - `groupOrExternalId` in `path` required + +### get_identity_source_group_memberships + +- Operation ID: `get_identity_source_group_memberships` +- Route: `GET /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership` +- Mode: READ +- Summary: Retrieve the memberships for the given identity source group +- Parameters: + - `identitySourceId` in `path` required + - `groupOrExternalId` in `path` required + - `after` in `query` + - `limit` in `query` + +### create_identity_source_groups_memberships + +- Operation ID: `create_identity_source_groups_memberships` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership` +- Mode: WRITE +- Summary: Create the memberships for the given identity source group +- Parameters: + - `identitySourceId` in `path` required + - `groupOrExternalId` in `path` required +- Body: JSON request body accepted. + +### delete_identity_source_group_memberships + +- Operation ID: `delete_identity_source_group_memberships` +- Route: `DELETE /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership/{memberExternalId}` +- Mode: WRITE +- Summary: Delete the memberships for the specified identity source group +- Parameters: + - `identitySourceId` in `path` required + - `groupOrExternalId` in `path` required + - `memberExternalId` in `path` required + +### list_identity_source_sessions + +- Operation ID: `list_identity_source_sessions` +- Route: `GET /api/v1/identity-sources/{identitySourceId}/sessions` +- Mode: READ +- Summary: List all identity source sessions +- Parameters: + - `identitySourceId` in `path` required + +### create_identity_source_session + +- Operation ID: `create_identity_source_session` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions` +- Mode: WRITE +- Summary: Create an identity source session +- Parameters: + - `identitySourceId` in `path` required + +### get_identity_source_session + +- Operation ID: `get_identity_source_session` +- Route: `GET /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}` +- Mode: READ +- Summary: Retrieve an identity source session +- Parameters: + - `identitySourceId` in `path` required + - `sessionId` in `path` required + +### delete_identity_source_session + +- Operation ID: `delete_identity_source_session` +- Route: `DELETE /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}` +- Mode: WRITE +- Summary: Delete an identity source session +- Parameters: + - `identitySourceId` in `path` required + - `sessionId` in `path` required + +### upload_identity_source_data_for_delete + +- Operation ID: `upload_identity_source_data_for_delete` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-delete` +- Mode: WRITE +- Summary: Upload the data to be deleted in Okta +- Parameters: + - `identitySourceId` in `path` required + - `sessionId` in `path` required +- Body: JSON request body accepted. + +### upload_identity_source_group_memberships_for_delete + +- Operation ID: `upload_identity_source_group_memberships_for_delete` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-group-memberships-delete` +- Mode: WRITE +- Summary: Upload the group memberships to be deleted in Okta +- Parameters: + - `identitySourceId` in `path` required + - `sessionId` in `path` required +- Body: JSON request body accepted. + +### upload_identity_source_group_memberships_for_upsert + +- Operation ID: `upload_identity_source_group_memberships_for_upsert` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-group-memberships-upsert` +- Mode: WRITE +- Summary: Upload the group memberships to be upserted in Okta +- Parameters: + - `identitySourceId` in `path` required + - `sessionId` in `path` required +- Body: JSON request body accepted. + +### upload_identity_source_groups_data_for_delete + +- Operation ID: `upload_identity_source_groups_data_for_delete` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-groups-delete` +- Mode: WRITE +- Summary: Upload the group external IDs to be deleted in Okta +- Parameters: + - `identitySourceId` in `path` required + - `sessionId` in `path` required +- Body: JSON request body accepted. + +### upload_identity_source_groups_for_upsert + +- Operation ID: `upload_identity_source_groups_for_upsert` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-groups-upsert` +- Mode: WRITE +- Summary: Upload the group profiles without memberships to be upserted in Okta +- Parameters: + - `identitySourceId` in `path` required + - `sessionId` in `path` required +- Body: JSON request body accepted. + +### upload_identity_source_data_for_upsert + +- Operation ID: `upload_identity_source_data_for_upsert` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-upsert` +- Mode: WRITE +- Summary: Upload the data to be upserted in Okta +- Parameters: + - `identitySourceId` in `path` required + - `sessionId` in `path` required +- Body: JSON request body accepted. + +### start_import_from_identity_source + +- Operation ID: `start_import_from_identity_source` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/start-import` +- Mode: WRITE +- Summary: Start the import from the identity source +- Parameters: + - `identitySourceId` in `path` required + - `sessionId` in `path` required + +### create_identity_source_user + +- Operation ID: `create_identity_source_user` +- Route: `POST /api/v1/identity-sources/{identitySourceId}/users` +- Mode: WRITE +- Summary: Create an identity source user +- Parameters: + - `identitySourceId` in `path` required +- Body: JSON request body accepted. + +### get_identity_source_user + +- Operation ID: `get_identity_source_user` +- Route: `GET /api/v1/identity-sources/{identitySourceId}/users/{externalId}` +- Mode: READ +- Summary: Retrieve an identity source user +- Parameters: + - `identitySourceId` in `path` required + - `externalId` in `path` required + +### replace_existing_identity_source_user + +- Operation ID: `replace_existing_identity_source_user` +- Route: `PUT /api/v1/identity-sources/{identitySourceId}/users/{externalId}` +- Mode: WRITE +- Summary: Replace an existing identity source user +- Parameters: + - `identitySourceId` in `path` required + - `externalId` in `path` required +- Body: JSON request body accepted. + +### update_identity_source_users + +- Operation ID: `update_identity_source_users` +- Route: `PATCH /api/v1/identity-sources/{identitySourceId}/users/{externalId}` +- Mode: WRITE +- Summary: Update an identity source user +- Parameters: + - `identitySourceId` in `path` required + - `externalId` in `path` required +- Body: JSON request body accepted. + +### delete_identity_source_user + +- Operation ID: `delete_identity_source_user` +- Route: `DELETE /api/v1/identity-sources/{identitySourceId}/users/{externalId}` +- Mode: WRITE +- Summary: Delete an identity source user +- Parameters: + - `identitySourceId` in `path` required + - `externalId` in `path` required diff --git a/skills/idps/SKILL.md b/skills/idps/SKILL.md new file mode 100644 index 0000000..92758dc --- /dev/null +++ b/skills/idps/SKILL.md @@ -0,0 +1,279 @@ +--- +name: idps-routes +description: Handle 27 OpenAPI operation(s) under /api/v1/idps for the idps route group. +--- + +# idps API Routes + +Handle 27 OpenAPI operation(s) under /api/v1/idps for the idps route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_identity_providers + +- Operation ID: `list_identity_providers` +- Route: `GET /api/v1/idps` +- Mode: READ +- Summary: List all IdPs +- Parameters: + - `q` in `query` + - `after` in `query` + - `limit` in `query` + - `type` in `query` + +### create_identity_provider + +- Operation ID: `create_identity_provider` +- Route: `POST /api/v1/idps` +- Mode: WRITE +- Summary: Create an IdP +- Body: JSON request body accepted. + +### list_identity_provider_keys + +- Operation ID: `list_identity_provider_keys` +- Route: `GET /api/v1/idps/credentials/keys` +- Mode: READ +- Summary: List all IdP key credentials +- Parameters: + - `after` in `query` + - `limit` in `query` + +### create_identity_provider_key + +- Operation ID: `create_identity_provider_key` +- Route: `POST /api/v1/idps/credentials/keys` +- Mode: WRITE +- Summary: Create an IdP key credential +- Body: JSON request body accepted. + +### get_identity_provider_key + +- Operation ID: `get_identity_provider_key` +- Route: `GET /api/v1/idps/credentials/keys/{kid}` +- Mode: READ +- Summary: Retrieve an IdP key credential +- Parameters: + - `kid` in `path` required + +### replace_identity_provider_key + +- Operation ID: `replace_identity_provider_key` +- Route: `PUT /api/v1/idps/credentials/keys/{kid}` +- Mode: WRITE +- Summary: Replace an IdP key credential +- Parameters: + - `kid` in `path` required +- Body: JSON request body accepted. + +### delete_identity_provider_key + +- Operation ID: `delete_identity_provider_key` +- Route: `DELETE /api/v1/idps/credentials/keys/{kid}` +- Mode: WRITE +- Summary: Delete an IdP key credential +- Parameters: + - `kid` in `path` required + +### get_identity_provider + +- Operation ID: `get_identity_provider` +- Route: `GET /api/v1/idps/{idpId}` +- Mode: READ +- Summary: Retrieve an IdP +- Parameters: + - `idpId` in `path` required + +### replace_identity_provider + +- Operation ID: `replace_identity_provider` +- Route: `PUT /api/v1/idps/{idpId}` +- Mode: WRITE +- Summary: Replace an IdP +- Parameters: + - `idpId` in `path` required +- Body: JSON request body accepted. + +### delete_identity_provider + +- Operation ID: `delete_identity_provider` +- Route: `DELETE /api/v1/idps/{idpId}` +- Mode: WRITE +- Summary: Delete an IdP +- Parameters: + - `idpId` in `path` required + +### list_csrs_for_identity_provider + +- Operation ID: `list_csrs_for_identity_provider` +- Route: `GET /api/v1/idps/{idpId}/credentials/csrs` +- Mode: READ +- Summary: List all certificate signing requests +- Parameters: + - `idpId` in `path` required + +### generate_csr_for_identity_provider + +- Operation ID: `generate_csr_for_identity_provider` +- Route: `POST /api/v1/idps/{idpId}/credentials/csrs` +- Mode: WRITE +- Summary: Generate a certificate signing request +- Parameters: + - `idpId` in `path` required +- Body: JSON request body accepted. + +### get_csr_for_identity_provider + +- Operation ID: `get_csr_for_identity_provider` +- Route: `GET /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}` +- Mode: READ +- Summary: Retrieve a certificate signing request +- Parameters: + - `idpId` in `path` required + - `idpCsrId` in `path` required + +### revoke_csr_for_identity_provider + +- Operation ID: `revoke_csr_for_identity_provider` +- Route: `DELETE /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}` +- Mode: WRITE +- Summary: Revoke a certificate signing request +- Parameters: + - `idpId` in `path` required + - `idpCsrId` in `path` required + +### publish_csr_for_identity_provider + +- Operation ID: `publish_csr_for_identity_provider` +- Route: `POST /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}/lifecycle/publish` +- Mode: WRITE +- Summary: Publish a certificate signing request +- Parameters: + - `idpId` in `path` required + - `idpCsrId` in `path` required +- Body: JSON request body accepted. + +### list_identity_provider_signing_keys + +- Operation ID: `list_identity_provider_signing_keys` +- Route: `GET /api/v1/idps/{idpId}/credentials/keys` +- Mode: READ +- Summary: List all signing key credentials for IdP +- Parameters: + - `idpId` in `path` required + +### list_active_identity_provider_signing_key + +- Operation ID: `list_active_identity_provider_signing_key` +- Route: `GET /api/v1/idps/{idpId}/credentials/keys/active` +- Mode: READ +- Summary: List the active signing key credential for IdP +- Parameters: + - `idpId` in `path` required + +### generate_identity_provider_signing_key + +- Operation ID: `generate_identity_provider_signing_key` +- Route: `POST /api/v1/idps/{idpId}/credentials/keys/generate` +- Mode: WRITE +- Summary: Generate a new signing key credential for IdP +- Parameters: + - `idpId` in `path` required + - `validityYears` in `query` required + +### get_identity_provider_signing_key + +- Operation ID: `get_identity_provider_signing_key` +- Route: `GET /api/v1/idps/{idpId}/credentials/keys/{kid}` +- Mode: READ +- Summary: Retrieve a signing key credential for IdP +- Parameters: + - `idpId` in `path` required + - `kid` in `path` required + +### clone_identity_provider_key + +- Operation ID: `clone_identity_provider_key` +- Route: `POST /api/v1/idps/{idpId}/credentials/keys/{kid}/clone` +- Mode: WRITE +- Summary: Clone a signing key credential for IdP +- Parameters: + - `idpId` in `path` required + - `kid` in `path` required + - `targetIdpId` in `query` required + +### activate_identity_provider + +- Operation ID: `activate_identity_provider` +- Route: `POST /api/v1/idps/{idpId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate an IdP +- Parameters: + - `idpId` in `path` required + +### deactivate_identity_provider + +- Operation ID: `deactivate_identity_provider` +- Route: `POST /api/v1/idps/{idpId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate an IdP +- Parameters: + - `idpId` in `path` required + +### list_identity_provider_application_users + +- Operation ID: `list_identity_provider_application_users` +- Route: `GET /api/v1/idps/{idpId}/users` +- Mode: READ +- Summary: List all users for IdP +- Parameters: + - `idpId` in `path` required + - `q` in `query` + - `after` in `query` + - `limit` in `query` + - `expand` in `query` + +### get_identity_provider_application_user + +- Operation ID: `get_identity_provider_application_user` +- Route: `GET /api/v1/idps/{idpId}/users/{userId}` +- Mode: READ +- Summary: Retrieve a user for IdP +- Parameters: + - `idpId` in `path` required + - `userId` in `path` required + +### link_user_to_identity_provider + +- Operation ID: `link_user_to_identity_provider` +- Route: `POST /api/v1/idps/{idpId}/users/{userId}` +- Mode: WRITE +- Summary: Link a user to IdP +- Parameters: + - `idpId` in `path` required + - `userId` in `path` required +- Body: JSON request body accepted. + +### unlink_user_from_identity_provider + +- Operation ID: `unlink_user_from_identity_provider` +- Route: `DELETE /api/v1/idps/{idpId}/users/{userId}` +- Mode: WRITE +- Summary: Unlink a user from IdP +- Parameters: + - `idpId` in `path` required + - `userId` in `path` required + +### list_social_auth_tokens + +- Operation ID: `list_social_auth_tokens` +- Route: `GET /api/v1/idps/{idpId}/users/{userId}/credentials/tokens` +- Mode: READ +- Summary: List all tokens from OIDC IdP +- Parameters: + - `idpId` in `path` required + - `userId` in `path` required diff --git a/skills/inline-hooks/SKILL.md b/skills/inline-hooks/SKILL.md new file mode 100644 index 0000000..e2ccc82 --- /dev/null +++ b/skills/inline-hooks/SKILL.md @@ -0,0 +1,97 @@ +--- +name: inline-hooks-routes +description: Handle 9 OpenAPI operation(s) under /api/v1/inlineHooks for the inlineHooks route group. +--- + +# inlineHooks API Routes + +Handle 9 OpenAPI operation(s) under /api/v1/inlineHooks for the inlineHooks route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_inline_hooks + +- Operation ID: `list_inline_hooks` +- Route: `GET /api/v1/inlineHooks` +- Mode: READ +- Summary: List all inline hooks +- Parameters: + - `type` in `query` + +### create_inline_hook + +- Operation ID: `create_inline_hook` +- Route: `POST /api/v1/inlineHooks` +- Mode: WRITE +- Summary: Create an inline hook +- Body: JSON request body accepted. + +### get_inline_hook + +- Operation ID: `get_inline_hook` +- Route: `GET /api/v1/inlineHooks/{inlineHookId}` +- Mode: READ +- Summary: Retrieve an inline hook +- Parameters: + - `inlineHookId` in `path` required + +### update_inline_hook + +- Operation ID: `update_inline_hook` +- Route: `POST /api/v1/inlineHooks/{inlineHookId}` +- Mode: WRITE +- Summary: Update an inline hook +- Parameters: + - `inlineHookId` in `path` required +- Body: JSON request body accepted. + +### replace_inline_hook + +- Operation ID: `replace_inline_hook` +- Route: `PUT /api/v1/inlineHooks/{inlineHookId}` +- Mode: WRITE +- Summary: Replace an inline hook +- Parameters: + - `inlineHookId` in `path` required +- Body: JSON request body accepted. + +### delete_inline_hook + +- Operation ID: `delete_inline_hook` +- Route: `DELETE /api/v1/inlineHooks/{inlineHookId}` +- Mode: WRITE +- Summary: Delete an inline hook +- Parameters: + - `inlineHookId` in `path` required + +### execute_inline_hook + +- Operation ID: `execute_inline_hook` +- Route: `POST /api/v1/inlineHooks/{inlineHookId}/execute` +- Mode: WRITE +- Summary: Execute an inline hook +- Parameters: + - `inlineHookId` in `path` required +- Body: JSON request body accepted. + +### activate_inline_hook + +- Operation ID: `activate_inline_hook` +- Route: `POST /api/v1/inlineHooks/{inlineHookId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate an inline hook +- Parameters: + - `inlineHookId` in `path` required + +### deactivate_inline_hook + +- Operation ID: `deactivate_inline_hook` +- Route: `POST /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate an inline hook +- Parameters: + - `inlineHookId` in `path` required diff --git a/skills/log-streams/SKILL.md b/skills/log-streams/SKILL.md new file mode 100644 index 0000000..de3b5e4 --- /dev/null +++ b/skills/log-streams/SKILL.md @@ -0,0 +1,79 @@ +--- +name: log-streams-routes +description: Handle 7 OpenAPI operation(s) under /api/v1/logStreams for the logStreams route group. +--- + +# logStreams API Routes + +Handle 7 OpenAPI operation(s) under /api/v1/logStreams for the logStreams route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_log_streams + +- Operation ID: `list_log_streams` +- Route: `GET /api/v1/logStreams` +- Mode: READ +- Summary: List all log streams +- Parameters: + - `after` in `query` + - `limit` in `query` + - `filter` in `query` + +### create_log_stream + +- Operation ID: `create_log_stream` +- Route: `POST /api/v1/logStreams` +- Mode: WRITE +- Summary: Create a log stream +- Body: JSON request body accepted. + +### get_log_stream + +- Operation ID: `get_log_stream` +- Route: `GET /api/v1/logStreams/{logStreamId}` +- Mode: READ +- Summary: Retrieve a log stream +- Parameters: + - `logStreamId` in `path` required + +### replace_log_stream + +- Operation ID: `replace_log_stream` +- Route: `PUT /api/v1/logStreams/{logStreamId}` +- Mode: WRITE +- Summary: Replace a log stream +- Parameters: + - `logStreamId` in `path` required +- Body: JSON request body accepted. + +### delete_log_stream + +- Operation ID: `delete_log_stream` +- Route: `DELETE /api/v1/logStreams/{logStreamId}` +- Mode: WRITE +- Summary: Delete a log stream +- Parameters: + - `logStreamId` in `path` required + +### activate_log_stream + +- Operation ID: `activate_log_stream` +- Route: `POST /api/v1/logStreams/{logStreamId}/lifecycle/activate` +- Mode: WRITE +- Summary: Activate a log stream +- Parameters: + - `logStreamId` in `path` required + +### deactivate_log_stream + +- Operation ID: `deactivate_log_stream` +- Route: `POST /api/v1/logStreams/{logStreamId}/lifecycle/deactivate` +- Mode: WRITE +- Summary: Deactivate a log stream +- Parameters: + - `logStreamId` in `path` required diff --git a/skills/logs/SKILL.md b/skills/logs/SKILL.md new file mode 100644 index 0000000..3e5e8dd --- /dev/null +++ b/skills/logs/SKILL.md @@ -0,0 +1,29 @@ +--- +name: logs-routes +description: Handle 1 OpenAPI operation(s) under /api/v1/logs for the logs route group. +--- + +# logs API Routes + +Handle 1 OpenAPI operation(s) under /api/v1/logs for the logs route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_log_events + +- Operation ID: `list_log_events` +- Route: `GET /api/v1/logs` +- Mode: READ +- Summary: List all System Log events +- Parameters: + - `since` in `query` + - `until` in `query` + - `after` in `query` + - `filter` in `query` + - `q` in `query` + - `limit` in `query` + - `sortOrder` in `query` diff --git a/skills/mappings/SKILL.md b/skills/mappings/SKILL.md new file mode 100644 index 0000000..6c454c8 --- /dev/null +++ b/skills/mappings/SKILL.md @@ -0,0 +1,45 @@ +--- +name: mappings-routes +description: Handle 3 OpenAPI operation(s) under /api/v1/mappings for the mappings route group. +--- + +# mappings API Routes + +Handle 3 OpenAPI operation(s) under /api/v1/mappings for the mappings route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_profile_mappings + +- Operation ID: `list_profile_mappings` +- Route: `GET /api/v1/mappings` +- Mode: READ +- Summary: List all profile mappings +- Parameters: + - `after` in `query` + - `limit` in `query` + - `sourceId` in `query` + - `targetId` in `query` + +### get_profile_mapping + +- Operation ID: `get_profile_mapping` +- Route: `GET /api/v1/mappings/{mappingId}` +- Mode: READ +- Summary: Retrieve a profile mapping +- Parameters: + - `mappingId` in `path` required + +### update_profile_mapping + +- Operation ID: `update_profile_mapping` +- Route: `POST /api/v1/mappings/{mappingId}` +- Mode: WRITE +- Summary: Update a profile mapping +- Parameters: + - `mappingId` in `path` required +- Body: JSON request body accepted. diff --git a/skills/meta/SKILL.md b/skills/meta/SKILL.md new file mode 100644 index 0000000..3a988ad --- /dev/null +++ b/skills/meta/SKILL.md @@ -0,0 +1,212 @@ +--- +name: meta-routes +description: Handle 23 OpenAPI operation(s) under /api/v1/meta for the meta route group. +--- + +# meta API Routes + +Handle 23 OpenAPI operation(s) under /api/v1/meta for the meta route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### get_application_user_schema + +- Operation ID: `get_application_user_schema` +- Route: `GET /api/v1/meta/schemas/apps/{appId}/default` +- Mode: READ +- Summary: Retrieve the default app user schema for an app +- Parameters: + - `appId` in `path` required + +### update_application_user_profile + +- Operation ID: `update_application_user_profile` +- Route: `POST /api/v1/meta/schemas/apps/{appId}/default` +- Mode: WRITE +- Summary: Update the app user profile schema for an app +- Parameters: + - `appId` in `path` required +- Body: JSON request body accepted. + +### get_group_schema + +- Operation ID: `get_group_schema` +- Route: `GET /api/v1/meta/schemas/group/default` +- Mode: READ +- Summary: Retrieve the default group schema + +### update_group_schema + +- Operation ID: `update_group_schema` +- Route: `POST /api/v1/meta/schemas/group/default` +- Mode: WRITE +- Summary: Update the group profile schema +- Body: JSON request body accepted. + +### list_log_stream_schemas + +- Operation ID: `list_log_stream_schemas` +- Route: `GET /api/v1/meta/schemas/logStream` +- Mode: READ +- Summary: List the log stream schemas + +### get_log_stream_schema + +- Operation ID: `get_log_stream_schema` +- Route: `GET /api/v1/meta/schemas/logStream/{logStreamType}` +- Mode: READ +- Summary: Retrieve the log stream schema for the schema type +- Parameters: + - `logStreamType` in `path` required + +### list_linked_object_definitions + +- Operation ID: `list_linked_object_definitions` +- Route: `GET /api/v1/meta/schemas/user/linkedObjects` +- Mode: READ +- Summary: List all linked object definitions + +### create_linked_object_definition + +- Operation ID: `create_linked_object_definition` +- Route: `POST /api/v1/meta/schemas/user/linkedObjects` +- Mode: WRITE +- Summary: Create a linked object definition +- Body: JSON request body accepted. + +### get_linked_object_definition + +- Operation ID: `get_linked_object_definition` +- Route: `GET /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}` +- Mode: READ +- Summary: Retrieve a linked object definition +- Parameters: + - `linkedObjectName` in `path` required + +### delete_linked_object_definition + +- Operation ID: `delete_linked_object_definition` +- Route: `DELETE /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}` +- Mode: WRITE +- Summary: Delete a linked object definition +- Parameters: + - `linkedObjectName` in `path` required + +### get_user_schema + +- Operation ID: `get_user_schema` +- Route: `GET /api/v1/meta/schemas/user/{schemaId}` +- Mode: READ +- Summary: Retrieve a user schema +- Parameters: + - `schemaId` in `path` required + +### update_user_profile + +- Operation ID: `update_user_profile` +- Route: `POST /api/v1/meta/schemas/user/{schemaId}` +- Mode: WRITE +- Summary: Update a user schema +- Parameters: + - `schemaId` in `path` required +- Body: JSON request body accepted. + +### list_user_types + +- Operation ID: `list_user_types` +- Route: `GET /api/v1/meta/types/user` +- Mode: READ +- Summary: List all user types + +### create_user_type + +- Operation ID: `create_user_type` +- Route: `POST /api/v1/meta/types/user` +- Mode: WRITE +- Summary: Create a user type +- Body: JSON request body accepted. + +### get_user_type + +- Operation ID: `get_user_type` +- Route: `GET /api/v1/meta/types/user/{typeId}` +- Mode: READ +- Summary: Retrieve a user type +- Parameters: + - `typeId` in `path` required + +### update_user_type + +- Operation ID: `update_user_type` +- Route: `POST /api/v1/meta/types/user/{typeId}` +- Mode: WRITE +- Summary: Update a user type +- Parameters: + - `typeId` in `path` required +- Body: JSON request body accepted. + +### replace_user_type + +- Operation ID: `replace_user_type` +- Route: `PUT /api/v1/meta/types/user/{typeId}` +- Mode: WRITE +- Summary: Replace a user type +- Parameters: + - `typeId` in `path` required +- Body: JSON request body accepted. + +### delete_user_type + +- Operation ID: `delete_user_type` +- Route: `DELETE /api/v1/meta/types/user/{typeId}` +- Mode: WRITE +- Summary: Delete a user type +- Parameters: + - `typeId` in `path` required + +### list_ui_schemas + +- Operation ID: `list_ui_schemas` +- Route: `GET /api/v1/meta/uischemas` +- Mode: READ +- Summary: List all UI schemas + +### create_ui_schema + +- Operation ID: `create_ui_schema` +- Route: `POST /api/v1/meta/uischemas` +- Mode: WRITE +- Summary: Create a UI schema +- Body: JSON request body accepted. + +### get_ui_schema + +- Operation ID: `get_ui_schema` +- Route: `GET /api/v1/meta/uischemas/{id}` +- Mode: READ +- Summary: Retrieve a UI schema +- Parameters: + - `id` in `path` required + +### replace_ui_schemas + +- Operation ID: `replace_ui_schemas` +- Route: `PUT /api/v1/meta/uischemas/{id}` +- Mode: WRITE +- Summary: Replace a UI schema +- Parameters: + - `id` in `path` required +- Body: JSON request body accepted. + +### delete_ui_schemas + +- Operation ID: `delete_ui_schemas` +- Route: `DELETE /api/v1/meta/uischemas/{id}` +- Mode: WRITE +- Summary: Delete a UI schema +- Parameters: + - `id` in `path` required diff --git a/skills/org/SKILL.md b/skills/org/SKILL.md new file mode 100644 index 0000000..00eeb07 --- /dev/null +++ b/skills/org/SKILL.md @@ -0,0 +1,265 @@ +--- +name: org-routes +description: Handle 31 OpenAPI operation(s) under /api/v1/org for the org route group. +--- + +# org API Routes + +Handle 31 OpenAPI operation(s) under /api/v1/org for the org route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### get_org_settings + +- Operation ID: `get_org_settings` +- Route: `GET /api/v1/org` +- Mode: READ +- Summary: Retrieve the Org general settings + +### update_org_settings + +- Operation ID: `update_org_settings` +- Route: `POST /api/v1/org` +- Mode: WRITE +- Summary: Update the Org general settings +- Body: JSON request body accepted. + +### replace_org_settings + +- Operation ID: `replace_org_settings` +- Route: `PUT /api/v1/org` +- Mode: WRITE +- Summary: Replace the Org general settings +- Body: JSON request body accepted. + +### get_org_captcha_settings + +- Operation ID: `get_org_captcha_settings` +- Route: `GET /api/v1/org/captcha` +- Mode: READ +- Summary: Retrieve the org-wide CAPTCHA settings + +### replaces_org_captcha_settings + +- Operation ID: `replaces_org_captcha_settings` +- Route: `PUT /api/v1/org/captcha` +- Mode: WRITE +- Summary: Replace the org-wide CAPTCHA settings +- Body: JSON request body accepted. + +### delete_org_captcha_settings + +- Operation ID: `delete_org_captcha_settings` +- Route: `DELETE /api/v1/org/captcha` +- Mode: WRITE +- Summary: Delete the org-wide CAPTCHA settings + +### list_org_contact_types + +- Operation ID: `list_org_contact_types` +- Route: `GET /api/v1/org/contacts` +- Mode: READ +- Summary: List all org contact types + +### get_org_contact_user + +- Operation ID: `get_org_contact_user` +- Route: `GET /api/v1/org/contacts/{contactType}` +- Mode: READ +- Summary: Retrieve the contact type user +- Parameters: + - `contactType` in `path` required + +### replace_org_contact_user + +- Operation ID: `replace_org_contact_user` +- Route: `PUT /api/v1/org/contacts/{contactType}` +- Mode: WRITE +- Summary: Replace the contact type user +- Parameters: + - `contactType` in `path` required +- Body: JSON request body accepted. + +### bulk_remove_email_address_bounces + +- Operation ID: `bulk_remove_email_address_bounces` +- Route: `POST /api/v1/org/email/bounces/remove-list` +- Mode: WRITE +- Summary: Remove bounced emails +- Body: JSON request body accepted. + +### list_yubikey_otp_tokens + +- Operation ID: `list_yubikey_otp_tokens` +- Route: `GET /api/v1/org/factors/yubikey_token/tokens` +- Mode: READ +- Summary: List all YubiKey OTP tokens +- Parameters: + - `after` in `query` + - `expand` in `query` + - `filter` in `query` + - `forDownload` in `query` + - `limit` in `query` + - `sortBy` in `query` + - `sortOrder` in `query` + +### upload_yubikey_otp_token_seed + +- Operation ID: `upload_yubikey_otp_token_seed` +- Route: `POST /api/v1/org/factors/yubikey_token/tokens` +- Mode: WRITE +- Summary: Upload a YubiKey OTP seed +- Parameters: + - `after` in `query` + - `expand` in `query` + - `filter` in `query` + - `forDownload` in `query` + - `limit` in `query` + - `sortBy` in `query` + - `sortOrder` in `query` +- Body: JSON request body accepted. + +### get_yubikey_otp_token_by_id + +- Operation ID: `get_yubikey_otp_token_by_id` +- Route: `GET /api/v1/org/factors/yubikey_token/tokens/{tokenId}` +- Mode: READ +- Summary: Retrieve a YubiKey OTP token +- Parameters: + - `tokenId` in `path` required + +### get_third_party_admin_setting + +- Operation ID: `get_third_party_admin_setting` +- Route: `GET /api/v1/org/orgSettings/thirdPartyAdminSetting` +- Mode: READ +- Summary: Retrieve the org third-party admin setting + +### update_third_party_admin_setting + +- Operation ID: `update_third_party_admin_setting` +- Route: `POST /api/v1/org/orgSettings/thirdPartyAdminSetting` +- Mode: WRITE +- Summary: Update the org third-party admin setting +- Body: JSON request body accepted. + +### get_org_preferences + +- Operation ID: `get_org_preferences` +- Route: `GET /api/v1/org/preferences` +- Mode: READ +- Summary: Retrieve the org preferences + +### set_org_hide_okta_ui_footer + +- Operation ID: `set_org_hide_okta_ui_footer` +- Route: `POST /api/v1/org/preferences/hideEndUserFooter` +- Mode: WRITE +- Summary: Set the hide dashboard footer preference + +### set_org_show_okta_ui_footer + +- Operation ID: `set_org_show_okta_ui_footer` +- Route: `POST /api/v1/org/preferences/showEndUserFooter` +- Mode: WRITE +- Summary: Set the show dashboard footer preference + +### get_aerial_consent + +- Operation ID: `get_aerial_consent` +- Route: `GET /api/v1/org/privacy/aerial` +- Mode: READ +- Summary: Retrieve Okta Aerial consent for your org + +### grant_aerial_consent + +- Operation ID: `grant_aerial_consent` +- Route: `POST /api/v1/org/privacy/aerial/grant` +- Mode: WRITE +- Summary: Grant Okta Aerial access to your org +- Body: JSON request body accepted. + +### revoke_aerial_consent + +- Operation ID: `revoke_aerial_consent` +- Route: `POST /api/v1/org/privacy/aerial/revoke` +- Mode: WRITE +- Summary: Revoke Okta Aerial access to your org +- Body: JSON request body accepted. + +### get_okta_communication_settings + +- Operation ID: `get_okta_communication_settings` +- Route: `GET /api/v1/org/privacy/oktaCommunication` +- Mode: READ +- Summary: Retrieve the Okta communication settings + +### opt_in_users_to_okta_communication_emails + +- Operation ID: `opt_in_users_to_okta_communication_emails` +- Route: `POST /api/v1/org/privacy/oktaCommunication/optIn` +- Mode: WRITE +- Summary: Opt in to Okta user communication emails + +### opt_out_users_from_okta_communication_emails + +- Operation ID: `opt_out_users_from_okta_communication_emails` +- Route: `POST /api/v1/org/privacy/oktaCommunication/optOut` +- Mode: WRITE +- Summary: Opt out of Okta user communication emails + +### get_org_okta_support_settings + +- Operation ID: `get_org_okta_support_settings` +- Route: `GET /api/v1/org/privacy/oktaSupport` +- Mode: READ +- Summary: Retrieve the Okta Support settings + +### list_okta_support_cases + +- Operation ID: `list_okta_support_cases` +- Route: `GET /api/v1/org/privacy/oktaSupport/cases` +- Mode: READ +- Summary: List all Okta Support cases + +### update_okta_support_case + +- Operation ID: `update_okta_support_case` +- Route: `PATCH /api/v1/org/privacy/oktaSupport/cases/{caseNumber}` +- Mode: WRITE +- Summary: Update an Okta Support case +- Parameters: + - `caseNumber` in `path` required +- Body: JSON request body accepted. + +### extend_okta_support + +- Operation ID: `extend_okta_support` +- Route: `POST /api/v1/org/privacy/oktaSupport/extend` +- Mode: WRITE +- Summary: Extend Okta Support access + +### grant_okta_support + +- Operation ID: `grant_okta_support` +- Route: `POST /api/v1/org/privacy/oktaSupport/grant` +- Mode: WRITE +- Summary: Grant Okta Support access + +### revoke_okta_support + +- Operation ID: `revoke_okta_support` +- Route: `POST /api/v1/org/privacy/oktaSupport/revoke` +- Mode: WRITE +- Summary: Revoke Okta Support access + +### get_auto_assign_admin_app_setting + +- Operation ID: `get_auto_assign_admin_app_setting` +- Route: `GET /api/v1/org/settings/autoAssignAdminAppSetting` +- Mode: READ +- Summary: Retrieve the Okta Admin Console assignment setting diff --git a/skills/well-known/SKILL.md b/skills/well-known/SKILL.md new file mode 100644 index 0000000..411bce3 --- /dev/null +++ b/skills/well-known/SKILL.md @@ -0,0 +1,58 @@ +--- +name: well-known-routes +description: Handle 6 OpenAPI operation(s) under /.well-known for the well known route group. +--- + +# well known API Routes + +Handle 6 OpenAPI operation(s) under /.well-known for the well known route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### get_well_known_app_authenticator_configuration + +- Operation ID: `get_well_known_app_authenticator_configuration` +- Route: `GET /.well-known/app-authenticator-configuration` +- Mode: READ +- Summary: Retrieve the well-known app authenticator configuration +- Parameters: + - `oauthClientId` in `query` required + +### get_apple_app_site_association_well_known_uri + +- Operation ID: `get_apple_app_site_association_well_known_uri` +- Route: `GET /.well-known/apple-app-site-association` +- Mode: READ +- Summary: Retrieve the customized apple-app-site-association URI content + +### get_asset_links_well_known_uri + +- Operation ID: `get_asset_links_well_known_uri` +- Route: `GET /.well-known/assetlinks.json` +- Mode: READ +- Summary: Retrieve the customized assetlinks.json URI content + +### get_wellknown_org_metadata + +- Operation ID: `get_wellknown_org_metadata` +- Route: `GET /.well-known/okta-organization` +- Mode: READ +- Summary: Retrieve the Org metadata + +### get_wellknown_ssf_metadata + +- Operation ID: `get_wellknown_ssf_metadata` +- Route: `GET /.well-known/ssf-configuration` +- Mode: READ +- Summary: Retrieve the SSF transmitter metadata + +### get_web_authn_well_known_uri + +- Operation ID: `get_web_authn_well_known_uri` +- Route: `GET /.well-known/webauthn` +- Mode: READ +- Summary: Retrieve the customized webauthn URI content